The documentation you are viewing is for Dapr v1.4 which is an older version of Dapr. For up-to-date documentation, see the latest version.
Azure CosmosDB binding spec
Detailed documentation on the Azure CosmosDB binding component
Component format
To setup Azure CosmosDB binding create a component of type bindings.azure.cosmosdb
. See this guide on how to create and apply a binding configuration.
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
namespace: <NAMESPACE>
spec:
type: bindings.azure.cosmosdb
version: v1
metadata:
- name: url
value: https://******.documents.azure.com:443/
- name: masterKey
value: *****
- name: database
value: db
- name: collection
value: collection
- name: partitionKey
value: message
Warning
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here.Spec metadata fields
Field | Required | Binding support | Details | Example |
---|---|---|---|---|
url | Y | Output | The CosmosDB url | "https://******.documents.azure.com:443/" |
masterKey | Y | Output | The CosmosDB account master key | "master-key" |
database | Y | Output | The name of the CosmosDB database | "OrderDb" |
collection | Y | Output | The name of the container inside the database. | "Orders" |
partitionKey | Y | Output | The name of the partitionKey to extract from the payload and is used in the container | "OrderId" , "message" |
For more information see Azure Cosmos DB resource model.
Binding support
This component supports output binding with the following operations:
create
Related links
- Basic schema for a Dapr component
- Bindings building block
- How-To: Trigger application with input binding
- How-To: Use bindings to interface with external resources
- Bindings API reference
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.
Last modified
July 12, 2022
: update nav bar for v1.4 (#2641) (2db803e)