Accessing Azure Synapse

This guide covers the basic items required to log into the Supermetrics Azure Synapse data source.


Before You Begin

The Azure Synapse data source currently only supports oAuth logins. So the user must have a Microsoft user or business account that has access to an Azure Synapse database/data warehouse. 


That account should have at least SELECT permissions to the database/data warehouse they wish to pull data from. You may need to work with your Azure administrator to ensure the permissions are set up correctly. For more information about SQL permissions, see this guide.


The database that will be used will need to have some IPs whitelisted in order to allow Supermetrics to connect. Please have your Azure administrator reference the following article for what IPs need to be unblocked: IP Whitelist List for Database Connections


Gathering Login Details

Users will need to gather the following pieces of data:

  • Tenant ID
  • Workspace name
  • Database name


Obtaining the Tenant ID

The Tenant ID can be gotten either by checking with your Azure administrator or by looking up the "Tenant properties" in the Microsoft Azure portal.

Shows user searching for "Tenant properties" in the search bar of Microsoft Azure website, with the results showing a gear icon with the title Tenant properties next to it highlighted


Find and copy the Tenant ID value from the list of properties:

Orange arrow points to the text box for the "Tenant ID" in the properties section. This can be copied to use during login


Obtaining the Workspace Name

The workspace name (also called the server name) can be gotten either by checking with your Azure administrator or by looking up the SQL server list in the Microsoft Azure portal.

User is searching "sql server" in the Microsoft Azure search bar, with "SQL servers" option highlighted


Here should be the list of server names, you will want to select the one the database you want to query is in:

Orange arrow points to the server name in the "Name" column. This needs to be copied for the login


Obtaining the Database Name

The database name can be gotten either by checking with your Azure administrator or by looking up the SQL database list in the Microsoft Azure portal. The name column should have both the database name and the workspace/server name. You just need the database name.

Orange arrow points to the database name "smdemo" which will be used for login


Logging in to Supermetrics Azure Synapse Data Source

With the above three items, along with having a valid Microsoft account, you should have everything you need to connect with the Azure Synapse database/data warehouse.


We recommend that the first login be performed by an administrator account, as step 5 below requires app permissions to be accepted for the organization, and only administrators will be shown this option. Failure to accept the app permissions for the organization means that simple users will not be allowed to log in.


  1. Select the Azure Synapse data source in the Supermetrics product of your choice.
  2. A new window will open with the following fields to fill in, which will match what was gathered earlier: Tenant/AD ID, Workspace, and Database name
  3. Example login screen with Tenant ID, Workspace, and Database name fields filled inClick START to continue.
  4. You will now be prompted to log into the Microsoft user account attached to the database. Following the dialogs to complete the login process with Microsoft.
  5. If you are an administrator account, you should be given the option to accept the app permissions. These are required for Supermetrics to access the database.
    • Note that the option to "Consent on behalf of your organisation" is optional. However, if you have any simple users (non-admin), they will not be permitted to use Supermetrics if you do not check this!

      App permissions consent for Supermetrics. The option to "Consent on behalf of your organization" is highlighted as it is important for simple users to have this granted by an admin

  6. Once the login succeeds, you will either be redirected back into the product or you may get a message it is safe to close the window and go back to the product.
  7. You are now ready to set up your first query to your Azure Synapse database/data warehouse!


Troubleshooting

Simple user accounts will see this message if an admin account did not consent to the app permissions for the whole organization.

To address this, please have an administrator account log in following the instructions above for Logging in to Supermetrics Azure Synapse Data Source, making sure to check the box for "Consent on behalf of your organisation" in step 5.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.