The documentation you are viewing is for Dapr v1.7 which is an older version of Dapr. For up-to-date documentation, see the latest version.

Azure CosmosDBGremlinAPI binding spec

Detailed documentation on the Azure CosmosDBGremlinAPI binding component

Component format

To setup Azure CosmosDBGremlinAPI 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>
  namespace: <NAMESPACE>
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 CosmosDBGremlinAPI url	`"wss://******.gremlin.cosmos.azure.com:443/"`
masterKey	Y	Output	The CosmosDBGremlinAPI account master key	`"masterKey"`
username	Y	Output	The username of the CosmosDBGremlinAPI 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"
}

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 February 19, 2022: Updating request payload format for cosmosdbgremlinapi (#2161) (1a0d4d31)