Bindings component specs on Dapr Docs

Alibaba Cloud DingTalk binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Setup Dapr component

To setup an Alibaba Cloud DingTalk binding create a component of type bindings.dingtalk.webhook. See this guide on how to create and apply a secretstore configuration. See this guide on referencing secrets to retrieve and use the secret with Dapr components.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.dingtalk.webhook
 version: v1
 metadata:
 - name: id
 value: "test_webhook_id"
 - name: url
 value: "https://oapi.dingtalk.com/robot/send?access_token=******"
 - name: secret
 value: "****************"
 - name: direction
 value: "input, output"

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
`id`	Y	Input/Output	Unique id	`"test_webhook_id"`
`url`	Y	Input/Output	DingTalk’s Webhook url	`"https://oapi.dingtalk.com/robot/send?access_token=******"`
`secret`	N	Input/Output	The secret of DingTalk’s Webhook	`"****************"`
`direction`	N	Input/Output	The direction of the binding	`"input"`, `"output"`, `"input, output"`

Binding support

This component supports both input and output binding interfaces.

Alibaba Cloud Log Storage Service binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup an Alibaba Cloud SLS binding create a component of type bindings.alicloud.sls. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: alicloud.sls
spec:
 type: bindings.alicloud.sls
 version: v1
 metadata:
 - name: AccessKeyID
 value: "[accessKey-id]"
 - name: AccessKeySecret
 value: "[accessKey-secret]"
 - name: Endpoint
 value: "[endpoint]"

Spec metadata fields

Field	Required	Binding support	Details
`AccessKeyID`	Y	Output	Access key ID credential.
`AccessKeySecret`	Y	Output	Access key credential secret
`Endpoint`	Y	Output	Alicloud SLS endpoint.

Binding support

This component supports output binding with the following operations:

Alibaba Cloud Object Storage Service binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup an Alibaba Cloud Object Storage binding create a component of type bindings.alicloud.oss. See this guide on how to create and apply a secretstore configuration. See this guide on referencing secrets to retrieve and use the secret with Dapr components.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: alicloudobjectstorage
spec:
 type: bindings.alicloud.oss
 version: v1
 metadata:
 - name: endpoint
 value: "[endpoint]"
 - name: accessKeyID
 value: "[key-id]"
 - name: accessKey
 value: "[access-key]"
 - name: bucket
 value: "[bucket]"

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
`endpoint`	Y	Output	Alicloud OSS endpoint.	https://oss-cn-hangzhou.aliyuncs.com
`accessKeyID`	Y	Output	Access key ID credential.
`accessKey`	Y	Output	Access key credential.
`bucket`	Y	Output	Name of the storage bucket.

Binding support

This component supports output binding with the following operations:

Alibaba Cloud Tablestore binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup an Alibaba Cloud Tablestore binding create a component of type bindings.alicloud.tablestore. See this guide on how to create and apply a secretstore configuration. See this guide on referencing secrets to retrieve and use the secret with Dapr components.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: mytablestore
spec:
 type: bindings.alicloud.tablestore
 version: v1
 metadata:
 - name: endpoint
 value: "[endpoint]"
 - name: accessKeyID
 value: "[key-id]"
 - name: accessKey
 value: "[access-key]"
 - name: instanceName
 value: "[instance]"
 - name: tableName
 value: "[table]"
 - name: endpoint
 value: "[endpoint]"

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
`endpoint`	Y	Output	Alicloud Tablestore endpoint.	https://tablestore-cn-hangzhou.aliyuncs.com
`accessKeyID`	Y	Output	Access key ID credential.
`accessKey`	Y	Output	Access key credential.
`instanceName`	Y	Output	Name of the instance.
`tableName`	Y	Output	Name of the table.

Binding support

This component supports output binding with the following operations:

Apple Push Notification Service binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Apple Push Notifications binding create a component of type bindings.apns. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.apns
 version: v1
 metadata:
 - name: development
 value: "<bool>"
 - name: key-id
 value: "<APPLE_KEY_ID>"
 - name: team-id
 value: "<APPLE_TEAM_ID>"
 - name: private-key
 secretKeyRef:
 name: <SECRET>
 key: "<SECRET-KEY-NAME>"

Spec metadata fields

Field	Required	Binding support	Details	Example
`development`	Y	Output	Tells the binding which APNs service to use. Set to `"true"` to use the development service or `"false"` to use the production service. Default: `"true"`	`"true"`
`key-id`	Y	Output	The identifier for the private key from the Apple Developer Portal	`"private-key-id`"
`team-id`	Y	Output	The identifier for the organization or author from the Apple Developer Portal	`"team-id"`
`private-key`	Y	Output	Is a PKCS #8-formatted private key. It is intended that the private key is stored in the secret store and not exposed directly in the configuration. See here for more details	`"pem file"`

Private key

The APNS binding needs a cryptographic private key in order to generate authentication tokens for the APNS service. The private key can be generated from the Apple Developer Portal and is provided as a PKCS #8 file with the private key stored in PEM format. The private key should be stored in the Dapr secret store and not stored directly in the binding’s configuration file.

AWS DynamoDB binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup AWS DynamoDB binding create a component of type bindings.aws.dynamodb. See this guide on how to create and apply a binding configuration.

See Authenticating to AWS for information about authentication-related attributes

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.aws.dynamodb
 version: v1
 metadata:
 - name: table
 value: "items"
 - name: region
 value: "us-west-2"
 - name: accessKey
 value: "*****************"
 - name: secretKey
 value: "*****************"
 - name: sessionToken
 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
`table`	Y	Output	The DynamoDB table name	`"items"`
`region`	Y	Output	The specific AWS region the AWS DynamoDB instance is deployed in	`"us-east-1"`
`accessKey`	Y	Output	The AWS Access Key to access this resource	`"key"`
`secretKey`	Y	Output	The AWS Secret Access Key to access this resource	`"secretAccessKey"`
`sessionToken`	N	Output	The AWS session token to use	`"sessionToken"`

Important

When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you’re using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you must not provide AWS access-key, secret-key, and tokens in the definition of the component spec you’re using.

Binding support

This component supports output binding with the following operations:

AWS Kinesis binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup AWS Kinesis binding create a component of type bindings.aws.kinesis. See this guide on how to create and apply a binding configuration.

See this for instructions on how to set up an AWS Kinesis data streams See Authenticating to AWS for information about authentication-related attributes

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.aws.kinesis
 version: v1
 metadata:
 - name: streamName
 value: "KINESIS_STREAM_NAME" # Kinesis stream name
 - name: consumerName
 value: "KINESIS_CONSUMER_NAME" # Kinesis consumer name
 - name: mode
 value: "shared" # shared - Shared throughput or extended - Extended/Enhanced fanout
 - name: region
 value: "AWS_REGION" #replace
 - name: accessKey
 value: "AWS_ACCESS_KEY" # replace
 - name: secretKey
 value: "AWS_SECRET_KEY" #replace
 - name: sessionToken
 value: "*****************"
 - name: direction
 value: "input, output"
 - name: endpoint
 value: "http://localhost:4566" # Optional: Custom endpoint (e.g. for LocalStack)

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
`mode`	N	Input	The Kinesis stream mode. `shared`- Shared throughput, `extended` - Extended/Enhanced fanout methods. More details are here. Defaults to `"shared"`	`"shared"`, `"extended"`
`streamName`	Y	Input/Output	The AWS Kinesis Stream Name	`"stream"`
`consumerName`	Y	Input	The AWS Kinesis Consumer Name	`"myconsumer"`
`region`	Y	Output	The specific AWS region the AWS Kinesis instance is deployed in	`"us-east-1"`
`accessKey`	Y	Output	The AWS Access Key to access this resource	`"key"`
`secretKey`	Y	Output	The AWS Secret Access Key to access this resource	`"secretAccessKey"`
`sessionToken`	N	Output	The AWS session token to use	`"sessionToken"`
`direction`	N	Input/Output	The direction of the binding	`"input"`, `"output"`, `"input, output"`
`endpoint`	N	Input	Custom endpoint for Kinesis and DynamoDB (for example to enable AWS LocalStack support)	`"http://localhost:4566"`

Important

Binding support

This component supports both input and output binding interfaces.

AWS S3 binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup an AWS S3 binding create a component of type bindings.aws.s3. This binding works with other S3-compatible services, such as Minio. See this guide on how to create and apply a binding configuration.

See Authenticating to AWS for information about authentication-related attributes.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.aws.s3
 version: v1
 metadata:
 - name: bucket
 value: "mybucket"
 - name: region
 value: "us-west-2"
 - name: endpoint
 value: "s3.us-west-2.amazonaws.com"
 - name: accessKey
 value: "*****************"
 - name: secretKey
 value: "*****************"
 - name: sessionToken
 value: "mysession"
 - name: decodeBase64
 value: "<bool>"
 - name: encodeBase64
 value: "<bool>"
 - name: forcePathStyle
 value: "<bool>"
 - name: disableSSL
 value: "<bool>"
 - name: insecureSSL
 value: "<bool>"
 - name: storageClass
 value: "<string>"

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
`bucket`	Y	Output	The name of the S3 bucket to write to	`"bucket"`
`region`	Y	Output	The specific AWS region	`"us-east-1"`
`endpoint`	N	Output	The specific AWS endpoint	`"s3.us-east-1.amazonaws.com"`
`accessKey`	Y	Output	The AWS Access Key to access this resource	`"key"`
`secretKey`	Y	Output	The AWS Secret Access Key to access this resource	`"secretAccessKey"`
`sessionToken`	N	Output	The AWS session token to use	`"sessionToken"`
`forcePathStyle`	N	Output	Currently Amazon S3 SDK supports virtual hosted-style and path-style access. `"true"` is path-style format like `"https://<endpoint>/<your bucket>/<key>"`. `"false"` is hosted-style format like `"https://<your bucket>.<endpoint>/<key>"`. Defaults to `"false"`	`"true"`, `"false"`
`decodeBase64`	N	Output	Configuration to decode base64 file content before saving to bucket storage. (In case of saving a file with binary content). `"true"` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false`	`"true"`, `"false"`
`encodeBase64`	N	Output	Configuration to encode base64 file content before return the content. (In case of opening a file with binary content). `"true"` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `"false"`	`"true"`, `"false"`
`disableSSL`	N	Output	Allows to connect to non `https://` endpoints. Defaults to `"false"`	`"true"`, `"false"`
`insecureSSL`	N	Output	When connecting to `https://` endpoints, accepts invalid or self-signed certificates. Defaults to `"false"`	`"true"`, `"false"`
`storageClass`	N	Output	The desired storage class for objects during the create operation. Valid aws storage class types can be found here	`STANDARD_IA`

