Skip to main content

​
Add the Azure Synapse Connector

​
Authenticate to Azure Synapse

After you add the connector, you need to set the required properties.
  • Server: Enter the name of the server that runs Azure Synapse.
  • Port: Enter the port number for Azure Synapse. The default port value is 1433.
  • Database: Enter the name of the Azure Synapse database.
CData Sync supports authenticating to Azure Synapse in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

​
Password

​
Azure Active Directory

​
Azure Managed Service Identity

​
Azure Service Principal

To connect with an Azure service principal and client secret, set the following properties:

  • Auth Scheme: Select AzureServicePrincipal.
  • Azure Tenant: Enter the Microsoft Online tenant to which you want to connect.
  • OAuth Client Id: Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
  • OAuth Client Secret: Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

To obtain the OAuth client Id and client secret for your application:

  1. Log in to the Azure portal.
  2. In the left navigation pane, select All services. Then, search for and select App registrations.
  3. Click New registrations.
  4. Enter an application name and select Any Azure AD Directory - Multi Tenant.
  5. After you create the application, copy the application (client) Id value that is displayed in the Overview section. Use this value as the OAuth client Id.
  6. Navigate to the Certificates & Secrets section and select New Client Secret for the application.
  7. Specify the duration and save the client secret. After you save it, the key value is displayed.
  8. Copy this value because it is displayed only once. You will use this value as the OAuth client secret.
  9. On the Authentication tab, make sure to select Access tokens (used for implicit flows).

​
Azure Service Principal Certificate

To connect with an Azure service principal and client certificate, set the following properties:

  • Auth Scheme: Select AzureServicePrincipalCert.
  • Azure Tenant: Enter the Microsoft Online tenant to which you want to connect.
  • OAuth Client Id: Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
  • OAuth JWT Cert: Enter your Java web tokens (JWT) certificate store.
  • OAuth JWT Cert Type: Enter the type of key store that contains your JWT Certificate. The default type is PEMKEY_BLOB.
  • (Optional) OAuth JWT Cert Password: Enter the password for your OAuth JWT certificate.
  • (Optional) OAuth JWT Cert Subject: Enter the subject of your OAuth JWT certificate.

To obtain the OAuth certificate for your application:

  1. Log in to the Azure portal.
  2. In the left navigation pane, select All services. Then, search for and select App registrations.
  3. Click New registrations.
  4. Enter an application name and select Any Azure AD Directory - Multi Tenant.
  5. After you create the application, copy the application (client) Id value that is displayed in the Overview section. Use this value as the OAuth client Id.
  6. Navigate to the Certificates & Secrets section and select Upload certificate. Then, select the certificate to upload from your local machine.
  7. Specify the duration and save the client secret. After you save it, the key value is displayed.
  8. Copy this value because it is displayed only once. You will use this value as the OAuth client secret.
  9. On the Authentication tab, make sure to select Access tokens (used for implicit flows).

​
AzurePassword

​
Complete Your Connection

To complete your connection:
  1. For Batch Mode, select the mode that you want to use for inserting bulk data.
    • BCP
    • COPY: Specify the following settings:
      • Azure SAS Token: Enter the string value of your Azure Blob shared access signature (SAS). To obtain this value:
        1. In the Azure portal, select Settings > Shared access signature for your Azure Blob container.
        2. Click Generate SAS token and URL and copy the value that is generated in the Blob SAS token text box. Note: Make sure that you select the proper permission (Create, Write, Delete) from the Permissions list and verify the validity of the Start and Expiry times before you generate the SAS token.
      • Storage Acount Location: Enter the storage-account location where you want to stage your data.
    • STANDARD
  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)
  3. If you authenticate with AzureAD, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert, or AzurePassword, click Connect to Azure Synapse to connect to your Azure Synapse account.
  4. Click Create & Test to create your connection.

​
More Information