Azure Synapse Analytics Connection
This article describes how to connect to Azure Synapse Analytics.
Prerequisites
-
Review how sources and connections work.
-
Create a source to add this connection to.
Add a connection
-
Go to [your source] > Connections and select Add Connection.
-
In Connection type, select Azure Synapse Analytics.
-
Fill in the following:
-
Name: A meaningful name for your connection. Used to indicate the location of catalog items.
-
Description (Optional): A short description of the connection.
-
JDBC: A JDBC connection string pointing to the IP address or the URL where your data source can be reached. See JDBC connection string format.
-
JDBC connection string format
Depending on the authentication you’re using, the JDBC string has one of the following formats:
jdbc:sqlserver://workspace_name-ondemand.sql.azuresynapse.net:1433;database=database_name;encrypt=true;trustServerCertificate=false
jdbc:sqlserver://workspace_name-ondemand.sql.azuresynapse.net:1433;database=database_name;authentication=ActiveDirectoryServicePrincipal;encrypt=true;trustServerCertificate=false
The URL format depends on your SQL pool type:
-
Dedicated SQL pools:
workspace_name.sql.azuresynapse.net. -
Serverless SQL:
workspace_name-ondemand.sql.azuresynapse.net.
Add credentials
-
Select Add Credentials.
-
Choose an authentication method and continue with the corresponding step:
-
Username and password: Basic authentication using your username and password.
-
Entra ID: Authentication using Microsoft Entra ID (formerly Azure Active Directory).
-
| One set of credentials must be defined as default for each connection. Otherwise, DQ evaluation fails and previewing data in the catalog is not possible. |
Username and password
To authenticate using a username and password:
-
Fill in the following:
-
Name: Provide a clear name for this set of credentials.
-
Description (Optional): Explain what the credentials are used for or provide other useful information.
-
Username: The username for the data source.
-
Password: The password for the data source.
-
-
To use this set of credentials by default when connecting to the data source, select Set as default.
Entra ID
To authenticate using Entra ID:
-
Fill in the following:
-
Name: Provide a clear name for this set of credentials.
-
Description (Optional): Explain what the credentials are used for or provide other useful information.
-
Client ID: The application (client) ID registered in the Microsoft Entra portal.
This appears as a GUID (for example,
4701c7e7-1178-4006-a1fc-b4c3ee5cfef7) and is found in the Entra ID portal in App registrations > [app name] > Overview. -
Client Secret: The secret value generated for the application in the Microsoft Entra portal (App registrations > [app name] > Certificates & secrets).
-
Tenant ID: The directory (tenant) ID of your Microsoft Entra instance.
This appears as a GUID (for example,
12345678-1234-1234-1234-123456789012) and is found in the Entra ID portal in App registrations > [app name] > Overview, or in Azure Active Directory > Overview.For details about registering an application and generating credentials, see Register an application with Microsoft Entra ID.
-
-
To use this set of credentials by default when connecting to the data source, select Set as default.
Add write credentials
If you want to export data to this source, add write credentials. Select Add Credentials and follow the instructions in Add credentials.
Was this page useful?