Important

S3 Bucket Creation

Using with Minio

Minio is a service that exposes local storage as S3-compatible block storage, and it’s a popular alternative to S3 especially in development environments. You can use the S3 binding with Minio too, with some configuration tweaks:

AWS SES binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup AWS binding create a component of type bindings.aws.ses. See this guide on how to create and apply a binding configuration.

See Authenticating to AWS for information about authentication-related attributes

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: ses
spec:
 type: bindings.aws.ses
 version: v1
 metadata:
 - name: accessKey
 value: *****************
 - name: secretKey
 value: *****************
 - name: region
 value: "eu-west-1"
 - name: sessionToken
 value: mysession
 - name: emailFrom
 value: "sender@example.com"
 - name: emailTo
 value: "receiver@example.com"
 - name: emailCc
 value: "cc@example.com"
 - name: emailBcc
 value: "bcc@example.com"
 - name: subject
 value: "subject"

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
`region`	N	Output	The specific AWS region	`"eu-west-1"`
`accessKey`	N	Output	The AWS Access Key to access this resource	`"key"`
`secretKey`	N	Output	The AWS Secret Access Key to access this resource	`"secretAccessKey"`
`sessionToken`	N	Output	The AWS session token to use	`"sessionToken"`
`emailFrom`	N	Output	If set, this specifies the email address of the sender. See also	`"me@example.com"`
`emailTo`	N	Output	If set, this specifies the email address of the receiver. See also	`"me@example.com"`
`emailCc`	N	Output	If set, this specifies the email address to CC in. See also	`"me@example.com"`
`emailBcc`	N	Output	If set, this specifies email address to BCC in. See also	`"me@example.com"`
`subject`	N	Output	If set, this specifies the subject of the email message. See also	`"subject of mail"`

Important

Binding support

This component supports output binding with the following operations:

AWS SNS binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup AWS SNS binding create a component of type bindings.aws.sns. See this guide on how to create and apply a binding configuration.

See Authenticating to AWS for information about authentication-related attributes

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.aws.sns
 version: v1
 metadata:
 - name: topicArn
 value: "mytopic"
 - name: region
 value: "us-west-2"
 - name: endpoint
 value: "sns.us-west-2.amazonaws.com"
 - name: accessKey
 value: "*****************"
 - name: secretKey
 value: "*****************"
 - name: sessionToken
 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
`topicArn`	Y	Output	The SNS topic name	`"arn:::topicarn"`
`region`	Y	Output	The specific AWS region	`"us-east-1"`
`endpoint`	N	Output	The specific AWS endpoint	`"sns.us-east-1.amazonaws.com"`
`accessKey`	Y	Output	The AWS Access Key to access this resource	`"key"`
`secretKey`	Y	Output	The AWS Secret Access Key to access this resource	`"secretAccessKey"`
`sessionToken`	N	Output	The AWS session token to use	`"sessionToken"`

Important

Binding support

This component supports output binding with the following operations:

AWS SQS binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup AWS SQS binding create a component of type bindings.aws.sqs. See this guide on how to create and apply a binding configuration.

See Authenticating to AWS for information about authentication-related attributes

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.aws.sqs
 version: v1
 metadata:
 - name: queueName
 value: "items"
 - name: region
 value: "us-west-2"
 - name: endpoint
 value: "sqs.us-west-2.amazonaws.com" 
 - name: accessKey
 value: "*****************"
 - name: secretKey
 value: "*****************"
 - name: sessionToken
 value: "*****************"
 - name: direction 
 value: "input, output"

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
`queueName`	Y	Input/Output	The SQS queue name	`"myqueue"`
`region`	Y	Input/Output	The specific AWS region	`"us-east-1"`
`endpoint`	N	Output	The specific AWS endpoint	`"sqs.us-east-1.amazonaws.com"`
`accessKey`	Y	Input/Output	The AWS Access Key to access this resource	`"key"`
`secretKey`	Y	Input/Output	The AWS Secret Access Key to access this resource	`"secretAccessKey"`
`sessionToken`	N	Input/Output	The AWS session token to use	`"sessionToken"`
`direction`	N	Input/Output	The direction of the binding	`"input"`, `"output"`, `"input, output"`

Important

Binding support

This component supports both input and output binding interfaces.

Azure Blob Storage binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Azure Blob Storage binding create a component of type bindings.azure.blobstorage. 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.blobstorage
 version: v1
 metadata:
 - name: accountName
 value: myStorageAccountName
 - name: accountKey
 value: ***********
 - name: containerName
 value: container1
# - name: decodeBase64
# value: <bool>
# - name: getBlobRetryCount
# value: <integer>
# - name: publicAccessLevel
# value: <publicAccessLevel>
# - name: disableEntityManagement
# value: <bool>

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
`accountName`	Y	Input/Output	The name of the Azure Storage account	`"myexmapleaccount"`
`accountKey`	Y*	Input/Output	The access key of the Azure Storage account. Only required when not using Microsoft Entra ID authentication.	`"access-key"`
`containerName`	Y	Output	The name of the Blob Storage container to write to	`myexamplecontainer`
`endpoint`	N	Input/Output	Optional custom endpoint URL. This is useful when using the Azurite emulator or when using custom domains for Azure Storage (although this is not officially supported). The endpoint must be the full base URL, including the protocol (`http://` or `https://`), the IP or FQDN, and optional port.	`"http://127.0.0.1:10000"`
`decodeBase64`	N	Output	Configuration to decode base64 file content before saving to Blob Storage. (In case of saving a file with binary content). Defaults to `false`	`true`, `false`
`getBlobRetryCount`	N	Output	Specifies the maximum number of HTTP GET requests that will be made while reading from a RetryReader Defaults to `10`	`1`, `2`
`publicAccessLevel`	N	Output	Specifies whether data in the container may be accessed publicly and the level of access (only used if the container is created by Dapr). Defaults to `none`	`blob`, `container`, `none`
`disableEntityManagement`	N	Output	Configuration to disable entity management. When set to `true`, the binding skips the attempt to create the specified storage container. This is useful when operating with minimal Azure AD permissions. Defaults to `false`	`true`, `false`

Microsoft Entra ID authentication

The Azure Blob Storage binding component supports authentication using all Microsoft Entra ID mechanisms. For further information and the relevant component metadata fields to provide depending on the choice of Microsoft Entra ID authentication mechanism, see the docs for authenticating to Azure.

Azure Cosmos DB (Gremlin API) binding spec

Mon, 01 Jan 0001 00:00:00 +0000

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.

Azure Cosmos DB (SQL API) binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Azure Cosmos DB 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>
spec:
 type: bindings.azure.cosmosdb
 version: v1
 metadata:
 - name: url
 value: "https://******.documents.azure.com:443/"
 - name: masterKey
 value: "*****"
 - name: database
 value: "OrderDb"
 - name: collection
 value: "Orders"
 - 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 Cosmos DB url	`"https://******.documents.azure.com:443/"`
`masterKey`	Y	Output	The Cosmos DB account master key	`"master-key"`
`database`	Y	Output	The name of the Cosmos DB database	`"OrderDb"`
`collection`	Y	Output	The name of the container inside the database.	`"Orders"`
`partitionKey`	Y	Output	The name of the key to extract from the payload (document to be created) that is used as the partition key. This name must match the partition key specified upon creation of the Cosmos DB container.	`"OrderId"`, `"message"`

For more information see Azure Cosmos DB resource model.

Azure Event Grid binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup an Azure Event Grid binding create a component of type bindings.azure.eventgrid. See this guide on how to create and apply a binding configuration.

See this for the documentation for Azure Event Grid.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <name>
spec:
 type: bindings.azure.eventgrid
 version: v1
 metadata:
 # Required Output Binding Metadata
 - name: accessKey
 value: "[AccessKey]"
 - name: topicEndpoint
 value: "[TopicEndpoint]"
 # Required Input Binding Metadata
 - name: azureTenantId
 value: "[AzureTenantId]"
 - name: azureSubscriptionId
 value: "[AzureSubscriptionId]"
 - name: azureClientId
 value: "[ClientId]"
 - name: azureClientSecret
 value: "[ClientSecret]"
 - name: subscriberEndpoint
 value: "[SubscriberEndpoint]"
 - name: handshakePort
 # Make sure to pass this as a string, with quotes around the value
 value: "[HandshakePort]"
 - name: scope
 value: "[Scope]"
 # Optional Input Binding Metadata
 - name: eventSubscriptionName
 value: "[EventSubscriptionName]"
 # Optional metadata
 - name: direction
 value: "input, output"

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
`accessKey`	Y	Output	The Access Key to be used for publishing an Event Grid Event to a custom topic	`"accessKey"`
`topicEndpoint`	Y	Output	The topic endpoint in which this output binding should publish events	`"topic-endpoint"`
`azureTenantId`	Y	Input	The Azure tenant ID of the Event Grid resource	`"tenentID"`
`azureSubscriptionId`	Y	Input	The Azure subscription ID of the Event Grid resource	`"subscriptionId"`
`azureClientId`	Y	Input	The client ID that should be used by the binding to create or update the Event Grid Event Subscription and to authenticate incoming messages	`"clientId"`
`azureClientSecret`	Y	Input	The client id that should be used by the binding to create or update the Event Grid Event Subscription and to authenticate incoming messages	`"clientSecret"`
`subscriberEndpoint`	Y	Input	The HTTPS endpoint of the webhook Event Grid sends events (formatted as Cloud Events) to. If you’re not re-writing URLs on ingress, it should be in the form of: `"https://[YOUR HOSTNAME]/<path>"` If testing on your local machine, you can use something like ngrok to create a public endpoint.	`"https://[YOUR HOSTNAME]/<path>"`
`handshakePort`	Y	Input	The container port that the input binding listens on when receiving events on the webhook	`"9000"`
`scope`	Y	Input	The identifier of the resource to which the event subscription needs to be created or updated. See the scope section for more details	`"/subscriptions/{subscriptionId}/"`
`eventSubscriptionName`	N	Input	The name of the event subscription. Event subscription names must be between 3 and 64 characters long and should use alphanumeric letters only	`"name"`
`direction`	N	Input/Output	The direction of the binding	`"input"`, `"output"`, `"input, output"`

