Azure Synapse

Version 24.1.8910


Azure Synapse


You can use the Azure Synapse connector from the CData Sync application to capture data from Azure Synapse and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Azure Synapse Connector

To enable Sync to use data from Azure Synapse, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Sources tab and locate the Azure Synapse row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Azure Synapse connector. For more information about installing new connectors, see Connections.

Authenticate to Azure Synapse

After you add the connector, you need to set the required properties.

  • Connection Name - Enter a name of your choice for the connection.

  • 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

To connect with your user credentials, set the following properties:

  • Auth Scheme: Select Password.

  • User: Enter the username that you use to authenticate to your Azure Synapse account.

  • Password: Enter the password that you use to authenticate to your Azure Synapse account.

Azure Active Directory

To connect with an Azure Active Directory user account, select AzureAD for Auth Scheme. CData Sync provides an embedded OAuth application with which to connect so no additional properties are required.

Azure Managed Service Identity

To leverage Managed Service Identity (MSI) when CData Sync is running on an Azure virtual machine, select AzureMSI for Auth Scheme. No additional properties are required.

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. Set the redirect URI to the value that is specified for CallbackURL.

  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.

  • OAuth JWT Cert Password (optional) – Enter the password for your OAuth JWT certificate.

  • OAuth JWT Cert Subject (optional) – 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. Set the redirect URI to the value that is specified for CallbackURL.

  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

To connect with an Azure password, specify these settings:

  • Auth Scheme - Select AzurePassword.

  • User - Enter the username that you use to authenticate to Azure.

  • Password - Enter the password that you use to authenticate to Azure.

  • Azure Tenant - Enter the Id of the Azure Tenant under which your OAuth and client applications were created. This Id is available under Directory (tenant) ID on the Overview page of one of the applications.

Complete Your Connection

To complete your connection:

  1. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

  2. If you authenticate with AzureAD, AzureMSI, AzureServicePrincipal, AzureServicePrincipalCert, or AzurePassword, click Connect to Azure Synapse to connect to your Azure Synapse account.

  3. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Azure Synapse, see Azure Synapse Connector for CData Sync.