> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Azure Synapse

You can use the Azure Synapse connector from the CData Sync application to move data
from any supported source to the Azure Synapse 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:

<ol>
  <li>Open the **Connections** page of the Sync dashboard.</li>
  <li>Click **Add Connection** to open the **Select Connectors** page.</li>
  <li>Click the **Destinations** tab and locate
  the **Azure Synapse** row.</li>

  <li>
    Click the **Configure Connection** icon at the end of that row to open
    the **New Connection** page. This action opens the
    **Add Connection** dialog.

    **Note:** If the **Configure Connection** icon is not
    available, click the **Download Connector** icon to install
    the Azure Synapse connector.
  </li>

  <li>Enter a name for your connection in the **Add Connection** dialog.</li>
  <li>Click **Add** to open the **Settings** tab for your connector.</li>
</ol>

For more information about installing new connectors, see
[Connections](https://docs.sync.cdata.com/26.4/en/connections/connections.md).

## 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.

* [**AzureAD**](#azure-active-directory)
* [**Azure MSI**](#azure-managed-service-identity)
* [**AzureServicePrincipal**](#azure-service-principal)
* [**AzureServicePrincipalCert**](#azure-service-principal-certificate)
* [**Password**](#password) (default)
* [**Azure Password**](#azurepassword)

### Password

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

<ul><li>**Auth Scheme:** Select **Password**.</li>
<li>**User:** Enter the username that you use to authenticate to your Azure Synapse account.</li>
<li>**Password:** Enter the password that you use to authenticate to your Azure Synapse account.</li></ul>

### Azure Active Directory

To connect with an Azure Active Directory (AD) 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 Azure Managed Service Identity (MSI) when CData Sync is running on an Azure
virtual machine, select **Azure MSI** 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:

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

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

<ol><li>Log in to the [Azure portal](https://portal.azure.com).</li>
<li>In the left navigation pane, select **All services**. Then, search for and select **App registrations**.</li>
<li>Click **New registrations**.</li>
<li>Enter an application name and select **Any Azure AD Directory - Multi Tenant**.</li>
<li>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.</li>
<li>Navigate to the **Certificates & Secrets** section and select **New Client Secret** for the application.</li>
<li>Specify the duration and save the client secret. After you save it, the key value is displayed.</li>
<li>Copy this value because it is displayed only once. You will use this value as the OAuth client secret.</li>
<li>On the **Authentication** tab, make sure to select **Access tokens (used for implicit flows)**.</li></ol>

### Azure Service Principal Certificate

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

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

To obtain the OAuth certificate for your application:

<ol><li>Log in to the [Azure portal](https://portal.azure.com).</li>
<li>In the left navigation pane, select **All services**. Then, search for and select **App registrations**.</li>
<li>Click **New registrations**.</li>
<li>Enter an application name and select **Any Azure AD Directory - Multi Tenant**.</li>
<li>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.</li>
<li>Navigate to the **Certificates & Secrets** section and select **Upload certificate**. Then, select the certificate to upload from your local machine.</li>
<li>Specify the duration and save the client secret. After you save it, the key value is displayed.</li>
<li>Copy this value because it is displayed only once. You will use this value as the OAuth client secret.</li>
<li>On the **Authentication** tab, make sure to select **Access tokens (used for implicit flows)**.</li></ol>

### AzurePassword

To connect with an Azure password, specify these settings:

<ul><li>**Auth Scheme:** Select **AzurePassword**.</li>
<li>**User:** Enter the username that you use to authenticate to Azure.</li>
<li>**Password:** Enter the password that you use to authenticate to Azure.</li>
<li>**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.</li></ul>

## 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

For more information about interactions between CData Sync and Azure Synapse, see
[Azure Synapse Connector for CData Sync](https://cdn.cdata.com/help/HEN/synch/default.htm).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.