Scope

Scope is the identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, a resource group, a top-level resource belonging to a resource provider namespace, or an Event Grid topic. For example:

Azure Event Hubs binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup an Azure Event Hubs binding, create a component of type bindings.azure.eventhubs. See this guide on how to create and apply a binding configuration.

See this for instructions on how to set up an Event Hub.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.azure.eventhubs
 version: v1
 metadata:
 # Hub name ("topic")
 - name: eventHub
 value: "mytopic"
 - name: consumerGroup
 value: "myapp"
 # Either connectionString or eventHubNamespace is required
 # Use connectionString when *not* using Microsoft Entra ID
 - name: connectionString
 value: "Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"
 # Use eventHubNamespace when using Microsoft Entra ID
 - name: eventHubNamespace
 value: "namespace"
 - name: enableEntityManagement
 value: "false"
 - name: enableInOrderMessageDelivery
 value: "false"
 # The following four properties are needed only if enableEntityManagement is set to true
 - name: resourceGroupName
 value: "test-rg"
 - name: subscriptionID
 value: "value of Azure subscription ID"
 - name: partitionCount
 value: "1"
 - name: messageRetentionInDays
 value: "3"
 # Checkpoint store attributes
 - name: storageAccountName
 value: "myeventhubstorage"
 - name: storageAccountKey
 value: "112233445566778899"
 - name: storageContainerName
 value: "myeventhubstoragecontainer"
 # Alternative to passing storageAccountKey
 - name: storageConnectionString
 value: "DefaultEndpointsProtocol=https;AccountName=<account>;AccountKey=<account-key>"
 # Optional metadata
 - name: getAllMessageProperties
 value: "true"
 - name: direction
 value: "input, output"

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
`eventHub`	Y*	Input/Output	The name of the Event Hubs hub (“topic”). Required if using Microsoft Entra ID authentication or if the connection string doesn’t contain an `EntityPath` value	`mytopic`
`connectionString`	Y*	Input/Output	Connection string for the Event Hub or the Event Hub namespace. * Mutually exclusive with `eventHubNamespace` field. * Required when not using Microsoft Entra ID Authentication	`"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"` or `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key}"`
`eventHubNamespace`	Y*	Input/Output	The Event Hub Namespace name. * Mutually exclusive with `connectionString` field. * Required when using Microsoft Entra ID Authentication	`"namespace"`
`enableEntityManagement`	N	Input/Output	Boolean value to allow management of the EventHub namespace and storage account. Default: `false`	`"true"`, `"false"`
`enableInOrderMessageDelivery`	N	Input/Output	Boolean value to allow messages to be delivered in the order in which they were posted. This assumes `partitionKey` is set when publishing or posting to ensure ordering across partitions. Default: `false`	`"true"`, `"false"`
`resourceGroupName`	N	Input/Output	Name of the resource group the Event Hub namespace is part of. Required when entity management is enabled	`"test-rg"`
`subscriptionID`	N	Input/Output	Azure subscription ID value. Required when entity management is enabled	`"azure subscription id"`
`partitionCount`	N	Input/Output	Number of partitions for the new Event Hub namespace. Used only when entity management is enabled. Default: `"1"`	`"2"`
`messageRetentionInDays`	N	Input/Output	Number of days to retain messages for in the newly created Event Hub namespace. Used only when entity management is enabled. Default: `"1"`	`"90"`
`consumerGroup`	Y	Input	The name of the Event Hubs Consumer Group to listen on	`"group1"`
`storageAccountName`	Y	Input	Storage account name to use for the checkpoint store.	`"myeventhubstorage"`
`storageAccountKey`	Y*	Input	Storage account key for the checkpoint store account. * When using Microsoft Entra ID, it’s possible to omit this if the service principal has access to the storage account too.	`"112233445566778899"`
`storageConnectionString`	Y*	Input	Connection string for the checkpoint store, alternative to specifying `storageAccountKey`	`"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey=<account-key>"`
`storageContainerName`	Y	Input	Storage container name for the storage account name.	`"myeventhubstoragecontainer"`
`getAllMessageProperties`	N	Input	When set to `true`, retrieves all user/app/custom properties from the Event Hub message and forwards them in the returned event metadata. Default setting is `"false"`.	`"true"`, `"false"`
`direction`	N	Input/Output	The direction of the binding.	`"input"`, `"output"`, `"input, output"`

Microsoft Entra ID authentication

The Azure Event Hubs pub/sub component supports authentication using all Microsoft Entra ID mechanisms. For further information and the relevant component metadata fields to provide depending on the choice of Microsoft Entra ID authentication mechanism, see the docs for authenticating to Azure.

Azure OpenAI binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup an Azure OpenAI binding create a component of type bindings.azure.openai. See this guide on how to create and apply a binding configuration. See this for the documentation for Azure OpenAI Service.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.azure.openai
 version: v1
 metadata:
 - name: apiKey # Required
 value: "1234567890abcdef"
 - name: endpoint # Required
 value: "https://myopenai.openai.azure.com"

Warning

The above example uses apiKey as a plain string. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Binding support	Details	Example
`endpoint`	Y	Output	Azure OpenAI service endpoint URL.	`"https://myopenai.openai.azure.com"`
`apiKey`	Y*	Output	The access key of the Azure OpenAI service. Only required when not using Microsoft Entra ID authentication.	`"1234567890abcdef"`
`azureTenantId`	Y*	Input	The tenant ID of the Azure OpenAI resource. Only required when `apiKey` is not provided.	`"tenentID"`
`azureClientId`	Y*	Input	The client ID that should be used by the binding to create or update the Azure OpenAI Subscription and to authenticate incoming messages. Only required when `apiKey` is not provided.	`"clientId"`
`azureClientSecret`	Y*	Input	The client secret that should be used by the binding to create or update the Azure OpenAI Subscription and to authenticate incoming messages. Only required when `apiKey` is not provided.	`"clientSecret"`

Microsoft Entra ID authentication

The Azure OpenAI binding component supports authentication using all Microsoft Entra ID mechanisms. For further information and the relevant component metadata fields to provide depending on the choice of Microsoft Entra ID authentication mechanism, see the docs for authenticating to Azure.

Azure Service Bus Queues binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Azure Service Bus Queues binding create a component of type bindings.azure.servicebusqueues. See this guide on how to create and apply a binding configuration.

