Azure Cosmos DB
You can configure Azure Cosmos DB only as a target.
There are no properties to set at the Micro-Integration level for Azure Cosmos DB.
You must define at least one Micro-Integration Flow that specifies:
-
the endpoints where data is published to. For more information, see Micro-Integration Flow Parameters.
-
how the header and payload fields should be mapped. For more information, see Mapping Headers and Payloads
For a listing of available message headers, see Azure Cosmos DB Message Headers.
Micro-Integration Flow Parameters
You must configure the endpoint parameters for each Flow. Each Flow can have different settings, but they all share the connection details of the parent Micro-Integration.
Azure Cosmos DB Target Parameters
The following table describes the parameters for configuring Azure Cosmos DB as a target.
| Field | Description |
|---|---|
| Azure Cosmos DB Producer Binding | |
|
Destination |
The Azure Cosmos DB database and container where messages will be written, in the format |
|
Partition Key |
The name of the payload field to use as the partition key (for example, Hierarchical partition keys are not supported. |
| Authentication | Not editable. Pre-populates to Shared Account Key. |
| Shared Account Key | |
|
Database Endpoint |
The endpoint URL for the Azure Cosmos DB account. This is the URI that identifies your Azure Cosmos DB account and is used to establish the connection. For more information about Azure Cosmos DB endpoints, see the Azure Cosmos DB documentation. |
|
Account Key |
The shared key for authenticating to the Azure Cosmos DB account. This is a secret key that provides access to your Azure Cosmos DB resources. For more information about Azure Cosmos DB authentication, see the Azure Cosmos DB documentation. |
|
Additional Properties |
(Optional) Any additional configuration related to Azure Cosmos DB. Click Add Context if you need to specify additional context properties. For more information, see Additional Parameters for Azure Cosmos DB . |
Additional Parameters for Azure Cosmos DB
| Parameter | Valid Values | Description |
|---|---|---|
operation
|
upsertItem |
The Azure Cosmos DB operation to perform. |
autoDiscoverContainer
|
(true | false)
|
Specifies whether to automatically discover container settings. |
preferredRegions
|
Comma-separated region names | The preferred Azure regions for Azure Cosmos DB operations. |