Search

Cosmos DB

Cosmos DB

Setup Guide

Follow these steps to connect Cosmos DB to your CData Connect Cloud account:

  1. Open the Connections page of the CData Connect Cloud dashboard.

  2. Click + Add Connection in the upper-right corner.

  3. Type Cosmos DB into the search field, then click the data source name.

  4. On the Basic Settings tab of the new connection, enter a connection name or keep the default name.

  5. Enter your Cosmos DB account URL Account Endpoint. You can find this URL under the Keys blade of the Cosmos DB account.

  6. Select the Authentication method, then proceed to the relevant section and follow those instructions.

Authentication Methods

AccountKey

  1. Enter the master key token or resource token for connecting to the Cosmos DB REST API in the Account Key field.

  2. Use the Token Type field to specify whether the token you entered in the Account Key field is a master or resource token.

  3. In Cosmos DB, add the CData Connect Cloud static IP addresses to your connection whitelist.

  4. At the top of the CData Connect Cloud Add Cosmos DB Connection page, click Save & Test.

    • If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud 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.

AzureAD

  1. Enter the OAuth Client Id assigned when you registered your Cosmos DB account for OAuth.

  2. Enter the OAuth Client Secret for your Cosmos DB account for OAuth.

  3. In Cosmos DB, add the CData Connect Cloud static IP addresses to your connection whitelist.

  4. At the top of the CData Connect Cloud Add Cosmos DB Connection page, click Save & Test.

    • If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud 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.

AzureServicePrincipal

  1. Enter the Azure Tenant Id to connect to.

  2. Enter the OAuth Client Id found in your application settings.

  3. Enter your OAuth Client Secret.

  4. In Cosmos DB, add the CData Connect Cloud static IP addresses to your connection whitelist.

  5. At the top of the CData Connect Cloud Add Cosmos DB Connection page, click Save & Test.

    • If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud 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.

More Information

For more information about interactions between CData Connect Cloud and Cosmos DB, see this information page.