Connection String Authentication

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.azure.servicebusqueues
 version: v1
 metadata:
 - name: connectionString # Required when not using Azure Authentication.
 value: "Endpoint=sb://{ServiceBusNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={ServiceBus}"
 - name: queueName
 value: "queue1"
 # - name: timeoutInSec # Optional
 # value: "60"
 # - name: handlerTimeoutInSec # Optional
 # value: "60"
 # - name: disableEntityManagement # Optional
 # value: "false"
 # - name: maxDeliveryCount # Optional
 # value: "3"
 # - name: lockDurationInSec # Optional
 # value: "60"
 # - name: lockRenewalInSec # Optional
 # value: "20"
 # - name: maxActiveMessages # Optional
 # value: "10000"
 # - name: maxConcurrentHandlers # Optional
 # value: "10"
 # - name: defaultMessageTimeToLiveInSec # Optional
 # value: "10"
 # - name: autoDeleteOnIdleInSec # Optional
 # value: "3600"
 # - name: minConnectionRecoveryInSec # Optional
 # value: "2"
 # - name: maxConnectionRecoveryInSec # Optional
 # value: "300"
 # - name: maxRetriableErrorsPerSec # Optional
 # value: "10"
 # - name: publishMaxRetries # Optional
 # value: "5"
 # - name: publishInitialRetryIntervalInMs # Optional
 # value: "500"
 # - name: direction
 # value: "input, output"

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
`connectionString`	Y	Input/Output	The Service Bus connection string. Required unless using Microsoft Entra ID authentication.	`"Endpoint=sb://************"`
`queueName`	Y	Input/Output	The Service Bus queue name. Queue names are case-insensitive and will always be forced to lowercase.	`"queuename"`
`timeoutInSec`	N	Input/Output	Timeout for all invocations to the Azure Service Bus endpoint, in seconds. Note that this option impacts network calls and it’s unrelated to the TTL applies to messages. Default: `"60"`	`"60"`
`namespaceName`	N	Input/Output	Parameter to set the address of the Service Bus namespace, as a fully-qualified domain name. Required if using Microsoft Entra ID authentication.	`"namespace.servicebus.windows.net"`
`disableEntityManagement`	N	Input/Output	When set to true, queues and subscriptions do not get created automatically. Default: `"false"`	`"true"`, `"false"`
`lockDurationInSec`	N	Input/Output	Defines the length in seconds that a message will be locked for before expiring. Used during subscription creation only. Default set by server.	`"30"`
`autoDeleteOnIdleInSec`	N	Input/Output	Time in seconds to wait before auto deleting idle subscriptions. Used during subscription creation only. Must be 300s or greater. Default: `"0"` (disabled)	`"3600"`
`defaultMessageTimeToLiveInSec`	N	Input/Output	Default message time to live, in seconds. Used during subscription creation only.	`"10"`
`maxDeliveryCount`	N	Input/Output	Defines the number of attempts the server will make to deliver a message. Used during subscription creation only. Default set by server.	`"10"`
`minConnectionRecoveryInSec`	N	Input/Output	Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `"2"`	`"5"`
`maxConnectionRecoveryInSec`	N	Input/Output	Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the component waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `"300"` (5 minutes)	`"600"`
`maxActiveMessages`	N	Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `"1"`	`"1"`
`handlerTimeoutInSec`	N	Input	Timeout for invoking the app’s handler. Default: `"0"` (no timeout)	`"30"`
`minConnectionRecoveryInSec`	N	Input	Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `"2"`	`"5"`
`maxConnectionRecoveryInSec`	N	Input	Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the binding waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `"300"` (5 minutes)	`"600"`
`lockRenewalInSec`	N	Input	Defines the frequency at which buffered message locks will be renewed. Default: `"20"`.	`"20"`
`maxActiveMessages`	N	Input	Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `"1"`	`"2000"`
`maxConcurrentHandlers`	N	Input	Defines the maximum number of concurrent message handlers; set to `0` for unlimited. Default: `"1"`	`"10"`
`maxRetriableErrorsPerSec`	N	Input	Maximum number of retriable errors that are processed per second. If a message fails to be processed with a retriable error, the component adds a delay before it starts processing another message, to avoid immediately re-processing messages that have failed. Default: `"10"`	`"10"`
`publishMaxRetries`	N	Output	The max number of retries for when Azure Service Bus responds with “too busy” in order to throttle messages. Defaults: `"5"`	`"5"`
`publishInitialRetryIntervalInMs`	N	Output	Time in milliseconds for the initial exponential backoff when Azure Service Bus throttle messages. Defaults: `"500"`	`"500"`
`direction`	N	Input/Output	The direction of the binding	`"input"`, `"output"`, `"input, output"`

Microsoft Entra ID authentication

The Azure Service Bus Queues binding component supports authentication using all Microsoft Entra ID mechanisms, including Managed Identities. For further information and the relevant component metadata fields to provide depending on the choice of Microsoft Entra ID authentication mechanism, see the docs for authenticating to Azure.

Azure SignalR binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Azure SignalR binding create a component of type bindings.azure.signalr. 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.signalr
 version: v1
 metadata:
 - name: connectionString
 value: "Endpoint=https://<your-azure-signalr>.service.signalr.net;AccessKey=<your-access-key>;Version=1.0;"
 - name: hub  # Optional
 value: "<hub name>"

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
`connectionString`	Y	Output	The Azure SignalR connection string	`"Endpoint=https://<your-azure-signalr>.service.signalr.net;AccessKey=<your-access-key>;Version=1.0;"`
`hub`	N	Output	Defines the hub in which the message will be send. The hub can be dynamically defined as a metadata value when publishing to an output binding (key is “hub”)	`"myhub"`
`endpoint`	N	Output	Endpoint of Azure SignalR; required if not included in the `connectionString` or if using Microsoft Entra ID	`"https://<your-azure-signalr>.service.signalr.net"`
`accessKey`	N	Output	Access key	`"your-access-key"`

Microsoft Entra ID authentication

The Azure SignalR binding component supports authentication using all Microsoft Entra ID mechanisms. See the docs for authenticating to Azure to learn more about the relevant component metadata fields based on your choice of Microsoft Entra ID authentication mechanism.

Azure Storage Queues binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Azure Storage Queues binding create a component of type bindings.azure.storagequeues. 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.storagequeues
 version: v1
 metadata:
 - name: accountName
 value: "account1"
 - name: accountKey
 value: "***********"
 - name: queueName
 value: "myqueue"
# - name: pollingInterval
# value: "30s"
# - name: ttlInSeconds
# value: "60"
# - name: decodeBase64
# value: "false"
# - name: encodeBase64
# value: "false"
# - name: endpoint
# value: "http://127.0.0.1:10001"
# - name: visibilityTimeout
# value: "30s"
# - name: initialVisibilityDelay
# value: "30s"
# - name: direction 
# value: "input, output"

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
`accountName`	Y	Input/Output	The name of the Azure Storage account	`"account1"`
`accountKey`	Y*	Input/Output	The access key of the Azure Storage account. Only required when not using Microsoft Entra ID authentication.	`"access-key"`
`queueName`	Y	Input/Output	The name of the Azure Storage queue	`"myqueue"`
`pollingInterval`	N	Output	Set the interval to poll Azure Storage Queues for new messages, as a Go duration value. Default: `"10s"`	`"30s"`
`ttlInSeconds`	N	Output	Parameter to set the default message time to live. If this parameter is omitted, messages will expire after 10 minutes. See also	`"60"`
`decodeBase64`	N	Input	Configuration to decode base64 content received from the Storage Queue into a string. Defaults to `false`	`true`, `false`
`encodeBase64`	N	Output	If enabled base64 encodes the data payload before uploading to Azure storage queues. Default `false`.	`true`, `false`
`endpoint`	N	Input/Output	Optional custom endpoint URL. This is useful when using the Azurite emulator or when using custom domains for Azure Storage (although this is not officially supported). The endpoint must be the full base URL, including the protocol (`http://` or `https://`), the IP or FQDN, and optional port.	`"http://127.0.0.1:10001"` or `"https://accountName.queue.example.com"`
`initialVisibilityDelay`	N	Input	Allows setting a custom queue visibility timeout to avoid immediate retrying of recently failed messages. Defaults to 30 seconds.	`"100s"`
`visibilityTimeout`	N	Input	Sets a delay before a message becomes visible in the queue after being added. It can also be specified per message by setting the `initialVisibilityDelay` property in the invocation request’s metadata. Defaults to 0 seconds.	`"30s"`
`direction`	N	Input/Output	Direction of the binding.	`"input"`, `"output"`, `"input, output"`

Microsoft Entra ID authentication

The Azure Storage Queue binding component supports authentication using all Microsoft Entra ID mechanisms. See the docs for authenticating to Azure to learn more about the relevant component metadata fields based on your choice of Microsoft Entra ID authentication mechanism.

Cloudflare Queues bindings spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

This output binding for Dapr allows interacting with Cloudflare Queues to publish new messages. It is currently not possible to consume messages from a Queue using Dapr.

To setup a Cloudflare Queues binding, create a component of type bindings.cloudflare.queues. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.cloudflare.queues
 version: v1
 # Increase the initTimeout if Dapr is managing the Worker for you
 initTimeout: "120s"
 metadata:
 # Name of the existing Cloudflare Queue (required)
 - name: queueName
 value: ""
 # Name of the Worker (required)
 - name: workerName
 value: ""
 # PEM-encoded private Ed25519 key (required)
 - name: key
 value: |
 -----BEGIN PRIVATE KEY-----
 MC4CAQ...
 -----END PRIVATE KEY-----
 # Cloudflare account ID (required to have Dapr manage the Worker)
 - name: cfAccountID
 value: ""
 # API token for Cloudflare (required to have Dapr manage the Worker)
 - name: cfAPIToken
 value: ""
 # URL of the Worker (required if the Worker has been pre-created outside of Dapr)
 - name: workerUrl
 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
`queueName`	Y	Output	Name of the existing Cloudflare Queue	`"mydaprqueue"`
`key`	Y	Output	Ed25519 private key, PEM-encoded	See example above
`cfAccountID`	Y/N	Output	Cloudflare account ID. Required to have Dapr manage the worker.	`"456789abcdef8b5588f3d134f74ac"def`
`cfAPIToken`	Y/N	Output	API token for Cloudflare. Required to have Dapr manage the Worker.	`"secret-key"`
`workerUrl`	Y/N	Output	URL of the Worker. Required if the Worker has been pre-provisioned outside of Dapr.	`"https://mydaprqueue.mydomain.workers.dev"`

When you configure Dapr to create your Worker for you, you may need to set a longer value for the initTimeout property of the component, to allow enough time for the Worker script to be deployed. For example: initTimeout: "120s"

commercetools GraphQL binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup commercetools GraphQL binding create a component of type bindings.commercetools. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.commercetools
 version: v1
 metadata:
 - name: region # required.
 value: "region"
 - name: provider # required.
 value: "gcp"
 - name: projectKey # required.
 value: "<project-key>"
 - name: clientID # required.
 value: "*****************"
 - name: clientSecret # required.
 value: "*****************"
 - name: scopes # required.
 value: "<project-scopes>"

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
`region`	Y	Output	The region of the commercetools project	`"europe-west1"`
`provider`	Y	Output	The cloud provider, either gcp or aws	`"gcp"`, `"aws"`
`projectKey`	Y	Output	The commercetools project key
`clientID`	Y	Output	The commercetools client ID for the project
`clientSecret`	Y	Output	The commercetools client secret for the project
`scopes`	Y	Output	The commercetools scopes for the project	`"manage_project:project-key"`

For more information see commercetools - Creating an API Client and commercetools - Regions.

Cron binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup cron binding create a component of type bindings.cron. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.cron
 version: v1
 metadata:
 - name: schedule
 value: "@every 15m" # valid cron schedule
 - name: direction
 value: "input"

Spec metadata fields

Field	Required	Binding support	Details	Example
`schedule`	Y	Input	The valid cron schedule to use. See this for more details	`"@every 15m"`
`direction`	N	Input	The direction of the binding	`"input"`

