Azure Cosmos DB (Gremlin API) binding spec
Detailed documentation on the Azure Cosmos DB (Gremlin API) binding component
Component format
To setup an Azure Cosmos DB (Gremlin API) binding create a component of type bindings.azure.cosmosdb.gremlinapi. See this guide on how to create and apply a binding configuration.
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
name: <NAME>
spec:
type: bindings.azure.cosmosdb.gremlinapi
version: v1
metadata:
- name: url
value: "wss://******.gremlin.cosmos.azure.com:443/"
- name: masterKey
value: "*****"
- name: username
value: "*****"
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 Cosmos DB url for Gremlin APIs | "wss://******.gremlin.cosmos.azure.com:443/" |
masterKey | Y | Output | The Cosmos DB account master key | "masterKey" |
username | Y | Output | The username of the Cosmos DB database | "/dbs/<database_name>/colls/<graph_name>" |
For more information see Quickstart: Azure Cosmos Graph DB using Gremlin.
Binding support
This component supports output binding with the following operations:
query
Request payload sample
{
"data": {
"gremlin": "g.V().count()"
},
"operation": "query"
}