Connections > Microsoft Azure Cosmos DB SQL API connection properties > Connect to Microsoft Azure Cosmos DB SQL API
  

Connect to Microsoft Azure Cosmos DB SQL API

Let's configure the Microsoft Azure Cosmos DB SQL API connection properties to connect to Microsoft Azure Cosmos DB SQL API.

Before you begin

Before you configure the connection properties, you'll need to get the Cosmos DB URI, database name, and key values from your Microsoft Azure Cosmos DB SQL API account. You can find the key details on the Keys tab of your Microsoft Azure Cosmos DB SQL API settings.

Connection details

The following table describes the basic connection properties:
Property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Type
Microsoft Azure Cosmos DB SQL API
Use Secret Vault
Stores sensitive credentials for this connection in the secrets manager that is configured for your organization.
This property appears only if secrets manager is set up for your organization.
This property is not supported by Mass Ingestion.
When you enable the secret vault in the connection, you can select which credentials that the Secure Agent retrieves from the secrets manager. If you don't enable this option, the credentials are stored in the repository or on a local Secure Agent, depending on how your organization is configured.
For information about how to configure and use a secrets manager, see Secrets manager configuration.
Runtime Environment
The name of the runtime environment where you want to run tasks.
Select a Secure Agent, Hosted Agent, or serverless runtime environment.
Do not use a Hosted Agent if you use the connection in mappings in advanced mode.
Cosmos DB URI
The URI to access the Microsoft Azure Cosmos DB account.
Key
The primary or secondary key that grants you complete administrative access to the resources in the Microsoft Azure Cosmos DB account.
Database
Name of the database that contains the container from which you want to read or write JSON documents.