Schedule Format

The Dapr cron binding supports following formats:

Apache Dubbo binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up an Apache Dubbo binding, create a component of type bindings.dubbo. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.dubbo
 version: v1
 metadata:
 - name: interfaceName
 value: "com.example.UserService"
 - name: methodName
 value: "getUser"
 # Optional
 - name: version
 value: "1.0.0"
 - name: group
 value: "mygroup"
 - name: providerHostname
 value: "localhost"
 - name: providerPort
 value: "8080"

Note

The Dubbo binding does not require authentication or secret configuration by default. However, if your Dubbo deployment requires secure communication, you can integrate Dapr’s secret store for sensitive values.

Spec metadata fields

Field	Required	Binding support	Details	Example
`interfaceName`	Y	Output	The Dubbo interface name to invoke.	`"com.example.UserService"`
`methodName`	Y	Output	The method name to call on the interface.	`"getUser"`
`version`	N	Output	Version of the Dubbo service.	`"1.0.0"`
`group`	N	Output	Group name for the Dubbo service.	`"mygroup"`
`providerHostname`	N	Output	Hostname of the Dubbo provider.	`"localhost"`
`providerPort`	N	Output	Port of the Dubbo provider.	`"8080"`

Binding support

This component supports output binding with the following operation:

GCP Pub/Sub binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup GCP Pub/Sub binding create a component of type bindings.gcp.pubsub. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.gcp.pubsub
 version: v1
 metadata:
 - name: topic
 value: "topic1"
 - name: subscription
 value: "subscription1"
 - name: type
 value: "service_account"
 - name: project_id
 value: "project_111"
 - name: private_key_id
 value: "*************"
 - name: client_email
 value: "name@domain.com"
 - name: client_id
 value: "1111111111111111"
 - name: auth_uri
 value: "https://accounts.google.com/o/oauth2/auth"
 - name: token_uri
 value: "https://oauth2.googleapis.com/token"
 - name: auth_provider_x509_cert_url
 value: "https://www.googleapis.com/oauth2/v1/certs"
 - name: client_x509_cert_url
 value: "https://www.googleapis.com/robot/v1/metadata/x509/<project-name>.iam.gserviceaccount.com"
 - name: private_key
 value: "PRIVATE KEY"
 - name: direction
 value: "input, output"

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
`topic`	Y	Output	GCP Pub/Sub topic name	`"topic1"`
`subscription`	N	GCP Pub/Sub subscription name	`"name1"`
`type`	Y	Output	GCP credentials type	`service_account`
`project_id`	Y	Output	GCP project id	`projectId`
`private_key_id`	N	Output	GCP private key id	`"privateKeyId"`
`private_key`	Y	Output	GCP credentials private key. Replace with x509 cert	`12345-12345`
`client_email`	Y	Output	GCP client email	`"client@email.com"`
`client_id`	N	Output	GCP client id	`0123456789-0123456789`
`auth_uri`	N	Output	Google account OAuth endpoint	`https://accounts.google.com/o/oauth2/auth`
`token_uri`	N	Output	Google account token uri	`https://oauth2.googleapis.com/token`
`auth_provider_x509_cert_url`	N	Output	GCP credentials cert url	`https://www.googleapis.com/oauth2/v1/certs`
`client_x509_cert_url`	N	Output	GCP credentials project x509 cert url	`https://www.googleapis.com/robot/v1/metadata/x509/<PROJECT_NAME>.iam.gserviceaccount.com`
`direction`	N	Input/Output	The direction of the binding.	`"input"`, `"output"`, `"input, output"`

Binding support

This component supports both input and output binding interfaces.

