Microsoft Azure Synapse SQL Connector > Connections for Microsoft Azure Synapse SQL > Connect to Microsoft Azure Synapse SQL
  

Connect to Microsoft Azure Synapse SQL

Let's configure the Microsoft Azure Synapse SQL connection properties to connect to Microsoft Azure Synapse SQL.

Before you begin

Before you get started, you'll need to get information from your Microsoft Azure Synapse SQL account based on the authentication type that you want to configure.
Check out Azure Active Directory authentication, Managed Identity authentication, and Service Principal authentication for the information you need from Microsoft Azure Synapse SQL.
To get the JDBC URL from your Azure account, see Obtaining the JDBC URL How-To Library article.
Check out Serverless SQL pool for the information you need to connect to a serverless SQL pool.

Connection details

The following table describes the basic connection properties:
Property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Type
Microsoft Azure Synapse SQL
Runtime Environment
The name of the runtime environment where you want to run tasks.
Select a Secure Agent, Hosted Agent, or serverless runtime environment.
Hosted Agent doesn't apply to mappings in advanced mode.
Azure DW JDBC URL
The Microsoft Azure Synapse SQL JDBC connection string.
Use the following string to connect to Microsoft Azure Synapse SQL:
jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>
You can include an authentication parameter in the connection string to specify the authentication type. You can configure the following authentication types to connect to Microsoft Azure Synapse SQL:
  • - Microsoft SQL Server
  • - Azure Active Directory
  • - Managed Identity
  • - Service Principal
If you don't include an authentication parameter in the connection string, the Secure Agent uses Microsoft SQL Server authentication as the authentication type.
Use the following string to connect to a serverless SQL pool in Microsoft Azure Synapse SQL:
jdbc:sqlserver://<Serverless SQL endpoint>:1433; database=<Database>;Authentication=ActiveDirectoryMsi;
Connection string format for Microsoft SQL Server authentication
jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>
Connection string format for Azure Active Directory (AAD) authentication
jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>;encrypt=true;trustServerCertificate=false; hostNameInCertificate=*.database.windows.net;loginTimeout=30; Authentication=ActiveDirectoryPassword;
Connection string format for Service Principal authentication
jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>;encrypt=true;trustServerCertificate=false; hostNameInCertificate=*.database.windows.net;loginTimeout=30; Authentication= ActiveDirectoryServicePrincipal;
Connection string format for Managed Identity authentication
jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>;Authentication=ActiveDirectoryMsi;
Azure DW JDBC Username
User name to connect to the Microsoft Azure Synapse SQL account.
  • - For AAD authentication, provide your AAD user name.
  • - For Microsoft SQL server authentication, provide your SQL auth user name.
  • - For service principal authentication, provide the application ID or client ID for your application registered in Azure Active Directory.
This property doesn't apply to Managed Identity authentication.
Azure DW JDBC Password
Password to connect to the Microsoft Azure Synapse SQL account.
  • - For AAD authentication, provide the password of the AAD user.
  • - For Microsoft SQL server authentication, provide the password of SQL auth user.
  • - For service principal authentication, provide the client secret for your application registered in the Azure Active Directory.
This property doesn't apply to Managed Identity authentication.
Azure DW Client ID
Required if you want to use the user-assigned managed identity for Managed Identity Authentication to connect to Microsoft Azure Synapse SQL.
The client ID of the user-assigned managed identity.
If you use system-assigned managed identity, leave the field empty.
Azure DW Schema Name
Name of the schema in Microsoft Azure Synapse SQL.

Azure storage types

You can select Microsoft Azure Blob Storage or Microsoft Azure Data Lake Storage Gen2 as the Azure storage type to stage the data files. Default is Azure Blob.
Select your preferred storage type and then configure the storage-specific parameters.
To get credentials for shared key authentication when you connect to Microsoft Azure Blob Storage or Microsoft Azure Data Lake Storage Gen2 to stage files, see Get credentials for shared key authentication How-To Library article.
To get credentials for service principal authentication when you connect to Microsoft Azure Data Lake Storage Gen2 to stage files, see Get credentials for service principal authentication How-To Library article.

Advanced settings

The following table describes the advanced connection properties:
Property
Description
External Data Source
The data source to create the external table.
Ensure that the external data source exists in Microsoft Azure Synapse SQL and you have the permission to access the external data source.
When you use the copy command method to load data from the staging location to Microsoft Azure Synapse SQL, you don't need to specify an external data source.
Staging Schema Name
The name of the schema that the Secure Agent uses to create external tables for staging data files.
If you do not specify the staging schema name, the Secure Agent considers the configured Azure DW Schema Name.
Blob End-point
Type of Microsoft Azure endpoint.
Select one of the following endpoints:
  • - core.windows.net. Connects to Azure endpoints. Use this endpoint when you connect to a serverless SQL pool.
  • - core.usgovcloudapi.net. Connects to US Government Microsoft Azure Synapse SQL endpoints.
  • - core.chinacloudapi.cn. Connects to Microsoft Azure Synapse SQL endpoints in the China region.
Default is core.windows.net.
VNet Rule
Enable to connect to a Microsoft Azure Synapse SQL endpoint residing in a virtual network (VNet).
This property doesn't apply to a serverless runtime environment.

Related links