Connectors and Connections > Data Ingestion and Replication connection properties > Microsoft Azure Synapse SQL connection properties
  

Microsoft Azure Synapse SQL connection properties

When you set up a Microsoft Azure Synapse SQL connection, configure the connection properties.
The following table describes the Microsoft Azure Synapse SQL 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
The Microsoft Azure Synapse SQL connection type.
Runtime Environment
The name of the runtime environment where you want to run the tasks.
For application, database, and streaming ingestion and replication tasks, you cannot use the Hosted Agent or serverless runtime environments. For file ingestion and replication tasks, you can use the Hosted Agent but not serverless environments.
Azure DW JDBC URL
The Microsoft Azure Synapse SQL JDBC connection string.
Enter the connection string in the following format for Microsoft SQL Server authentication:
jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>
Enter the connection string in the following 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;
Enter the connection string in the following format for Managed Identity authentication:
jdbc:sqlserver://<Server>.database.windows.net:1433; database=<Database>;Authentication=ActiveDirectoryMsi;
Default is Microsoft SQL Server authentication.
Azure DW JDBC Username
User name to connect to the Microsoft Azure Synapse SQL account. Provide AAD user name for AAD authentication.
Azure DW JDBC Password
Password to connect to the Microsoft Azure Synapse SQL account. For AAD authentication, provide the password of AAD user.
Azure DW Schema Name
Name of the schema in Microsoft Azure Synapse SQL.
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 the managed identity is system-assigned, leave the field empty.
Azure Storage Type
Type of Azure storage to stage the files.
Select one of the following storage types:
  • - Azure Blob. Uses Microsoft Azure Blob Storage to stage the files.
  • - ADLS Gen2. Uses Microsoft Azure Data Lake Storage Gen2 to stage the files.
Default is Azure Blob.
Authentication Type
Authentication type to connect to Azure storage to stage the files.
Select one of the following options:
  • - Shared Key Authentication. Uses the account name and account key to connect to Microsoft Azure Blob Storage or Microsoft Azure Data Lake Storage Gen2.
  • - Service Principal Authentication. Applies to Microsoft Azure Data Lake Storage Gen2. Uses the client ID, client secret, and tenant ID to connect to Microsoft Azure Data Lake Storage Gen2. To use Service Principal authentication, register an application in the Azure Active Directory, generate a client secret, and then assign the Storage Blob Contributor role to the application.
  • - Managed Identity Authentication. Applies to Microsoft Azure Data Lake Storage Gen2. Select to authenticate using identities that are assigned to applications in Azure to access Azure resources in Microsoft Azure Data Lake Storage Gen2.
In a file ingestion and replication task, if you select Microsoft Azure Synapse SQL with Managed Identity authentication type as the target, then you must select Microsoft Azure Data Lake Storage Gen2 as the source.
Azure Blob Account Name
Applies to Shared Key Authentication for Microsoft Azure Blob Storage.
Name of the Microsoft Azure Blob Storage account to stage the files.
Azure Blob Account Key
Applies to Shared Key Authentication for Microsoft Azure Blob Storage.
The Microsoft Azure Blob Storage access key to stage the files.
Container Name
Applies to Microsoft Azure Blob Storage.
The name of the container in the Azure Blob Storage account.
ADLS Gen2 Storage Account Name
Applies to Shared Key Authentication and Service Principal Authentication for Microsoft Azure Data Lake Storage Gen2.
Name of the Microsoft Azure Data Lake Storage Gen2 account to stage the files.
ADLS Gen2 Account Key
Applies to Shared Key Authentication for Microsoft Azure Data Lake Storage Gen2.
The Microsoft Azure Data Lake Storage Gen2 access key to stage the files.
Client ID
Applies to Service Principal Authentication and Managed Identity Authentication for Microsoft Azure Data Lake Storage Gen2.
The client ID of your application.
To use service principal authentication, enter the application ID or client ID for your application registered in the Azure Active Directory.
To use managed identity authentication, enter the client ID for the user-assigned managed identity. If the managed identity is system-assigned, leave the field empty.
Client Secret
Applies to Service Principal Authentication for Microsoft Azure Data Lake Storage Gen2.
The client secret for your application.
Tenant ID
Applies to Service Principal Authentication for Microsoft Azure Data Lake Storage Gen2.
The directory ID or tenant ID for your application.
File System Name
Applies to Microsoft Azure Data Lake Storage Gen2.
The name of the file system in the Microsoft Azure Data Lake Storage Gen2 account.
Blob End-point
Type of Microsoft Azure endpoints.
Select one of the following endpoints:
  • - core.windows.net. Connects to Azure endpoints.
  • - 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).
When you use a serverless runtime environment, you cannot connect to a Microsoft Azure Synapse SQL endpoint residing in a virtual network.