GCP Storage Bucket binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup GCP Storage Bucket binding create a component of type bindings.gcp.bucket. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.gcp.bucket
 version: v1
 metadata:
 - name: bucket
 value: "mybucket"
 - name: type
 value: "service_account"
 - name: project_id
 value: "project_111"
 - name: private_key_id
 value: "*************"
 - name: client_email
 value: "name@domain.com"
 - name: client_id
 value: "1111111111111111"
 - name: auth_uri
 value: "https://accounts.google.com/o/oauth2/auth"
 - name: token_uri
 value: "https://oauth2.googleapis.com/token"
 - name: auth_provider_x509_cert_url
 value: "https://www.googleapis.com/oauth2/v1/certs"
 - name: client_x509_cert_url
 value: "https://www.googleapis.com/robot/v1/metadata/x509/<project-name>.iam.gserviceaccount.com"
 - name: private_key
 value: "PRIVATE KEY"
 - name: decodeBase64
 value: "<bool>"
 - name: encodeBase64
 value: "<bool>"
 - name: contentType
 value: "<string>"

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
`bucket`	Y	Output	The bucket name	`"mybucket"`
`project_id`	Y	Output	GCP project ID	`projectId`
`type`	N	Output	The GCP credentials type	`"service_account"`
`private_key_id`	N	Output	If using explicit credentials, this field should contain the `private_key_id` field from the service account json document	`"privateKeyId"`
`private_key`	N	Output	If using explicit credentials, this field should contain the `private_key` field from the service account json. Replace with x509 cert	`12345-12345`
`client_email`	N	Output	If using explicit credentials, this field should contain the `client_email` field from the service account json	`"client@email.com"`
`client_id`	N	Output	If using explicit credentials, this field should contain the `client_id` field from the service account json	`0123456789-0123456789`
`auth_uri`	N	Output	If using explicit credentials, this field should contain the `auth_uri` field from the service account json	`https://accounts.google.com/o/oauth2/auth`
`token_uri`	N	Output	If using explicit credentials, this field should contain the `token_uri` field from the service account json	`https://oauth2.googleapis.com/token`
`auth_provider_x509_cert_url`	N	Output	If using explicit credentials, this field should contain the `auth_provider_x509_cert_url` field from the service account json	`https://www.googleapis.com/oauth2/v1/certs`
`client_x509_cert_url`	N	Output	If using explicit credentials, this field should contain the `client_x509_cert_url` field from the service account json	`https://www.googleapis.com/robot/v1/metadata/x509/<PROJECT_NAME>.iam.gserviceaccount.com`
`decodeBase64`	N	Output	Configuration to decode base64 file content before saving to bucket storage. (In case of saving a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false`	`true`, `false`
`encodeBase64`	N	Output	Configuration to encode base64 file content before return the content. (In case of opening a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false`	`true`, `false`
`contentType`	N	Output	The MIME type to set for objects created in the bucket. If not specified, GCP attempts to auto-detect the content type.	`"text/csv"`, `"application/json"`, `"image/png"`

GCP Credentials

Since the GCP Storage Bucket component uses the GCP Go Client Libraries, by default it authenticates using Application Default Credentials. This is explained further in the Authenticate to GCP Cloud services using client libraries guide. Also, see how to Set up Application Default Credentials.

GraphQL binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup GraphQL binding create a component of type bindings.graphql. See this guide on how to create and apply a binding configuration. To separate normal config settings (e.g. endpoint) from headers, “header:” is used a prefix on the header names.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: example.bindings.graphql
spec:
 type: bindings.graphql
 version: v1
 metadata:
 - name: endpoint
 value: "http://localhost:8080/v1/graphql"
 - name: header:x-hasura-access-key
 value: "adminkey"
 - name: header:Cache-Control
 value: "no-cache"

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
`endpoint`	Y	Output	GraphQL endpoint string See here for more details	`"http://localhost:4000/graphql/graphql"`
`header:[HEADERKEY]`	N	Output	GraphQL header. Specify the header key in the `name`, and the header value in the `value`.	`"no-cache"` (see above)
`variable:[VARIABLEKEY]`	N	Output	GraphQL query variable. Specify the variable name in the `name`, and the variable value in the `value`.	`"123"` (see below)

Endpoint and Header format

The GraphQL binding uses GraphQL client internally.

HTTP binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Alternative

The service invocation API allows invoking non-Dapr HTTP endpoints and is the recommended approach. Read “How-To: Invoke Non-Dapr Endpoints using HTTP” for more information.

Setup Dapr component

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.http
 version: v1
 metadata:
 - name: url
 value: "http://something.com"
 #- name: maxResponseBodySize
 # value: "100Mi" # OPTIONAL maximum amount of data to read from a response
 #- name: MTLSRootCA
 # value: "/Users/somepath/root.pem" # OPTIONAL path to root CA or PEM-encoded string
 #- name: MTLSClientCert
 # value: "/Users/somepath/client.pem" # OPTIONAL path to client cert or PEM-encoded string
 #- name: MTLSClientKey
 # value: "/Users/somepath/client.key" # OPTIONAL path to client key or PEM-encoded string
 #- name: MTLSRenegotiation
 # value: "RenegotiateOnceAsClient" # OPTIONAL one of: RenegotiateNever, RenegotiateOnceAsClient, RenegotiateFreelyAsClient
 #- name: securityToken # OPTIONAL <token to include as a header on HTTP requests>
 # secretKeyRef:
 # name: mysecret
 # key: "mytoken"
 #- name: securityTokenHeader
 # value: "Authorization: Bearer" # OPTIONAL <header name for the security token>
 #- name: errorIfNot2XX
 # value: "false" # OPTIONAL

Spec metadata fields

Field	Required	Binding support	Details	Example
`url`	Y	Output	The base URL of the HTTP endpoint to invoke	`http://host:port/path`, `http://myservice:8000/customers`
`maxResponseBodySize`	N	Output	Maximum length of the response to read. A whole number is interpreted as bytes; units such as `Ki, Mi, Gi` (SI) or `k	M
`MTLSRootCA`	N	Output	Path to root CA certificate or PEM-encoded string
`MTLSClientCert`	N	Output	Path to client certificate or PEM-encoded string
`MTLSClientKey`	N	Output	Path client private key or PEM-encoded string
`MTLSRenegotiation`	N	Output	Type of mTLS renegotiation to be used	`RenegotiateOnceAsClient`
`securityToken`	N	Output	The value of a token to be added to a HTTP request as a header. Used together with `securityTokenHeader`
`securityTokenHeader`	N	Output	The name of the header for `securityToken` on a HTTP request
`errorIfNot2XX`	N	Output	If a binding error should be thrown when the response is not in the 2xx range. Defaults to `true`

The values for MTLSRootCA, MTLSClientCert and MTLSClientKey can be provided in three ways:

Huawei OBS binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Huawei Object Storage Service (OBS) (output) binding create a component of type bindings.huawei.obs. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.huawei.obs
 version: v1
 - name: bucket
 value: "<your-bucket-name>"
 - name: endpoint
 value: "<obs-bucket-endpoint>"
 - name: accessKey
 value: "<your-access-key>"
 - name: secretKey
 value: "<your-secret-key>"
 # optional fields
 - name: region
 value: "<your-bucket-region>"

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
`bucket`	Y	Output	The name of the Huawei OBS bucket to write to	`"My-OBS-Bucket"`
`endpoint`	Y	Output	The specific Huawei OBS endpoint	`"obs.cn-north-4.myhuaweicloud.com"`
`accessKey`	Y	Output	The Huawei Access Key (AK) to access this resource	`"************"`
`secretKey`	Y	Output	The Huawei Secret Key (SK) to access this resource	`"************"`
`region`	N	Output	The specific Huawei region of the bucket	`"cn-north-4"`

Binding support

This component supports output binding with the following operations:

InfluxDB binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup InfluxDB binding create a component of type bindings.influx. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.influx
 version: v1
 metadata:
 - name: url # Required
 value: "<INFLUX-DB-URL>"
 - name: token # Required
 value: "<TOKEN>"
 - name: org # Required
 value: "<ORG>"
 - name: bucket # Required
 value: "<BUCKET>"

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 URL for the InfluxDB instance	`"http://localhost:8086"`
`token`	Y	Output	The authorization token for InfluxDB	`"mytoken"`
`org`	Y	Output	The InfluxDB organization	`"myorg"`
`bucket`	Y	Output	Bucket name to write to	`"mybucket"`

Binding support

This component supports output binding with the following operations:

Kafka binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Kafka binding create a component of type bindings.kafka. See this guide on how to create and apply a binding configuration. For details on using secretKeyRef, see the guide on how to reference secrets in components.

All component metadata field values can carry templated metadata values, which are resolved on Dapr sidecar startup. For example, you can choose to use {namespace} as the consumerGroup, to enable using the same appId in different namespaces using the same topics as described in this article.

Kitex

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The binding for Kitex mainly utilizes the generic-call feature in Kitex. Learn more from the official documentation around Kitex generic-call. Currently, Kitex only supports Thrift generic calls. The implementation integrated into components-contrib adopts binary generic calls.

Component format

To setup an Kitex binding, create a component of type bindings.kitex. See the How-to: Use output bindings to interface with external resources guide on creating and applying a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: bindings.kitex
spec:
 type: bindings.kitex
 version: v1
 metadata: 
 - name: hostPorts
 value: "127.0.0.1:8888"
 - name: destService
 value: "echo"
 - name: methodName
 value: "echo"
 - name: version
 value: "0.5.0"

Spec metadata fields

The InvokeRequest.Metadata for bindings.kitex requires the client to fill in four required items when making a call:

KubeMQ binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup KubeMQ binding create a component of type bindings.kubemq. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: binding-topic
spec:
 type: bindings.kubemq
 version: v1
 metadata:
 - name: address
 value: "localhost:50000"
 - name: channel
 value: "queue1"
 - name: direction
 value: "input, output"

Spec metadata fields

Field	Required	Details	Example
`address`	Y	Address of the KubeMQ server	`"localhost:50000"`
`channel`	Y	The Queue channel name	`"queue1"`
`authToken`	N	Auth JWT token for connection. Check out KubeMQ Authentication	`"ew..."`
`autoAcknowledged`	N	Sets if received queue message is automatically acknowledged	`"true"` or `"false"` (default is `"false"`)
`pollMaxItems`	N	Sets the number of messages to poll on every connection	`"1"`
`pollTimeoutSeconds`	N	Sets the time in seconds for each poll interval	`"3600"`
`direction`	N	The direction of the binding	`"input"`, `"output"`, `"input, output"`

Binding support

This component supports both input and output binding interfaces.

Kubernetes Events binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Kubernetes Events binding create a component of type bindings.kubernetes. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.kubernetes
 version: v1
 metadata:
 - name: namespace
 value: "<NAMESPACE>"
 - name: resyncPeriodInSec
 value: "<seconds>"
 - name: direction
 value: "input"

Spec metadata fields

Field	Required	Binding support	Details	Example
`namespace`	Y	Input	The Kubernetes namespace to read events from	`"default"`
`resyncPeriodInSec`	N	Input	The period of time to refresh event list from Kubernetes API server. Defaults to `"10"`	`"15"`
`direction`	N	Input	The direction of the binding	`"input"`
`kubeconfigPath`	N	Input	The path to the kubeconfig file. If not specified, the binding uses the default in-cluster config value	`"/path/to/kubeconfig"`

Binding support

This component supports input binding interface.

Local Storage binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up the Local Storage binding, create a component of type bindings.localstorage. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.localstorage
 version: v1
 metadata:
 - name: rootPath
 value: "<string>"

Spec metadata fields

Field	Required	Binding support	Details	Example
`rootPath`	Y	Output	The root path anchor to which files can be read / saved	`"/temp/files"`

Binding support

This component supports output binding with the following operations:

MQTT3 binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup a MQTT3 binding create a component of type bindings.mqtt3. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.mqtt3
 version: v1
 metadata:
 - name: url
 value: "tcp://[username][:password]@host.domain[:port]"
 - name: topic
 value: "mytopic"
 - name: consumerID
 value: "myapp"
 # Optional
 - name: retain
 value: "false"
 - name: cleanSession
 value: "false"
 - name: backOffMaxRetries
 value: "0"
 - name: direction
 value: "input, output"

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	Input/Output	Address of the MQTT broker. Can be `secretKeyRef` to use a secret reference. Use the `tcp://` URI scheme for non-TLS communication. Use the `ssl://` URI scheme for TLS communication.	`"tcp://[username][:password]@host.domain[:port]"`
`topic`	Y	Input/Output	The topic to listen on or send events to.	`"mytopic"`
`consumerID`	Y	Input/Output	The client ID used to connect to the MQTT broker.	`"myMqttClientApp"`
`retain`	N	Input/Output	Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`.	`"true"`, `"false"`
`cleanSession`	N	Input/Output	Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"`. Defaults to `"false"`.	`"true"`, `"false"`
`caCert`	Required for using TLS	Input/Output	Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates.	See example below
`clientCert`	Required for using TLS	Input/Output	TLS client certificate in PEM format. Must be used with `clientKey`.	See example below
`clientKey`	Required for using TLS	Input/Output	TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference.	See example below
`backOffMaxRetries`	N	Input	The maximum number of retries to process the message before returning an error. Defaults to `"0"`, which means that no retries will be attempted. `"-1"` can be specified to indicate that messages should be retried indefinitely until they are successfully processed or the application is shutdown. The component will wait 5 seconds between retries.	`"3"`
`direction`	N	Input/Output	The direction of the binding	`"input"`, `"output"`, `"input, output"`

Communication using TLS

To configure communication using TLS, ensure that the MQTT broker (e.g. emqx) is configured to support certificates and provide the caCert, clientCert, clientKey metadata in the component configuration. For example:

MySQL & MariaDB binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

The MySQL binding allows connecting to both MySQL and MariaDB databases. In this document, we refer to “MySQL” to indicate both databases.

To setup a MySQL binding create a component of type bindings.mysql. See this guide on how to create and apply a binding configuration.

The MySQL binding uses Go-MySQL-Driver internally.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.mysql
 version: v1
 metadata:
 - name: url # Required, define DB connection in DSN format
 value: "<CONNECTION_STRING>"
 - name: pemPath # Optional
 value: "<PEM PATH>"
 - name: maxIdleConns
 value: "<MAX_IDLE_CONNECTIONS>"
 - name: maxOpenConns
 value: "<MAX_OPEN_CONNECTIONS>"
 - name: connMaxLifetime
 value: "<CONNECTION_MAX_LIFE_TIME>"
 - name: connMaxIdleTime
 value: "<CONNECTION_MAX_IDLE_TIME>"

Warning

The above example uses secrets as plain strings. It is recommended to use a secret store for the secrets as described here. Note that you can not use secret just for username/password. If you use secret, it has to be for the complete connection string.

Spec metadata fields

Field	Required	Binding support	Details	Example
`url`	Y	Output	Represent DB connection in Data Source Name (DNS) format. See here SSL details	`"user:password@tcp(localhost:3306)/dbname"`
`pemPath`	Y	Output	Path to the PEM file. Used with SSL connection	`"path/to/pem/file"`
`maxIdleConns`	N	Output	The max idle connections. Integer greater than 0	`"10"`
`maxOpenConns`	N	Output	The max open connections. Integer greater than 0	`"10"`
`connMaxLifetime`	N	Output	The max connection lifetime. Duration string	`"12s"`
`connMaxIdleTime`	N	Output	The max connection idle time. Duration string	`"12s"`

SSL connection

If your server requires SSL your connection string must end of &tls=custom for example:

PostgreSQL binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup PostgreSQL binding create a component of type bindings.postgresql. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.postgresql
 version: v1
 metadata:
 # Connection string
 - name: connectionString
 value: "<CONNECTION STRING>"

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

Authenticate using a connection string

The following metadata options are required to authenticate using a PostgreSQL connection string.

Postmark binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Postmark binding create a component of type bindings.postmark. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: postmark
spec:
 type: bindings.postmark
 metadata:
 - name: accountToken
 value: "YOUR_ACCOUNT_TOKEN" # required, this is your Postmark account token
 - name: serverToken
 value: "YOUR_SERVER_TOKEN" # required, this is your Postmark server token
 - name: emailFrom
 value: "testapp@dapr.io" # optional
 - name: emailTo
 value: "dave@dapr.io" # optional
 - name: subject
 value: "Hello!" # optional

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
`accountToken`	Y	Output	The Postmark account token, this should be considered a secret value	`"account token"`
`serverToken`	Y	Output	The Postmark server token, this should be considered a secret value	`"server token"`
`emailFrom`	N	Output	If set this specifies the ‘from’ email address of the email message	`"me@exmaple.com"`
`emailTo`	N	Output	If set this specifies the ’to’ email address of the email message	`"me@example.com"`
`emailCc`	N	Output	If set this specifies the ‘cc’ email address of the email message	`"me@example.com"`
`emailBcc`	N	Output	If set this specifies the ‘bcc’ email address of the email message	`"me@example.com"`
`subject`	N	Output	If set this specifies the subject of the email message	`"me@example.com"`

You can specify any of the optional metadata properties on the output binding request too (e.g. emailFrom, emailTo, subject, etc.)

RabbitMQ binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup RabbitMQ binding create a component of type bindings.rabbitmq. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.rabbitmq
 version: v1
 metadata:
 - name: queueName
 value: "queue1"
 - name: host
 value: "amqp://[username][:password]@host.domain[:port]"
 - name: durable
 value: "true"
 - name: deleteWhenUnused
 value: "false"
 - name: ttlInSeconds
 value: "60"
 - name: prefetchCount
 value: "0"
 - name: exclusive
 value: "false"
 - name: maxPriority
 value: "5"
 - name: contentType
 value: "text/plain"
 - name: reconnectWaitInSeconds
 value: "5"
 - name: externalSasl
 value: "false"
 - name: caCert
 value: "null"
 - name: clientCert
 value: "null"
 - name: clientKey
 value: "null"
 - name: direction 
 value: "input, output"

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

When a new RabbitMQ message gets published, all values from the associated metadata are added to the message’s header values.

Redis binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Redis binding create a component of type bindings.redis. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.redis
 version: v1
 metadata:
 - name: redisHost
 value: "<address>:6379"
 - name: redisPassword
 value: "**************"
 - name: useEntraID
 value: "true"
 - name: enableTLS
 value: "<bool>"

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
`redisHost`	Y	Output	Connection-string for the redis host. If `"redisType"` is `"cluster"`, it can be multiple hosts separated by commas or just a single host. When using Redis Sentinel (`"failover"` is `"true"`), multiple sentinel addresses can also be provided as comma-separated values.	`localhost:6379`, `redis-master.default.svc.cluster.local:6379`, `sentinel1:26379,sentinel2:26379,sentinel3:26379`
`redisPassword`	N	Output	The Redis password	`"password"`
`redisUsername`	N	Output	Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly.	`"username"`
`useEntraID`	N	Output	Implements EntraID support for Azure Cache for Redis. Before enabling this: The `redisHost` name must be specified in the form of `"server:port"` TLS must be enabled Learn more about this setting under Create a Redis instance > Azure Cache for Redis	`"true"`, `"false"`
`enableTLS`	N	Output	If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"`	`"true"`, `"false"`
`clientCert`	N	Output	The content of the client certificate, used for Redis instances that require client-side certificates. Must be used with `clientKey` and `enableTLS` must be set to true. It is recommended to use a secret store as described here	`"----BEGIN CERTIFICATE-----\nMIIC..."`
`clientKey`	N	Output	The content of the client private key, used in conjunction with `clientCert` for authentication. It is recommended to use a secret store as described here	`"----BEGIN PRIVATE KEY-----\nMIIE..."`
`failover`	N	Output	Property to enable failover configuration. Needs sentinelMasterName to be set. When enabled, redisHost should contain the sentinel addresses. Defaults to `"false"`	`"true"`, `"false"`
`sentinelMasterName`	N	Output	The sentinel master name. See Redis Sentinel Documentation	`""`, `"mymaster"`
`sentinelUsername`	N	Output	Username for Redis Sentinel. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled	`"username"`
`sentinelPassword`	N	Output	Password for Redis Sentinel. Applicable only when “failover” is true, and Redis Sentinel has authentication enabled	`"password"`
`redeliverInterval`	N	Output	The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery.	`"30s"`
`processingTimeout`	N	Output	The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery.	`"30s"`
`redisType`	N	Output	The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`.	`"cluster"`
`redisDB`	N	Output	Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`.	`"0"`
`redisMaxRetries`	N	Output	Maximum number of times to retry commands before giving up. Default is to not retry failed commands.	`"5"`
`redisMinRetryInterval`	N	Output	Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff.	`"8ms"`
`redisMaxRetryInterval`	N	Output	Maximum backoff for redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff.	`"5s"`
`dialTimeout`	N	Output	Dial timeout for establishing new connections. Defaults to `"5s"`.	`"5s"`
`readTimeout`	N	Output	Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout.	`"3s"`
`writeTimeout`	N	Output	Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout.	`"3s"`
`poolSize`	N	Output	Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU.	`"20"`
`poolTimeout`	N	Output	Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second.	`"5s"`
`maxConnAge`	N	Output	Connection age at which the client retires (closes) the connection. Default is to not close aged connections.	`"30m"`
`minIdleConns`	N	Output	Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`.	`"2"`
`idleCheckFrequency`	N	Output	Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper.	`"-1"`
`idleTimeout`	N	Output	Amount of time after which the client closes idle connections. Should be less than server’s timeout. Default is `"5m"`. `"-1"` disables idle timeout check.	`"10m"`

Binding support

This component supports output binding with the following operations:

RethinkDB binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

The RethinkDB state store supports transactions which means it can be used to support Dapr actors. Dapr persists only the actor’s current state which doesn’t allow the users to track how actor’s state may have changed over time.

To enable users to track change of the state of actors, this binding leverages RethinkDB’s built-in capability to monitor RethinkDB table and event on change with both the old and new state. This binding creates a subscription on the Dapr state table and streams these changes using the Dapr input binding interface.

Apache RocketMQ binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up an Apache RocketMQ binding, create a component of type bindings.rocketmq.
See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.rocketmq
 version: v1
 metadata:
 - name: accessProto
 value: "tcp"
 - name: nameServer
 value: "localhost:9876"
 - name: endpoint
 value: "http://localhost:8080"
 - name: topics
 value: "topic1,topic2"
 - name: consumerGroup
 value: "my-consumer-group"
 # Optional
 - name: consumerBatchSize
 value: "10"
 - name: consumerThreadNums
 value: "4"
 - name: retries
 value: "3"
 - name: instanceId
 value: "my-instance"

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
`topics`	Y	Input/Output	Comma-separated list of topics for publishing or subscribing.	`"topic1,topic2"`
`nameServer`	N	Input/Output	Address of the RocketMQ name server.	`"localhost:9876"`
`endpoint`	N	Input/Output	RocketMQ endpoint (for `http` protocol).	`"http://localhost:8080"`
`accessProto`	N	Input/Output	SDK protocol for connecting to RocketMQ.	`"tcp"`, `"tcp-cgo"`, `"http"`
`consumerGroup`	N	Input/Output	Consumer group name for RocketMQ subscribers.	`"my-consumer-group"`
`consumerBatchSize`	N	Input	Batch size for consuming messages.	`"10"`
`consumerThreadNums`	N	Input	Number of consumer threads (for `tcp-cgo` protocol).	`"4"`
`instanceId`	N	Input/Output	RocketMQ namespace instance ID.	`"my-instance"`
`nameServerDomain`	N	Input/Output	Domain name for the RocketMQ name server.	`"rocketmq.example.com"`
`retries`	N	Input/Output	Number of retry attempts to connect to the RocketMQ broker.	`"3"`
`accessKey`	N	Input/Output	Access key for authentication. Required if access control is enabled.	`"access-key"`
`secretKey`	N	Input/Output	Secret key for authentication. Required if access control is enabled.	`"secret-key"`

Note: accessKey and secretKey can be stored in a Dapr secret store instead of the YAML file for improved security.

SFTP binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To set up the SFTP binding, create a component of type bindings.sftp. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.sftp
 version: v1
 metadata:
 - name: rootPath
 value: "<string>"
 - name: address
 value: "<string>"
 - name: username
 value: "<string>"
 - name: password
 value: "*****************"
 - name: privateKey
 value: "*****************"
 - name: privateKeyPassphrase
 value: "*****************"
 - name: hostPublicKey
 value: "*****************"
 - name: knownHostsFile
 value: "<string>"
 - name: insecureIgnoreHostKey
 value: "<bool>"
 - name: sequentialMode
 value: "<bool>"

Spec metadata fields

Field	Required	Binding support	Details	Example
`rootPath`	Y	Output	Root path for default working directory	`"/path"`
`address`	Y	Output	Address of SFTP server	`"localhost:22"`
`username`	Y	Output	Username for authentication	`"username"`
`password`	N	Output	Password for username/password authentication	`"password"`
`privateKey`	N	Output	Private key for public key authentication	"\|- —–BEGIN OPENSSH PRIVATE KEY—– ***************** —–END OPENSSH PRIVATE KEY—–"
`privateKeyPassphrase`	N	Output	Private key passphrase for public key authentication	`"passphrase"`
`hostPublicKey`	N	Output	Host public key for host validation	`"ecdsa-sha2-nistp256 *** root@openssh-server"`
`knownHostsFile`	N	Output	Known hosts file for host validation	`"/path/file"`
`insecureIgnoreHostKey`	N	Output	Allows to skip host validation. Defaults to `"false"`	`"true"`, `"false"`
`sequentialMode`	N	Output	Used to specify if multiple concurrent operations are allowed within a single SFTP connection. Set this this to true to prevent concurrent operations that might confuse strict SFTP servers. Defaults to `"false"`	`"true"`, `"false"`

Binding support

This component supports output binding with the following operations:

SMTP binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup SMTP binding create a component of type bindings.smtp. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: smtp
spec:
 type: bindings.smtp
 version: v1
 metadata:
 - name: host
 value: "smtp host"
 - name: port
 value: "smtp port"
 - name: user
 value: "username"
 - name: password
 value: "password"
 - name: skipTLSVerify
 value: true|false
 - name: emailFrom
 value: "sender@example.com"
 - name: emailTo
 value: "receiver@example.com"
 - name: emailCC
 value: "cc@example.com"
 - name: emailBCC
 value: "bcc@example.com"
 - name: subject
 value: "subject"
 - name: priority
 value: "[value 1-5]"

Warning

The example configuration shown above, contain a username and password as plain-text strings. It is recommended to use a secret store for the secrets as described here.

Spec metadata fields

Field	Required	Binding support	Details	Example
`host`	Y	Output	The host where your SMTP server runs	`"smtphost"`
`port`	Y	Output	The port your SMTP server listens on	`"9999"`
`user`	Y	Output	The user to authenticate against the SMTP server	`"user"`
`password`	Y	Output	The password of the user	`"password"`
`skipTLSVerify`	N	Output	If set to true, the SMPT server’s TLS certificate will not be verified. Defaults to `"false"`	`"true"`, `"false"`
`emailFrom`	N	Output	If set, this specifies the email address of the sender. See also	`"me@example.com"`
`emailTo`	N	Output	If set, this specifies the email address of the receiver. See also	`"me@example.com"`
`emailCc`	N	Output	If set, this specifies the email address to CC in. See also	`"me@example.com"`
`emailBcc`	N	Output	If set, this specifies email address to BCC in. See also	`"me@example.com"`
`subject`	N	Output	If set, this specifies the subject of the email message. See also	`"subject of mail"`
`priority`	N	Output	If set, this specifies the priority (X-Priority) of the email message, from 1 (lowest) to 5 (highest) (default value: 3). See also	`"1"`

Binding support

This component supports output binding with the following operations:

Twilio SendGrid binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Twilio SendGrid binding create a component of type bindings.twilio.sendgrid. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: sendgrid
spec:
 type: bindings.twilio.sendgrid
 version: v1
 metadata:
 - name: emailFrom
 value: "testapp@dapr.io" # optional
 - name: emailFromName
 value: "test app" # optional
 - name: emailTo
 value: "dave@dapr.io" # optional
 - name: emailToName
 value: "dave" # optional
 - name: subject
 value: "Hello!" # optional
 - name: emailCc
 value: "jill@dapr.io" # optional
 - name: emailBcc
 value: "bob@dapr.io" # optional
 - name: dynamicTemplateId
 value: "d-123456789" # optional
 - name: dynamicTemplateData
 value: '{"customer":{"name":"John Smith"}}' # optional
 - name: apiKey
 value: "YOUR_API_KEY" # required, this is your SendGrid key

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
`apiKey`	Y	Output	SendGrid API key, this should be considered a secret value	`"apikey"`
`emailFrom`	N	Output	If set this specifies the ‘from’ email address of the email message. Only a single email address is allowed. Optional field, see below	`"me@example.com"`
`emailFromName`	N	Output	If set this specifies the ‘from’ name of the email message. Optional field, see below	`"me"`
`emailTo`	N	Output	If set this specifies the ’to’ email address of the email message. Only a single email address is allowed. Optional field, see below	`"me@example.com"`
`emailToName`	N	Output	If set this specifies the ’to’ name of the email message. Optional field, see below	`"me"`
`emailCc`	N	Output	If set this specifies the ‘cc’ email address of the email message. Only a single email address is allowed. Optional field, see below	`"me@example.com"`
`emailBcc`	N	Output	If set this specifies the ‘bcc’ email address of the email message. Only a single email address is allowed. Optional field, see below	`"me@example.com"`
`subject`	N	Output	If set this specifies the subject of the email message. Optional field, see below	`"subject of the email"`

Binding support

This component supports output binding with the following operations:

Twilio SMS binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Twilio SMS binding create a component of type bindings.twilio.sms. See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.twilio.sms
 version: v1
 metadata:
 - name: toNumber # required.
 value: "111-111-1111"
 - name: fromNumber # required.
 value: "222-222-2222"
 - name: accountSid # required.
 value: "*****************"
 - name: authToken # required.
 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
`toNumber`	Y	Output	The target number to send the sms to	`"111-111-1111"`
`fromNumber`	Y	Output	The sender phone number	`"222-222-2222"`
`accountSid`	Y	Output	The Twilio account SID	`"account sid"`
`authToken`	Y	Output	The Twilio auth token	`"auth token"`

Binding support

This component supports output binding with the following operations:

Wasm

Mon, 01 Jan 0001 00:00:00 +0000

Overview

With WebAssembly, you can safely run code compiled in other languages. Runtimes execute WebAssembly Modules (Wasm), which are most often binaries with a .wasm extension.

The Wasm Binding allows you to invoke a program compiled to Wasm by passing commandline args or environment variables to it, similar to how you would with a normal subprocess. For example, you can satisfy an invocation using Python, even though Dapr is written in Go and is running on a platform that doesn’t have Python installed!

Zeebe command binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Zeebe command binding create a component of type bindings.zeebe.command. See this guide on how to create and apply a binding configuration.

See this for Zeebe documentation.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.zeebe.command
 version: v1
 metadata:
 - name: gatewayAddr
 value: "<host>:<port>"
 - name: gatewayKeepAlive
 value: "45s"
 - name: usePlainTextConnection
 value: "true"
 - name: caCertificatePath
 value: "/path/to/ca-cert"

Spec metadata fields

Field	Required	Binding support	Details	Example
`gatewayAddr`	Y	Output	Zeebe gateway address	`"localhost:26500"`
`gatewayKeepAlive`	N	Output	Sets how often keep alive messages should be sent to the gateway. Defaults to 45 seconds	`"45s"`
`usePlainTextConnection`	N	Output	Whether to use a plain text connection or not	`"true"`, `"false"`
`caCertificatePath`	N	Output	The path to the CA cert	`"/path/to/ca-cert"`

Binding support

This component supports output binding with the following operations:

Zeebe JobWorker binding spec

Mon, 01 Jan 0001 00:00:00 +0000

Component format

To setup Zeebe JobWorker binding create a component of type bindings.zeebe.jobworker. See this guide on how to create and apply a binding configuration.

See this for Zeebe JobWorker documentation.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.zeebe.jobworker
 version: v1
 metadata:
 - name: gatewayAddr
 value: "<host>:<port>"
 - name: gatewayKeepAlive
 value: "45s"
 - name: usePlainTextConnection
 value: "true"
 - name: caCertificatePath
 value: "/path/to/ca-cert"
 - name: workerName
 value: "products-worker"
 - name: workerTimeout
 value: "5m"
 - name: requestTimeout
 value: "15s"
 - name: jobType
 value: "fetch-products"
 - name: maxJobsActive
 value: "32"
 - name: concurrency
 value: "4"
 - name: pollInterval
 value: "100ms"
 - name: pollThreshold
 value: "0.3"
 - name: fetchVariables
 value: "productId, productName, productKey"
 - name: autocomplete
 value: "true"
 - name: retryBackOff
 value: "30s"
 - name: direction
 value: "input"

Spec metadata fields

Field	Required	Binding support	Details	Example
`gatewayAddr`	Y	Input	Zeebe gateway address	`"localhost:26500"`
`gatewayKeepAlive`	N	Input	Sets how often keep alive messages should be sent to the gateway. Defaults to 45 seconds	`"45s"`
`usePlainTextConnection`	N	Input	Whether to use a plain text connection or not	`"true"`, `"false"`
`caCertificatePath`	N	Input	The path to the CA cert	`"/path/to/ca-cert"`
`workerName`	N	Input	The name of the worker activating the jobs, mostly used for logging purposes	`"products-worker"`
`workerTimeout`	N	Input	A job returned after this call will not be activated by another call until the timeout has been reached; defaults to 5 minutes	`"5m"`
`requestTimeout`	N	Input	The request will be completed when at least one job is activated or after the requestTimeout. If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated. Defaults to 10 seconds	`"30s"`
`jobType`	Y	Input	the job type, as defined in the BPMN process (e.g. `<zeebe:taskDefinition type="fetch-products" />`)	`"fetch-products"`
`maxJobsActive`	N	Input	Set the maximum number of jobs which will be activated for this worker at the same time. Defaults to 32	`"32"`
`concurrency`	N	Input	The maximum number of concurrent spawned goroutines to complete jobs. Defaults to 4	`"4"`
`pollInterval`	N	Input	Set the maximal interval between polling for new jobs. Defaults to 100 milliseconds	`"100ms"`
`pollThreshold`	N	Input	Set the threshold of buffered activated jobs before polling for new jobs, i.e. threshold * maxJobsActive. Defaults to 0.3	`"0.3"`
`fetchVariables`	N	Input	A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned	`"productId"`, `"productName"`, `"productKey"`
`autocomplete`	N	Input	Indicates if a job should be autocompleted or not. If not set, all jobs will be auto-completed by default. Disable it if the worker should manually complete or fail the job with either a business error or an incident	`"true"`, `"false"`
`retryBackOff`	N	Input	The back-off timeout for the next retry if a job fails	`15s`
`direction`	N	Input	The direction of the binding	`"input"`

Binding support

This component supports input binding interfaces.