Obtaining connection values for Microsoft Azure Cosmos DB

About this task

This topic provides instructions for obtaining the connection values for the Microsoft Azure Cosmos DB connector.

Tip: For detailed information about obtaining the connection values, see Get Azure Cosmos DB credentials on the Microsoft Azure Cosmos DB documentation page.

Procedure

  1. Log in to the Microsoft Azure portal.
  2. To obtain the client ID and client secret values (BASIC), complete the following steps:
    1. Click App registrations.
    2. In the App registrations page, click New registration.
    3. In the Register an application page, specify a unique name for your app.
    4. Select an option in the Supported account types section according to your requirements.
    5. Click Register.

      The Overview page for the application is displayed.

      Overview page for the registered application
    6. Make a note of the Application (client) ID value because you need to specify it as a connection value when creating the account in App Connect.
    7. For the Client credentials field on the Overview page, click Add a certificate or secret. This action opens the Certificates & secrets page.
      Certificates & secrets page for the registered application
    8. Click + New client secret.
    9. In the Add a client secret panel, specify a description for the secret (for example, App Connect secret) and then select an expiry period.
    10. Click Add.

      The generated client secret is displayed on the Certificates & secrets page.

      Generated client secret for the registered app
    11. Copy and store the client secret value. You need to specify this value as a connection value when you create the account in App Connect.
      Note: The client secret value is not shown again in full after you leave this page.
  3. To find the tenant ID value (BASIC), complete the following steps:
    1. Go to the Microsoft Azure portal login page, and then go to Microsoft Entra ID > Properties.
    2. Copy the Tenant ID value and save it somewhere safe.
      Locating the Tenant ID in Microsoft Entra ID

      For more information about obtaining the Tenant ID, see How to find your Microsoft Entra tenant ID in the Microsoft Entra documentation.

  4. To create a new account (BASIC) in Microsoft Azure Cosmos DB, complete the following steps:
    1. Click Azure Cosmos DB from the list of Azure Services.
    2. Click + Create to create a new Azure Cosmos DB account.

      The Create an Azure Cosmos DB account page is displayed.

    3. Click the Create button from the Azure Cosmos DB for NoSQL tile.
    4. For the Workload Type field, select the required workload type.
    5. Select a resource group from the menu, or click Create new to create a new resource group.
    6. Enter the name for your namespace in the Account name field.
    7. For the Location field, choose the region to host your account.
    8. Click Review + create.
    9. Review your settings, and then click Create.
      Tip: For detailed information about creating an account, see Create an account in the Azure Cosmos DB documentation.
  5. To create a new container (BASIC) in your Microsoft Azure Cosmos DB account, complete the following steps:
    1. Click Azure Cosmos DB from the list of Azure Services.
    2. Select the account that you created in step 4.
    3. Click Data Explorer on the sidebar.
    4. Click + New Container.

      The New Container dialog is displayed.

    5. Enter the Database id, Container id, and Partition key as required.
    6. Click OK.
    7. Tip: For detailed information about creating a container, see Create a database and container in the Azure Cosmos DB documentation.
  6. To grant your application access to your Microsoft Azure Cosmos DB account using Azure role-based access control (RBAC), assign the owner or contributor role to the application (BASIC).
    1. Click Azure Cosmos DB from the list of Azure Services.
    2. Select the account that you created in step 4.
    3. Click Access control (IAM) on the sidebar.
    4. Click + Add > Add role assignment.

      The Add role assignment page is displayed.

    5. In the Role tab, click Privileged administrator roles and select owner or contributor.
    6. In the Members tab, click + Select members.
    7. Select the application that you created in step 2 and click Select.
    8. Review your settings, and click the Review + assign button.
  7. To obtain the server URL (API KEY and BASIC), complete the following steps:
    1. Click Azure Cosmos DB from the list of Azure services to log in to your Microsoft Azure Cosmos DB account.
    2. Under the Security + networking section of your Microsoft Azure Cosmos DB account, click Keys.
    3. Copy the value from the URI field (the URI value is your App Connect Server URL).
  8. To obtain the key value (API KEY), complete the following steps:
    1. Click Azure Cosmos DB from the list of Azure services to log in to your Microsoft Azure Cosmos DB account.
    2. Under the Security + networking section of your Microsoft Azure Cosmos DB account, click Keys.
    3. Copy the value of the PRIMARY KEY or SECONDARY KEY (either Read-write or Read-only based on your requirement) and save it somewhere safe.
      Note: You can provide the value of either the PRIMARY KEY or SECONDARY KEY in App Connect.