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

# Azure Synapse

export const title_2 = "Azure Synapse";

export const title_1 = "Azure Synapse";

export const title_0 = "Azure Synapse";

## Setup Guide

Follow these steps to connect Azure Synapse to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *Azure Synapse* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="Password">
    <Steps>
      <Step>
        Enter the following information:

        * The **User** and **Password** for Azure Synapse.
        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_0} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the following information:

        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_1} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the following information:

        * **Azure Tenant**—the Microsoft Online tenant that you use to access data.
        * **OAuth Client Id**—the Id assigned when you registered your Azure Synapse account for OAuth.
        * Either the **OAuth Client Secret** for your Azure Synapse account for OAuth OR the **OAuth JWT Cert** multi-line key in PEM format. Follow the format shown.
        * **Port**—the port for connecting to the Azure Synapse server.
        * **Server**—the host name or IP address of the Azure Synapse server.
        * **Database**—(optional) the name of the Azure Synapse database.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_2} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## More Information

For more information about interactions between Connect AI and Azure Synapse, see [this information page](https://cdn.cdata.com/help/HEM/cloud/default.htm#default).
