Skip to content

Commit 69ca494

Browse files
authored
Merge pull request #1883 from hokandil/v1.5
Add content for Azure CosmosDBGremlinAPI #1849 V1.5
2 parents f7ae951 + 167df85 commit 69ca494

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

daprdocs/content/en/reference/components-reference/supported-bindings/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Table captions:
7676
|------|:----------------:|:-----------------:|--------| --------- | ---------- |
7777
| [Azure Blob Storage]({{< ref blobstorage.md >}}) | || Alpha | v1 | 1.0 |
7878
| [Azure CosmosDB]({{< ref cosmosdb.md >}}) | || Alpha | v1 | 1.0 |
79+
| [Azure CosmosDBGremlinAPI]({{< ref cosmosdbgremlinapi.md >}}) | || Alpha | v1 | 1.5 |
7980
| [Azure Event Grid]({{< ref eventgrid.md >}}) ||| Alpha | v1 | 1.0 |
8081
| [Azure Event Hubs]({{< ref eventhubs.md >}}) ||| Alpha | v1 | 1.0 |
8182
| [Azure Service Bus Queues]({{< ref servicebusqueues.md >}}) ||| Alpha | v1 | 1.0 |
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
type: docs
3+
title: "Azure CosmosDBGremlinAPI binding spec"
4+
linkTitle: "Azure CosmosDBGremlinAPI"
5+
description: "Detailed documentation on the Azure CosmosDBGremlinAPI binding component"
6+
---
7+
8+
## Component format
9+
10+
To setup Azure CosmosDBGremlinAPI binding create a component of type `bindings.azure.cosmosdb.gremlinapi`. See [this guide]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
11+
12+
13+
```yaml
14+
apiVersion: dapr.io/v1alpha1
15+
kind: Component
16+
metadata:
17+
name: <NAME>
18+
namespace: <NAMESPACE>
19+
spec:
20+
type: bindings.azure.cosmosdb.gremlinapi
21+
version: v1
22+
metadata:
23+
- name: url
24+
value: wss://******.gremlin.cosmos.azure.com:443/
25+
- name: masterKey
26+
value: *****
27+
- name: username
28+
value: *****
29+
```
30+
31+
{{% alert title="Warning" color="warning" %}}
32+
The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described [here]({{< ref component-secrets.md >}}).
33+
{{% /alert %}}
34+
35+
## Spec metadata fields
36+
37+
| Field | Required | Binding support | Details | Example |
38+
|--------------------|:--------:|--------|---------|---------|
39+
| url | Y | Output | The CosmosDBGremlinAPI url | `"wss://******.gremlin.cosmos.azure.com:443/"` |
40+
| masterKey | Y | Output | The CosmosDBGremlinAPI account master key | `"masterKey"` |
41+
| database | Y | Output | The username of the CosmosDBGremlinAPI database | `"username"` |
42+
43+
For more information see [Quickstart: Azure Cosmos Graph DB using Gremlin ](https://docs.microsoft.com/en-us/azure/cosmos-db/graph/create-graph-console).
44+
45+
## Binding support
46+
47+
This component supports **output binding** with the following operations:
48+
49+
- `query`
50+
51+
## Related links
52+
53+
- [Basic schema for a Dapr component]({{< ref component-schema >}})
54+
- [Bindings building block]({{< ref bindings >}})
55+
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
56+
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
57+
- [Bindings API reference]({{< ref bindings_api.md >}})

0 commit comments

Comments
 (0)