AzureCosmosDBClientService

Description:

Provides a controller service that configures a connection to Cosmos DB (Core SQL API) and provides access to that connection to other Cosmos DB-related components.

Tags:

azure, cosmos, document, service

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Cosmos DB URIazure-cosmos-db-uriCosmos DB URI, typically in the form of https://{databaseaccount}.documents.azure.com:443/ Note this host URL is for Cosmos DB with Core SQL API from Azure Portal (Overview->URI)
Sensitive Property: true
Cosmos DB Access Keyazure-cosmos-db-keyCosmos DB Access Key from Azure Portal (Settings->Keys). Choose a read-write key to enable database or container creation at run time
Sensitive Property: true
Cosmos DB Consistency Levelazure-cosmos-db-consistency-levelSESSION
  • STRONG
  • BOUNDED_STALENESS
  • SESSION
  • CONSISTENT_PREFIX
  • EVENTUAL
Choose from five consistency levels on the consistency spectrum. Refer to Cosmos DB documentation for their differences

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.