Table of Contents

Search

  1. Preface
  2. Introduction to Microsoft Azure Synapse SQL Connector
  3. Connections for Microsoft Azure Synapse SQL
  4. Mappings for Microsoft Azure Synapse SQL
  5. Upgrading to Microsoft Azure Synapse SQL Connector
  6. Migrating a mapping
  7. SQL ELT optimization
  8. Data type reference
  9. Troubleshooting

Microsoft Azure Synapse SQL Connector

Microsoft Azure Synapse SQL Connector

Connection details

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.

0 COMMENTS

We’d like to hear from you!