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

export const title_2 = "Azure Data Catalog";

export const title_1 = "Azure Data Catalog";

export const title_0 = "Azure Data Catalog";

## Prerequisites

The **AzureServicePrincipal** and **AzureServicePrincipalCert** authentication methods require a custom OAuth application registered in Microsoft Entra ID (formerly Azure AD). If you are connecting with the **AzureAD** method, you can skip this section.

To create and register a custom OAuth application in Entra ID, follow these steps:

<Steps>
  <Step>
    Sign in to the Azure portal and navigate to **Microsoft Entra ID > App registrations**, then click **New registration**.
  </Step>

  <Step>
    Enter a **Name** for the application.
  </Step>

  <Step>
    Under supported account types, select **Any Microsoft Entra ID tenant - Multitenant**, then click **Register**.
  </Step>

  <Step>
    On the application's overview page, record the **Application (client) ID** and the **Directory (tenant) ID**. You enter these values as the **OAuth Client Id** and the **Azure Tenant** in the setup steps below.
  </Step>

  <Step>
    Open **Certificates & Secrets** and add the credential for your chosen method:

    * For the **AzureServicePrincipal** method, select **New client secret**, specify a duration, and click **Add**. Record the secret value (shown only once); you enter it as the **OAuth Client Secret**.
    * For the **AzureServicePrincipalCert** method, select **Upload certificate** and upload your client certificate.
  </Step>

  <Step>
    Open the **Authentication** tab and enable the **Access tokens** option.
  </Step>

  <Step>
    Open **API permissions** and add **Azure Data Catalog > Delegated permissions > user\_impersonation**. Save your changes, then grant admin consent if your organization requires it.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect Azure Data Catalog 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 Data Catalog* 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>

  <Step>
    (Optional) Enter the **Catalog Name** of the catalog to connect to. The default is *defaultcatalog*.
  </Step>

  <Step>
    Select an **Auth Scheme** and follow the relevant instructions below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which is the Azure Data Catalog tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the Azure Data Catalog sign-in page in a new tab.
      </Step>

      <Step>
        Sign in to your Azure Data Catalog account and provide the requested permissions (if applicable).
      </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="AzureServicePrincipal">
    <Steps>
      <Step>
        Enter the **Azure Tenant**, which is the Azure Data Catalog tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID.
      </Step>

      <Step>
        The **Callback URL**, or Redirect URL, is the URL you need (`https://oauth.cdata.com/oauth/`) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.
      </Step>

      <Step>
        Enter your **OAuth Client Id** (also known as the consumer key) assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        Enter your **OAuth Client Secret** assigned when you registered your custom OAuth application.
      </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="AzureServicePrincipalCert">
    <Steps>
      <Step>
        Enter the **OAuth JWT Cert**, the name of the client certificate's JWT Certificate store. This is a multi-line key with the format shown.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, the type of key store that contains the JWT Certificate. The default is *PEMKEY\_BLOB*.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Password** if the certificate store requires it.
      </Step>

      <Step>
        (Optional) Enter the **OAuth JWT Cert Subject**. This is the subject of the OAuth JWT certificate. Supports partial matches and the wildcard '\*' to select the first certificate. If omitted, the first certificate in the certificate store is used.
      </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 Data Catalog, see [this information page](https://cdn.cdata.com/help/GNM/cloud/default.htm#default).