mirror of https://github.com/dapr/docs.git
Merge pull request #1883 from hokandil/v1.5
Add content for Azure CosmosDBGremlinAPI dapr#1849 V1.5
This commit is contained in:
commit
69ca494628
|
@ -76,6 +76,7 @@ Table captions:
|
||||||
|------|:----------------:|:-----------------:|--------| --------- | ---------- |
|
|------|:----------------:|:-----------------:|--------| --------- | ---------- |
|
||||||
| [Azure Blob Storage]({{< ref blobstorage.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
| [Azure Blob Storage]({{< ref blobstorage.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
||||||
| [Azure CosmosDB]({{< ref cosmosdb.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
| [Azure CosmosDB]({{< ref cosmosdb.md >}}) | | ✅ | Alpha | v1 | 1.0 |
|
||||||
|
| [Azure CosmosDBGremlinAPI]({{< ref cosmosdbgremlinapi.md >}}) | | ✅ | Alpha | v1 | 1.5 |
|
||||||
| [Azure Event Grid]({{< ref eventgrid.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
| [Azure Event Grid]({{< ref eventgrid.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
||||||
| [Azure Event Hubs]({{< ref eventhubs.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
| [Azure Event Hubs]({{< ref eventhubs.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
||||||
| [Azure Service Bus Queues]({{< ref servicebusqueues.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
| [Azure Service Bus Queues]({{< ref servicebusqueues.md >}}) | ✅ | ✅ | Alpha | v1 | 1.0 |
|
||||||
|
|
|
@ -0,0 +1,57 @@
|
||||||
|
---
|
||||||
|
type: docs
|
||||||
|
title: "Azure CosmosDBGremlinAPI binding spec"
|
||||||
|
linkTitle: "Azure CosmosDBGremlinAPI"
|
||||||
|
description: "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]({{< ref "howto-bindings.md#1-create-a-binding" >}}) on how to create and apply a binding configuration.
|
||||||
|
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
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: *****
|
||||||
|
```
|
||||||
|
|
||||||
|
{{% alert title="Warning" color="warning" %}}
|
||||||
|
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 >}}).
|
||||||
|
{{% /alert %}}
|
||||||
|
|
||||||
|
## 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"` |
|
||||||
|
| database | Y | Output | The username of the CosmosDBGremlinAPI database | `"username"` |
|
||||||
|
|
||||||
|
For more information see [Quickstart: Azure Cosmos Graph DB using Gremlin ](https://docs.microsoft.com/en-us/azure/cosmos-db/graph/create-graph-console).
|
||||||
|
|
||||||
|
## Binding support
|
||||||
|
|
||||||
|
This component supports **output binding** with the following operations:
|
||||||
|
|
||||||
|
- `query`
|
||||||
|
|
||||||
|
## Related links
|
||||||
|
|
||||||
|
- [Basic schema for a Dapr component]({{< ref component-schema >}})
|
||||||
|
- [Bindings building block]({{< ref bindings >}})
|
||||||
|
- [How-To: Trigger application with input binding]({{< ref howto-triggers.md >}})
|
||||||
|
- [How-To: Use bindings to interface with external resources]({{< ref howto-bindings.md >}})
|
||||||
|
- [Bindings API reference]({{< ref bindings_api.md >}})
|
Loading…
Reference in New Issue