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 required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display Name

API Name

Default Value

Allowable Values

Description

Cosmos DB Consistency Level

azure-cosmos-db-consistency-level

SESSION

  • STRONG

  • BOUNDED_STALENESS

  • SESSION

  • CONSISTENT_PREFIX

  • EVENTUAL

Choose from five consistency levels on the consistency spectrum. Refer to Cosmos DB documentation for their differences

Cosmos DB Access Key

azure-cosmos-db-key

Cosmos DB Access Key from Azure Portal (Settings->Keys). Choose a read-write key to enable database or container creation at run time

Cosmos DB URI

azure-cosmos-db-uri

Cosmos 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)

State management¶

This component does not store state.

Restricted¶

This component is not restricted.

System Resource Considerations¶

This component does not specify system resource considerations.