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

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroDestination = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to move data
      from any supported source to the {datasource} destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

<CommonDatasourceIntroDestination datasource="Azure SQL Database" siteName={siteName} />

## Add the Azure SQL Database Connector

<CommonDatasourceAddConnector datasource="Azure SQL Database" title="Azure SQL Database" destination={true} siteNameShort={siteNameShort} />

## Authenticate to Azure SQL Database

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

* **Server:** Enter the name of the data source to which you want to connect.
* **Port:** Enter the port number for the Azure SQL Database. The default port value is **1433**.
* **Database:** Enter the name of the intial catalog or database in your data source.

{siteName} supports authenticating to Azure SQL Database in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

* [**SQL Password**](#sql-password) (default)
* [**Active Directory Service Principal**](#active-directory-service-principal)
* [**Active Directory Password**](#active-directory-password)
* [**Active Directory Managed Service Identity**](#active-directory-managed-service-identity)

### SQL Password

To connect with your SQL password, specify the following properties:

* **Auth Scheme:** Select **SqlPassword**.
* **User:** Enter the username that you use to authenticate to Azure SQL Database.
* **Password:** Enter the password that you use to authenticate to Azure SQL Database.

### Active Directory Service Principal

To connect with an Active Directory service principal, set the following properties:

* **Auth Scheme:** Select **ActiveDirectoryServicePrincipal**.
* **Principal Id:** Enter your principal identifier (Id).
* **Principal Secret:** Enter your principal secret.

### Active Directory Password

To connect with an Active Directory password, set the following properties:

* **Auth Scheme:** Select **ActiveDirectoryPassword**.
* **User:** Enter the username that you use to authenticate to Azure SQL Database.
* **Password:** Enter the password that you use to authenticate to Azure SQL Database.

### Active Directory Managed Service Identity

To leverage the Active Directory Managed Service Identity (MSI) when {siteName} is running on an Azure virtual machine, select **ActiveDirectoryMSI** for **Auth Scheme**. No additional properties are required.

## Complete Your Connection

To complete your connection:

1. Specify the following properties:
   * **Trust Server Certificate:** Select whether you want to trust the server certificate. By default, the **Enable** checkbox is already selected.
   * **Encrypt:** Select whether you want to encrypt the database. By default, the **Enable** checkbox is not selected.
2. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
3. Click **Create & Test** to create your connection.

**Note:** The Java version requires the Microsoft SQL Server JDBC driver. You can download the driver from the <a href="https://docs.microsoft.com/en-us/sql/connect/jdbc/download-microsoft-jdbc-driver-for-sql-server" target="_blank" rel="noopener noreferrer">Microsoft Download Center</a>.

Copy the JDBC driver into the `libs` directory and restart the server.

* **Microsoft Windows:** `C:\ProgramData\CData\sync\libs`
* **UNIX or Mac OS X:** `~/cdata/sync/libs`
