Bindings 组件规格 on Dapr 文档库

Apple 推送通知服务绑定说明

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

组件格式

要配置 Apple 推送通知绑定，请创建一个类型为 bindings.apns 的组件。请参阅本指南了解如何创建和应用绑定配置。

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>"

元数据字段说明

字段	必需	绑定功能支持	详情	示例
`development`	Y	输出	指定使用哪个 APNs 服务。设置为 `"true"` 使用开发服务，或 `"false"` 使用生产服务。默认值：`"true"`	`"true"`
`key-id`	Y	输出	来自 Apple 开发者门户的私钥标识符	`"private-key-id`"
`team-id`	Y	输出	来自 Apple 开发者门户的组织或作者标识符	`"team-id"`
`private-key`	Y	输出	这是一个 PKCS #8 格式的私钥。建议将私钥存储在 secret 存储中，而不是直接在配置中暴露。详情请参见此处	`"pem file"`

私钥

APNS 绑定需要一个加密私钥来生成 APNS 服务的身份验证令牌。私钥可以从 Apple 开发者门户生成，并以 PKCS #8 文件形式提供，存储在 PEM 格式中。建议将私钥存储在 Dapr 的 secret 存储中，而不是直接在绑定的配置文件中。

AWS DynamoDB 绑定说明

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

组件配置格式

要配置 AWS DynamoDB 绑定，请创建一个类型为 bindings.aws.dynamodb 的组件。请参考本指南了解如何创建和应用绑定配置。

有关身份验证相关属性的信息，请参阅身份验证到 AWS

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: "*****************"

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来保存密钥，详情请参阅此处。

规范元数据字段

字段	必需	绑定支持	详情	示例
`table`	Y	输出	DynamoDB 表名	`"items"`
`region`	Y	输出	AWS DynamoDB 实例所在的特定 AWS 区域	`"us-east-1"`
`accessKey`	Y	输出	访问此资源的 AWS 访问密钥	`"key"`
`secretKey`	Y	输出	访问此资源的 AWS 秘密访问密钥	`"secretAccessKey"`
`sessionToken`	N	输出	使用的 AWS 会话令牌	`"sessionToken"`

重要

当在 EKS（AWS Kubernetes）上与应用程序一起运行 Dapr sidecar（daprd）时，如果您使用的节点/Pod 已经附加了定义访问 AWS 资源的 IAM 策略，则不需要在组件配置中提供 AWS 访问密钥、秘密密钥和令牌。

绑定支持

此组件支持具有以下操作的输出绑定：

AWS Kinesis 绑定规范

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

组件格式

要设置 AWS Kinesis 绑定，需创建一个类型为 bindings.aws.kinesis 的组件。请参阅本指南以了解如何创建和应用绑定配置。

请参阅此处以了解如何设置 AWS Kinesis 数据流。请参阅认证到 AWS以获取与认证相关的属性信息。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.aws.kinesis
 version: v1
 metadata:
 - name: streamName
 value: "KINESIS_STREAM_NAME" # Kinesis 流名称
 - name: consumerName
 value: "KINESIS_CONSUMER_NAME" # Kinesis 消费者名称
 - name: mode
 value: "shared" # shared - 共享吞吐量或 extended - 扩展/增强扇出
 - name: region
 value: "AWS_REGION" # 请替换为实际的 AWS 区域
 - name: accessKey
 value: "AWS_ACCESS_KEY" # 请替换为实际的 AWS 访问密钥
 - name: secretKey
 value: "AWS_SECRET_KEY" # 请替换为实际的 AWS 秘密访问密钥
 - name: sessionToken
 value: "*****************"
 - name: direction
 value: "input, output"

警告

上述示例中使用了明文字符串作为 secret。建议使用 secret 存储来存储 secret，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`mode`	否	输入	Kinesis 流模式。`shared`- 共享吞吐量，`extended` - 扩展/增强扇出方法。更多详情请参阅此处。默认为 `"shared"`	`"shared"`, `"extended"`
`streamName`	是	输入/输出	AWS Kinesis 流名称	`"stream"`
`consumerName`	是	输入	AWS Kinesis 消费者名称	`"myconsumer"`
`region`	是	输出	部署 AWS Kinesis 实例的特定 AWS 区域	`"us-east-1"`
`accessKey`	是	输出	访问此资源的 AWS 访问密钥	`"key"`
`secretKey`	是	输出	访问此资源的 AWS 秘密访问密钥	`"secretAccessKey"`
`sessionToken`	否	输出	使用的 AWS 会话令牌	`"sessionToken"`
`direction`	否	输入/输出	绑定的方向	`"input"`, `"output"`, `"input, output"`

重要

在 EKS（AWS Kubernetes）上运行 Dapr sidecar（daprd）与您的应用程序一起时，如果节点/Pod 已附加了定义访问 AWS 资源的 IAM 策略，则不应在组件规范中提供 AWS 访问密钥、秘密密钥和令牌。

绑定支持

此组件支持输入和输出绑定接口。

AWS S3 绑定规范

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

组件格式

要设置 AWS S3 绑定，您需要创建一个类型为 bindings.aws.s3 的组件。此绑定可以与其他兼容 S3 的服务一起使用，例如 Minio。请参阅本指南以了解如何创建和应用绑定配置。

有关身份验证相关属性的信息，请参阅身份验证到 AWS。

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>"

警告

上面的示例中使用了明文字符串作为密钥。建议使用密钥存储来存储密钥，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`bucket`	Y	输出	要写入的 S3 bucket 名称	`"bucket"`
`region`	Y	输出	特定的 AWS 区域	`"us-east-1"`
`endpoint`	N	输出	特定的 AWS 端点	`"s3.us-east-1.amazonaws.com"`
`accessKey`	Y	输出	访问此资源的 AWS 访问密钥	`"key"`
`secretKey`	Y	输出	访问此资源的 AWS secret 访问密钥	`"secretAccessKey"`
`sessionToken`	N	输出	要使用的 AWS 会话令牌	`"sessionToken"`
`forcePathStyle`	N	输出	Amazon S3 SDK 支持虚拟主机样式和路径样式访问。`"true"` 表示路径样式格式，如 `"https://<endpoint>/<your bucket>/<key>"`。`"false"` 表示主机样式格式，如 `"https://<your bucket>.<endpoint>/<key>"`。默认为 `"false"`	`"true"`, `"false"`
`decodeBase64`	N	输出	配置在保存到 bucket 存储之前解码 base64 文件内容。（在保存二进制内容文件的情况下）。`"true"` 是唯一允许的正值。其他正值变体如 `"True", "1"` 不可接受。默认为 `false`	`"true"`, `"false"`
`encodeBase64`	N	输出	配置在返回内容之前对 base64 文件内容进行编码。（在打开二进制内容文件的情况下）。`"true"` 是唯一允许的正值。其他正值变体如 `"True", "1"` 不可接受。默认为 `"false"`	`"true"`, `"false"`
`disableSSL`	N	输出	允许连接到非 `https://` 端点。默认为 `"false"`	`"true"`, `"false"`
`insecureSSL`	N	输出	当连接到 `https://` 端点时，接受无效或自签名证书。默认为 `"false"`	`"true"`, `"false"`
`storageClass`	N	输出	在创建操作期间对象的所需存储类。有效的 AWS 存储类类型可以在此处找到	`STANDARD_IA`

重要

当在 EKS（AWS Kubernetes）上与应用程序一起运行 Dapr sidecar（daprd）时，如果您使用的节点/Pod 已经附加了定义访问 AWS 资源的 IAM 策略，则不得在您使用的组件规范定义中提供 AWS 访问密钥、secret 密钥和令牌。

S3 Bucket 创建

使用 Minio

Minio 是一种将本地存储暴露为兼容 S3 的块存储的服务，尤其在开发环境中是 S3 的流行替代品。您也可以使用 S3 绑定与 Minio 一起使用，只需进行一些配置调整：

AWS SES 绑定说明

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

组件格式

要配置 AWS 绑定，请创建一个类型为 bindings.aws.ses 的组件。有关如何创建和应用绑定配置的详细信息，请参阅本指南。

关于身份验证的更多信息，请参阅身份验证到 AWS。

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"

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来保存密钥，详情请参阅此处。

规范元数据字段

字段	必需	绑定支持	详情	示例
`region`	否	输出	AWS 区域	`"eu-west-1"`
`accessKey`	否	输出	访问资源的 AWS 访问密钥	`"key"`
`secretKey`	否	输出	访问资源的 AWS 秘密访问密钥	`"secretAccessKey"`
`sessionToken`	否	输出	使用的 AWS 会话令牌	`"sessionToken"`
`emailFrom`	否	输出	发件人的电子邮件地址	`"me@example.com"`
`emailTo`	否	输出	收件人的电子邮件地址	`"me@example.com"`
`emailCc`	否	输出	抄送的电子邮件地址	`"me@example.com"`
`emailBcc`	否	输出	密送的电子邮件地址	`"me@example.com"`
`subject`	否	输出	电子邮件的主题	`"subject of mail"`

重要

在 EKS（AWS Kubernetes）上运行 Dapr sidecar（daprd）时，如果节点/Pod 已附加了访问 AWS 资源的 IAM 策略，则不应在组件规范中提供 AWS 访问密钥、秘密密钥和令牌。

绑定支持

此组件支持以下操作的输出绑定：

AWS SNS 绑定组件规范

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

组件格式

要配置 AWS SNS 绑定，请创建一个类型为 bindings.aws.sns 的组件。有关如何创建和应用绑定配置的详细信息，请参阅本指南。

有关身份验证的详细信息，请参阅身份验证到 AWS。

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: "*****************"

警告

上述示例中使用了明文字符串来表示密钥。建议使用密钥存储来管理这些密钥，详情请参阅此处。

规范元数据字段

字段	必需	绑定支持	详情	示例
`topicArn`	是	输出绑定	SNS 主题的 ARN（Amazon Resource Name）	`"arn:::topicarn"`
`region`	是	输出绑定	AWS 的特定区域	`"us-east-1"`
`endpoint`	否	输出绑定	AWS 的特定端点	`"sns.us-east-1.amazonaws.com"`
`accessKey`	是	输出绑定	访问资源的 AWS 访问密钥	`"key"`
`secretKey`	是	输出绑定	访问资源的 AWS 秘密访问密钥	`"secretAccessKey"`
`sessionToken`	否	输出绑定	使用的 AWS 会话令牌	`"sessionToken"`

重要

在 EKS（AWS Kubernetes）上与应用程序一起运行 Dapr sidecar（daprd）时，如果节点/Pod 已附加了访问 AWS 资源的 IAM 策略，则不应在组件规范中提供 AWS 访问密钥、秘密密钥和令牌。

绑定支持

此组件支持以下操作的输出绑定：

AWS SQS 绑定规范

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

组件格式

要设置 AWS SQS 绑定，您需要创建一个类型为 bindings.aws.sqs 的组件。请参考本指南了解如何创建和应用绑定配置。

关于身份验证相关属性的信息，请参阅身份验证到 AWS。

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: accessKey
 value: "*****************"
 - name: secretKey
 value: "*****************"
 - name: sessionToken
 value: "*****************"
 - name: direction 
 value: "input, output"

警告

上述示例使用明文字符串作为密钥。建议使用密钥存储来保存密钥，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`queueName`	Y	输入/输出	SQS 队列名称	`"myqueue"`
`region`	Y	输入/输出	特定的 AWS 区域	`"us-east-1"`
`accessKey`	Y	输入/输出	访问此资源的 AWS 访问密钥	`"key"`
`secretKey`	Y	输入/输出	访问此资源的 AWS 秘密访问密钥	`"secretAccessKey"`
`sessionToken`	N	输入/输出	要使用的 AWS 会话令牌	`"sessionToken"`
`direction`	N	输入/输出	绑定的方向	`"input"`, `"output"`, `"input, output"`

重要

在 EKS（AWS Kubernetes）上与应用程序一起运行 Dapr sidecar（daprd）时，如果您使用的节点/Pod 已经附加了定义访问 AWS 资源的 IAM 策略，则不应在组件规范中提供 AWS 访问密钥、秘密密钥和令牌。

绑定支持

此组件支持输入和输出绑定接口。

Azure Blob Storage 绑定指南

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

组件格式

要配置 Azure Blob Storage 绑定，需创建一个类型为 bindings.azure.blobstorage 的组件。请参考本指南了解如何创建和应用绑定配置。

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>

警告

上述示例中，secret 以明文字符串形式使用。建议使用 secret 存储来保护 secret，具体方法请参见此处。

元数据字段说明

字段	必需	绑定支持	详情	示例
`accountName`	Y	输入/输出	Azure 存储账户的名称	`"myexmapleaccount"`
`accountKey`	Y*	输入/输出	Azure 存储账户的访问密钥。仅在不使用 Microsoft Entra ID 认证时需要。	`"access-key"`
`containerName`	Y	输出	要写入的 Blob Storage 容器的名称	`myexamplecontainer`
`endpoint`	N	输入/输出	可选的自定义端点 URL。这在使用 Azurite 模拟器或使用 Azure 存储的自定义域时很有用（尽管这不是官方支持的）。端点必须是完整的基本 URL，包括协议（`http://` 或 `https://`）、IP 或 FQDN，以及可选端口。	`"http://127.0.0.1:10000"`
`decodeBase64`	N	输出	配置在保存到 Blob Storage 之前解码 base64 文件内容。（在保存具有二进制内容的文件时）。默认为 `false`	`true`, `false`
`getBlobRetryCount`	N	输出	指定在从 RetryReader 读取时将进行的最大 HTTP GET 请求次数。默认为 `10`	`1`, `2`
`publicAccessLevel`	N	输出	指定容器中的数据是否可以公开访问以及访问级别（仅在容器由 Dapr 创建时使用）。默认为 `none`	`blob`, `container`, `none`

Microsoft Entra ID 认证

Azure Blob Storage 绑定组件支持使用所有 Microsoft Entra ID 机制进行认证。有关更多信息以及根据选择的 Microsoft Entra ID 认证机制提供的相关组件元数据字段，请参阅认证到 Azure 的文档。

Azure Cosmos DB (Gremlin API) 绑定组件说明

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

组件格式

要配置 Azure Cosmos DB (Gremlin API) 绑定，请创建一个类型为 bindings.azure.cosmosdb.gremlinapi 的组件。请参阅本指南了解如何创建和应用绑定配置。

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: "*****"

警告

上述示例使用了明文形式的字符串作为密钥。建议使用密钥存储来存储密钥，如此处所述。

规范元数据字段

字段	是否必需	支持的绑定类型	说明	示例
`url`	Y	输出	Gremlin API 的 Cosmos DB URL	`"wss://******.gremlin.cosmos.azure.com:443/"`
`masterKey`	Y	输出	Cosmos DB 账户的主密钥	`"masterKey"`
`username`	Y	输出	Cosmos DB 数据库的用户名	`"/dbs/<database_name>/colls/<graph_name>"`

Azure Cosmos DB (SQL API) 绑定说明

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

组件配置格式

要设置 Azure Cosmos DB 绑定，请创建一个类型为 bindings.azure.cosmosdb 的组件。请参阅本指南了解如何创建和应用绑定配置。

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>"

警告

上述示例中，secret 以明文字符串形式使用。建议使用 secret 存储来存储 secret，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`url`	Y	输出	Cosmos DB 的 URL	`"https://******.documents.azure.com:443/"`
`masterKey`	Y	输出	Cosmos DB 帐户的主密钥	`"master-key"`
`database`	Y	输出	Cosmos DB 数据库的名称	`"OrderDb"`
`collection`	Y	输出	数据库容器的名称。	`"Orders"`
`partitionKey`	Y	输出	从文档负载中提取的分区键的名称。此名称必须与创建 Cosmos DB 容器时指定的分区键一致。	`"OrderId"`, `"message"`

有关更多信息，请参阅 Azure Cosmos DB 资源模型。

Azure Event Grid 绑定规范

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

组件格式

要设置 Azure Event Grid 绑定，需创建一个类型为 bindings.azure.eventgrid 的组件。请参考本指南了解如何创建和应用绑定配置。

有关 Azure Event Grid 的更多信息，请访问此处。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <name>
spec:
 type: bindings.azure.eventgrid
 version: v1
 metadata:
 # 必需的输出绑定元数据
 - name: accessKey
 value: "[AccessKey]"
 - name: topicEndpoint
 value: "[TopicEndpoint]"
 # 必需的输入绑定元数据
 - name: azureTenantId
 value: "[AzureTenantId]"
 - name: azureSubscriptionId
 value: "[AzureSubscriptionId]"
 - name: azureClientId
 value: "[ClientId]"
 - name: azureClientSecret
 value: "[ClientSecret]"
 - name: subscriberEndpoint
 value: "[SubscriberEndpoint]"
 - name: handshakePort
 # 确保以字符串形式传递，值需加上引号
 value: "[HandshakePort]"
 - name: scope
 value: "[Scope]"
 # 可选的输入绑定元数据
 - name: eventSubscriptionName
 value: "[EventSubscriptionName]"
 # 可选元数据
 - name: direction
 value: "input, output"

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来保护密钥，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`accessKey`	Y	输出	用于向自定义主题发布 Event Grid 事件的访问密钥	`"accessKey"`
`topicEndpoint`	Y	输出	此输出绑定应发布事件的主题端点	`"topic-endpoint"`
`azureTenantId`	Y	输入	Event Grid 资源的 Azure 租户 ID	`"tenentID"`
`azureSubscriptionId`	Y	输入	Event Grid 资源的 Azure 订阅 ID	`"subscriptionId"`
`azureClientId`	Y	输入	绑定用于创建或更新 Event Grid 事件订阅并验证传入消息的客户端 ID	`"clientId"`
`azureClientSecret`	Y	输入	绑定用于创建或更新 Event Grid 事件订阅并验证传入消息的客户端密钥	`"clientSecret"`
`subscriberEndpoint`	Y	输入	Webhook 的 HTTPS 端点，Event Grid 将事件（格式化为 Cloud Events）发送到此处。如果您不在入口处重写 URL，则应采用以下格式：`"https://[YOUR HOSTNAME]/<path>"` 如果在本地计算机上进行测试，可以使用类似 ngrok 的工具创建公共端点。	`"https://[YOUR HOSTNAME]/<path>"`
`handshakePort`	Y	输入	输入绑定在接收 Webhook 事件时监听的容器端口	`"9000"`
`scope`	Y	输入	需要创建或更新事件订阅的资源标识符。有关更多详细信息，请参阅范围部分	`"/subscriptions/{subscriptionId}/"`
`eventSubscriptionName`	N	输入	事件订阅的名称。事件订阅名称必须在 3 到 64 个字符之间，并且只能使用字母数字字符	`"name"`
`direction`	N	输入/输出	绑定的方向	`"input"`, `"output"`, `"input, output"`

范围

范围是需要创建或更新事件订阅的资源标识符。范围可以是订阅、资源组、属于资源提供程序命名空间的顶级资源或 Event Grid 主题。例如：

Azure Event Hubs 绑定规范

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

组件格式

要配置 Azure Event Hubs 绑定，需要创建一个类型为 bindings.azure.eventhubs 的组件。请参考本指南了解如何创建和应用绑定配置。

请参考此处了解如何设置 Event Hub。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.azure.eventhubs
 version: v1
 metadata:
 # Hub 名称 ("topic")
 - name: eventHub
 value: "mytopic"
 - name: consumerGroup
 value: "myapp"
 # connectionString 或 eventHubNamespace 必须提供其一
 # 在不使用 Microsoft Entra ID 的情况下，使用 connectionString
 - name: connectionString
 value: "Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"
 # 在使用 Microsoft Entra ID 的情况下，使用 eventHubNamespace
 - name: eventHubNamespace
 value: "namespace"
 - name: enableEntityManagement
 value: "false"
 - name: enableInOrderMessageDelivery
 value: "false"
 # 仅当 enableEntityManagement 设置为 true 时需要以下四个属性
 - name: resourceGroupName
 value: "test-rg"
 - name: subscriptionID
 value: "value of Azure subscription ID"
 - name: partitionCount
 value: "1"
 - name: messageRetentionInDays
 value: "3"
 # 检查点存储属性
 - name: storageAccountName
 value: "myeventhubstorage"
 - name: storageAccountKey
 value: "112233445566778899"
 - name: storageContainerName
 value: "myeventhubstoragecontainer"
 # 传递 storageAccountKey 的替代方法
 - name: storageConnectionString
 value: "DefaultEndpointsProtocol=https;AccountName=<account>;AccountKey=<account-key>"
 # 可选元数据
 - name: direction
 value: "input, output"

警告

上述示例中，secret 以明文字符串形式使用。建议使用 secret 存储，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`eventHub`	Y*	输入/输出	Event Hubs hub 的名称 (“topic”)。如果使用 Microsoft Entra ID 认证或连接字符串不包含 `EntityPath` 值，则必需	`mytopic`
`connectionString`	Y*	输入/输出	Event Hub 或 Event Hub 命名空间的连接字符串。 * 与 `eventHubNamespace` 字段互斥。 * 在不使用 Microsoft Entra ID 认证时必需	`"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"` 或 `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key}"`
`eventHubNamespace`	Y*	输入/输出	Event Hub 命名空间名称。 * 与 `connectionString` 字段互斥。 * 在使用 Microsoft Entra ID 认证时必需	`"namespace"`
`enableEntityManagement`	N	输入/输出	允许管理 EventHub 命名空间和存储账户的布尔值。默认值：`false`	`"true"`, `"false"`
`enableInOrderMessageDelivery`	N	输入/输出	允许消息按发布顺序传递的布尔值。这假设在发布或发送时设置了 `partitionKey` 以确保跨分区的顺序。默认值：`false`	`"true"`, `"false"`
`resourceGroupName`	N	输入/输出	Event Hub 命名空间所属的资源组名称。启用实体管理时必需	`"test-rg"`
`subscriptionID`	N	输入/输出	Azure 订阅 ID 值。启用实体管理时必需	`"azure subscription id"`
`partitionCount`	N	输入/输出	新 Event Hub 命名空间的分区数量。仅在启用实体管理时使用。默认值：`"1"`	`"2"`
`messageRetentionInDays`	N	输入/输出	在新创建的 Event Hub 命名空间中保留消息的天数。仅在启用实体管理时使用。默认值：`"1"`	`"90"`
`consumerGroup`	Y	输入	要监听的 Event Hubs 消费者组的名称	`"group1"`
`storageAccountName`	Y	输入	用于检查点存储的存储账户名称。	`"myeventhubstorage"`
`storageAccountKey`	Y*	输入	检查点存储账户的存储账户密钥。 * 使用 Microsoft Entra ID 时，如果服务主体也有权访问存储账户，可以省略此项。	`"112233445566778899"`
`storageConnectionString`	Y*	输入	检查点存储的连接字符串，指定 `storageAccountKey` 的替代方法	`"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey=<account-key>"`
`storageContainerName`	Y	输入	存储账户名称的存储容器名称。	`"myeventhubstoragecontainer"`
`direction`	N	输入/输出	绑定的方向。	`"input"`, `"output"`, `"input, output"`

Microsoft Entra ID 认证

Azure Event Hubs pub/sub 组件支持使用所有 Microsoft Entra ID 机制进行认证。有关更多信息以及根据选择的 Microsoft Entra ID 认证机制提供的相关组件元数据字段，请参阅认证到 Azure 的文档。

Azure OpenAI 绑定组件规范

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

组件格式

要设置 Azure OpenAI 绑定组件，请创建一个类型为 bindings.azure.openai 的组件。请参阅本指南了解如何创建和应用绑定配置。有关 Azure OpenAI 服务的文档，请参阅此处。

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

警告

上述示例中，apiKey 被直接用作字符串。建议使用密钥存储来保存敏感信息，具体方法请参阅此处。

规范元数据字段

字段	必需	绑定支持	详情	示例
`endpoint`	Y	输出	Azure OpenAI 服务端点的 URL。	`"https://myopenai.openai.azure.com"`
`apiKey`	Y*	输出	Azure OpenAI 服务的访问密钥。仅在不使用 Microsoft Entra ID 认证时需要。	`"1234567890abcdef"`
`azureTenantId`	Y*	输入	Azure OpenAI 资源的租户 ID。仅在未提供 `apiKey` 时需要。	`"tenentID"`
`azureClientId`	Y*	输入	用于创建或更新 Azure OpenAI 订阅并认证传入消息的客户端 ID。仅在未提供 `apiKey` 时需要。	`"clientId"`
`azureClientSecret`	Y*	输入	用于创建或更新 Azure OpenAI 订阅并认证传入消息的客户端密钥。仅在未提供 `apiKey` 时需要。	`"clientSecret"`

Microsoft Entra ID 认证

Azure OpenAI 绑定组件支持使用所有 Microsoft Entra ID 机制进行认证。有关更多信息以及根据选择的 Microsoft Entra ID 认证机制提供的相关组件元数据字段，请参阅认证到 Azure 的文档。

Azure Service Bus Queues 绑定规范

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

组件格式

要设置 Azure Service Bus Queues 绑定，请创建一个类型为 bindings.azure.servicebusqueues 的组件。请参阅本指南了解如何创建和应用绑定配置。

连接字符串认证

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

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来存储这些敏感信息，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`connectionString`	Y	输入/输出	Service Bus 的连接字符串。除非使用 Microsoft Entra ID 认证，否则必需。	`"Endpoint=sb://************"`
`queueName`	Y	输入/输出	Service Bus 的队列名称。队列名称不区分大小写，并将始终强制为小写。	`"queuename"`
`timeoutInSec`	N	输入/输出	对 Azure Service Bus 端点的所有调用的超时时间，以秒为单位。注意，此选项影响网络调用，与应用于消息的 TTL 无关。默认值为 `"60"`	`"60"`
`namespaceName`	N	输入/输出	设置 Service Bus 命名空间地址的参数，作为完全限定的域名。使用 Microsoft Entra ID 认证时必需。	`"namespace.servicebus.windows.net"`
`disableEntityManagement`	N	输入/输出	当设置为 true 时，队列和订阅不会自动创建。默认值为 `"false"`	`"true"`, `"false"`
`lockDurationInSec`	N	输入/输出	定义消息在过期前被锁定的时间长度，以秒为单位。仅在订阅创建期间使用。由服务器设置默认值。	`"30"`
`autoDeleteOnIdleInSec`	N	输入/输出	在自动删除空闲订阅之前等待的时间，以秒为单位。仅在订阅创建期间使用。必须为 300 秒或更长。默认值为 `"0"` (禁用)	`"3600"`
`defaultMessageTimeToLiveInSec`	N	输入/输出	默认消息生存时间，以秒为单位。仅在订阅创建期间使用。	`"10"`
`maxDeliveryCount`	N	输入/输出	定义服务器尝试传递消息的次数。仅在订阅创建期间使用。由服务器设置默认值。	`"10"`
`minConnectionRecoveryInSec`	N	输入/输出	在连接失败的情况下，尝试重新连接到 Azure Service Bus 之前等待的最小间隔（以秒为单位）。默认值为 `"2"`	`"5"`
`maxConnectionRecoveryInSec`	N	输入/输出	在连接失败的情况下，尝试重新连接到 Azure Service Bus 之前等待的最大间隔（以秒为单位）。每次尝试后，组件在最小和最大之间等待一个随机秒数，每次增加。默认值为 `"300"` (5 分钟)	`"600"`
`maxActiveMessages`	N	定义一次处理或在缓冲区中的最大消息数。此值应至少与最大并发处理程序一样大。默认值为 `"1"`	`"1"`
`handlerTimeoutInSec`	N	输入	调用应用程序处理程序的超时时间。默认值为 `"0"` (无超时)	`"30"`
`minConnectionRecoveryInSec`	N	输入	在连接失败的情况下，尝试重新连接到 Azure Service Bus 之前等待的最小间隔（以秒为单位）。默认值为 `"2"`	`"5"`
`maxConnectionRecoveryInSec`	N	输入	在连接失败的情况下，尝试重新连接到 Azure Service Bus 之前等待的最大间隔（以秒为单位）。每次尝试后，绑定在最小和最大之间等待一个随机秒数，每次增加。默认值为 `"300"` (5 分钟)	`"600"`
`lockRenewalInSec`	N	输入	定义缓冲消息锁将被续订的频率。默认值为 `"20"`。	`"20"`
`maxActiveMessages`	N	输入	定义一次处理或在缓冲区中的最大消息数。此值应至少与最大并发处理程序一样大。默认值为 `"1"`	`"2000"`
`maxConcurrentHandlers`	N	输入	定义最大并发消息处理程序数；设置为 `0` 表示无限制。默认值为 `"1"`	`"10"`
`maxRetriableErrorsPerSec`	N	输入	每秒处理的最大可重试错误数。如果消息因可重试错误而无法处理，组件会在开始处理另一条消息之前添加延迟，以避免立即重新处理失败的消息。默认值为 `"10"`	`"10"`
`publishMaxRetries`	N	输出	当 Azure Service Bus 响应“过于繁忙”以限制消息时的最大重试次数。默认值为 `"5"`	`"5"`
`publishInitialRetryIntervalInMs`	N	输出	当 Azure Service Bus 限制消息时，初始指数退避的时间（以毫秒为单位）。默认值为 `"500"`	`"500"`
`direction`	N	输入/输出	绑定的方向	`"input"`, `"output"`, `"input, output"`

Microsoft Entra ID 认证

Azure Service Bus Queues 绑定组件支持使用所有 Microsoft Entra ID 机制进行认证，包括托管身份。有关更多信息以及根据选择的 Microsoft Entra ID 认证机制提供的相关组件元数据字段，请参阅认证到 Azure 的文档。

Azure SignalR 绑定规范

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

组件格式

要配置 Azure SignalR 绑定，请创建一个类型为 bindings.azure.signalr 的组件。请参考本指南了解如何创建和应用绑定配置。

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  # 可选
 value: "<hub name>"

警告

上述示例使用了明文字符串作为 secret。建议使用 secret 存储来存储 secret，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`connectionString`	Y	输出	Azure SignalR 连接字符串	`"Endpoint=https://<your-azure-signalr>.service.signalr.net;AccessKey=<your-access-key>;Version=1.0;"`
`hub`	N	输出	定义消息将发送到的 hub。hub 可以在发布到输出绑定时动态定义为元数据值（键为 “hub”）	`"myhub"`
`endpoint`	N	输出	Azure SignalR 的端点；如果未包含在 `connectionString` 中或使用 Microsoft Entra ID，则必需	`"https://<your-azure-signalr>.service.signalr.net"`
`accessKey`	N	输出	访问密钥	`"your-access-key"`

Microsoft Entra ID 认证

Azure SignalR 绑定组件支持所有 Microsoft Entra ID 认证机制。请参考认证到 Azure 的文档以了解更多关于根据您选择的 Microsoft Entra ID 认证机制的相关组件元数据字段。

Azure Storage Queues 绑定规范

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

组件格式

要配置 Azure Storage Queues 绑定，需创建一个类型为 bindings.azure.storagequeues 的组件。请参考本指南了解如何创建和应用绑定配置。

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: direction 
# value: "input, output"

警告

上述示例中，secret 使用了明文字符串。建议使用 secret 存储，如此处所述。

元数据字段说明

字段	必需	绑定支持	详情	示例
`accountName`	Y	输入/输出	Azure Storage 帐户的名称	`"account1"`
`accountKey`	Y*	输入/输出	Azure Storage 帐户的访问密钥。仅在不使用 Microsoft Entra ID 身份验证时需要。	`"access-key"`
`queueName`	Y	输入/输出	Azure Storage 队列的名称	`"myqueue"`
`pollingInterval`	N	输出	设置轮询 Azure Storage Queues 以获取新消息的间隔，作为 Go 持续时间值。默认值：`"10s"`	`"30s"`
`ttlInSeconds`	N	输出	设置默认消息生存时间的参数。如果省略此参数，消息将在 10 分钟后过期。参见此处	`"60"`
`decodeBase64`	N	输入	配置将从 Storage Queue 接收到的 base64 内容解码为字符串。默认为 `false`	`true`, `false`
`encodeBase64`	N	输出	如果启用，则在上传到 Azure storage queues 之前对数据负载进行 base64 编码。默认 `false`。	`true`, `false`
`endpoint`	N	输入/输出	可选的自定义端点 URL。这在使用 Azurite 模拟器或使用 Azure Storage 的自定义域时很有用（尽管这不是官方支持的）。端点必须是完整的基本 URL，包括协议（`http://` 或 `https://`）、IP 或 FQDN，以及可选端口。	`"http://127.0.0.1:10001"` 或 `"https://accountName.queue.example.com"`
`visibilityTimeout`	N	输入	允许设置自定义队列可见性超时，以避免最近失败消息的立即重试。默认为 30 秒。	`"100s"`
`direction`	N	输入/输出	绑定的方向。	`"input"`, `"output"`, `"input, output"`

Microsoft Entra ID 身份验证

Azure Storage Queue 绑定组件支持使用所有 Microsoft Entra ID 机制进行身份验证。请参阅Azure 身份验证文档以了解有关根据您选择的 Microsoft Entra ID 身份验证机制的相关组件元数据字段的更多信息。

Cloudflare Queues 绑定规范

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

组件格式

此 Dapr 输出绑定用于与 Cloudflare Queues 交互，发布新消息。目前，Dapr 还不支持从队列中消费消息。

要设置 Cloudflare Queues 绑定，需要创建一个类型为 bindings.cloudflare.queues 的组件。请参阅本指南了解如何创建和应用绑定配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.cloudflare.queues
 version: v1
 # 如果 Dapr 为您管理 Worker，请增加 initTimeout
 initTimeout: "120s"
 metadata:
 # 已存在的 Cloudflare Queue 名称（必需）
 - name: queueName
 value: ""
 # Worker 名称（必需）
 - name: workerName
 value: ""
 # PEM 编码的私有 Ed25519 密钥（必需）
 - name: key
 value: |
 -----BEGIN PRIVATE KEY-----
 MC4CAQ...
 -----END PRIVATE KEY-----
 # Cloudflare 账户 ID（Dapr 管理 Worker 时必需）
 - name: cfAccountID
 value: ""
 # Cloudflare 的 API 令牌（Dapr 管理 Worker 时必需）
 - name: cfAPIToken
 value: ""
 # Worker 的 URL（如果 Worker 是在 Dapr 之外预创建的，则必需）
 - name: workerUrl
 value: ""

警告

上述示例使用明文字符串作为 secret。建议使用 secret 存储来存储 secret，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`queueName`	Y	输出	已存在的 Cloudflare Queue 名称	`"mydaprqueue"`
`key`	Y	输出	Ed25519 私钥，PEM 编码	见上例
`cfAccountID`	Y/N	输出	Cloudflare 账户 ID。Dapr 管理 Worker 时必需。	`"456789abcdef8b5588f3d134f74ac"def`
`cfAPIToken`	Y/N	输出	Cloudflare 的 API 令牌。Dapr 管理 Worker 时必需。	`"secret-key"`
`workerUrl`	Y/N	输出	Worker 的 URL。如果 Worker 是在 Dapr 之外预配置的，则必需。	`"https://mydaprqueue.mydomain.workers.dev"`

当您配置 Dapr 为您创建 Worker 时，您可能需要为组件的 initTimeout 属性设置更长的值，以便为 Worker 脚本的部署留出足够的时间。例如：initTimeout: "120s"

commercetools GraphQL 绑定说明

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

组件格式

要配置 commercetools GraphQL 绑定，请创建一个类型为 bindings.commercetools 的组件。请参阅本指南了解如何创建和应用绑定配置。

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

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来保存这些机密信息，具体方法请参见此处。

规范元数据字段

字段	必需	绑定支持	详情	示例
`region`	Y	输出	commercetools 项目的区域	`"europe-west1"`
`provider`	Y	输出	云提供商，可以是 gcp 或 aws	`"gcp"`, `"aws"`
`projectKey`	Y	输出	commercetools 项目密钥
`clientID`	Y	输出	项目的 commercetools 客户端 ID
`clientSecret`	Y	输出	项目的 commercetools 客户端密钥
`scopes`	Y	输出	项目的 commercetools 范围	`"manage_project:project-key"`

更多信息请参见 commercetools - 创建 API 客户端和 commercetools - 区域。

Cron 绑定规范

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

组件格式

要设置 cron 绑定，需要创建一个类型为 bindings.cron 的组件。请参考本指南了解如何创建和应用绑定配置。

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

规范元数据字段

字段	必需	绑定支持	详情	示例
`schedule`	Y	输入	使用的有效 cron 调度。详见此处	`"@every 15m"`
`direction`	N	输入	绑定的方向	`"input"`

调度格式

Dapr cron 绑定支持以下格式：

字符	描述	可接受的值
1	秒	0 到 59，或 *
2	分	0 到 59，或 *
3	小时	0 到 23，或 * (UTC)
4	月中的某天	1 到 31，或 *
5	月	1 到 12，或 *
6	星期几	0 到 7 (其中 0 和 7 代表星期日)，或 *

例如：

GCP Pub/Sub 绑定规范

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

组件格式

要设置 GCP Pub/Sub 绑定，您需要创建一个类型为 bindings.gcp.pubsub 的组件。有关如何创建和应用绑定配置的信息，请参阅本指南。

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"

警告

上述示例使用了明文字符串作为密钥。建议使用密钥存储来保护这些信息，详情请参阅此处。

元数据字段说明

字段	必需	绑定支持	详情	示例
`topic`	Y	输出	GCP Pub/Sub 主题名称	`"topic1"`
`subscription`	N	GCP Pub/Sub 订阅名称	`"name1"`
`type`	Y	输出	GCP 凭证类型	`service_account`
`project_id`	Y	输出	GCP 项目 ID	`projectId`
`private_key_id`	N	输出	GCP 私钥 ID	`"privateKeyId"`
`private_key`	Y	输出	GCP 凭证私钥。可以替换为 x509 证书	`12345-12345`
`client_email`	Y	输出	GCP 客户端邮箱	`"client@email.com"`
`client_id`	N	输出	GCP 客户端 ID	`0123456789-0123456789`
`auth_uri`	N	输出	Google 账户 OAuth 端点	`https://accounts.google.com/o/oauth2/auth`
`token_uri`	N	输出	Google 账户令牌 URI	`https://oauth2.googleapis.com/token`
`auth_provider_x509_cert_url`	N	输出	GCP 凭证证书 URL	`https://www.googleapis.com/oauth2/v1/certs`
`client_x509_cert_url`	N	输出	GCP 凭证项目 x509 证书 URL	`https://www.googleapis.com/robot/v1/metadata/x509/<PROJECT_NAME>.iam.gserviceaccount.com`
`direction`	N	输入/输出	绑定的方向。	`"input"`, `"output"`, `"input, output"`

绑定支持

此组件支持 输入和输出 绑定接口。

GCP 存储桶绑定指南

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

组件格式

要配置 GCP 存储桶绑定，请创建一个类型为 bindings.gcp.bucket 的组件。请参阅本指南了解如何创建和应用绑定配置。

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>"

警告

上述示例中使用了明文字符串来存储密钥。建议使用密钥存储来保护这些信息，具体方法请参阅此处。

元数据字段说明

字段	必需	绑定支持	详情	示例
`bucket`	Y	输出	存储桶名称	`"mybucket"`
`type`	Y	输出	GCP 凭证类型	`"service_account"`
`project_id`	Y	输出	GCP 项目 ID	`projectId`
`private_key_id`	Y	输出	GCP 私钥 ID	`"privateKeyId"`
`private_key`	Y	输出	GCP 凭证私钥。替换为 x509 证书	`12345-12345`
`client_email`	Y	输出	GCP 客户端邮箱	`"client@email.com"`
`client_id`	Y	输出	GCP 客户端 ID	`0123456789-0123456789`
`auth_uri`	Y	输出	Google 账户 OAuth 端点	`https://accounts.google.com/o/oauth2/auth`
`token_uri`	Y	输出	Google 账户令牌 URI	`https://oauth2.googleapis.com/token`
`auth_provider_x509_cert_url`	Y	输出	GCP 凭证证书 URL	`https://www.googleapis.com/oauth2/v1/certs`
`client_x509_cert_url`	Y	输出	GCP 凭证项目 x509 证书 URL	`https://www.googleapis.com/robot/v1/metadata/x509/<PROJECT_NAME>.iam.gserviceaccount.com`
`decodeBase64`	N	输出	在保存到存储桶之前解码 base64 文件内容的配置。适用于保存二进制内容的文件。`true` 是唯一允许的正值。其他正值变体如 `"True", "1"` 不可接受。默认为 `false`	`true`, `false`
`encodeBase64`	N	输出	在返回内容之前编码 base64 文件内容的配置。适用于打开二进制内容的文件。`true` 是唯一允许的正值。其他正值变体如 `"True", "1"` 不可接受。默认为 `false`	`true`, `false`

绑定支持

此组件支持 输出绑定，支持以下操作：

GraphQL 绑定说明

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

组件格式

要配置 GraphQL 绑定，请创建一个类型为 bindings.graphql 的组件。请参阅本指南了解如何创建和应用绑定配置。为了区分普通配置（如 endpoint）和 headers，header 名称前需加上 “header:” 前缀。

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"

警告

上述示例中使用了明文字符串来存储 secret。建议使用 secret 存储来保护 secret，详情请参阅此处。

元数据字段说明

字段	必需	绑定支持	详情	示例
`endpoint`	Y	输出	GraphQL endpoint 字符串，详情见此处	`"http://localhost:4000/graphql/graphql"`
`header:[HEADERKEY]`	N	输出	GraphQL header。在 `name` 中指定 header 键，在 `value` 中指定 header 值。	`"no-cache"` (见上文)
`variable:[VARIABLEKEY]`	N	输出	GraphQL 查询变量。在 `name` 中指定变量名，在 `value` 中指定变量值。	`"123"` (见下文)

GraphQL 绑定内部使用 GraphQL 客户端。

HTTP 绑定规范

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

替代方法

服务调用 API 允许调用非 Dapr 的 HTTP 端点，并且是推荐的方法。阅读 “如何：使用 HTTP 调用非 Dapr 端点” 以获取更多信息。

设置 Dapr 组件

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" # 可选，最大读取响应数据量
 #- name: MTLSRootCA
 # value: "/Users/somepath/root.pem" # 可选，根 CA 或 PEM 编码字符串的路径
 #- name: MTLSClientCert
 # value: "/Users/somepath/client.pem" # 可选，客户端证书或 PEM 编码字符串的路径
 #- name: MTLSClientKey
 # value: "/Users/somepath/client.key" # 可选，客户端密钥或 PEM 编码字符串的路径
 #- name: MTLSRenegotiation
 # value: "RenegotiateOnceAsClient" # 可选，选项之一：RenegotiateNever, RenegotiateOnceAsClient, RenegotiateFreelyAsClient
 #- name: securityToken # 可选，<在 HTTP 请求中作为头部包含的令牌>
 # secretKeyRef:
 # name: mysecret
 # key: "mytoken"
 #- name: securityTokenHeader
 # value: "Authorization: Bearer" # 可选，<安全令牌的头部名称>
 #- name: errorIfNot2XX
 # value: "false" # 可选

元数据字段说明

字段	必需	绑定支持	详情	示例
`url`	是	输出	要调用的 HTTP 端点的基本 URL	`http://host:port/path`, `http://myservice:8000/customers`
`maxResponseBodySize`	否	输出	要读取的响应的最大长度。整数被解释为字节；可以添加 `Ki, Mi, Gi` (SI) 或 `k	M
`MTLSRootCA`	否	输出	根 CA 证书或 PEM 编码字符串的路径
`MTLSClientCert`	否	输出	客户端证书或 PEM 编码字符串的路径
`MTLSClientKey`	否	输出	客户端私钥或 PEM 编码字符串的路径
`MTLSRenegotiation`	否	输出	要使用的 mTLS 重新协商类型	`RenegotiateOnceAsClient`
`securityToken`	否	输出	要作为头部添加到 HTTP 请求中的令牌值。与 `securityTokenHeader` 一起使用
`securityTokenHeader`	否	输出	HTTP 请求中 `securityToken` 的头部名称
`errorIfNot2XX`	否	输出	当响应不在 2xx 范围内时是否抛出绑定错误。默认为 `true`

MTLSRootCA、MTLSClientCert 和 MTLSClientKey 的值可以通过三种方式提供：

InfluxDB 绑定规范

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

组件格式

为了设置 InfluxDB 绑定，请创建一个类型为 bindings.influx 的组件。请参阅本指南了解如何创建和应用绑定配置。

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

警告

上述示例中，secret 使用了明文字符串。建议使用 secret 存储来保护这些信息，具体方法请参见此处。

元数据字段说明

字段	必需	绑定支持	详情	示例
`url`	Y	输出	InfluxDB 实例的 URL	`"http://localhost:8086"`
`token`	Y	输出	InfluxDB 的授权令牌	`"mytoken"`
`org`	Y	输出	InfluxDB 组织	`"myorg"`
`bucket`	Y	输出	要写入的桶名称	`"mybucket"`

绑定功能

此组件支持以下输出绑定操作：

Kafka 绑定规范

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

组件格式

要配置 Kafka 绑定，需创建一个 bindings.kafka 类型的组件。请参考本指南了解如何创建和应用绑定配置。有关使用 secretKeyRef 的详细信息，请查看如何在组件中引用 secret的指南。

所有组件的元数据字段值可以使用模板化的元数据值，这些值会在 Dapr sidecar 启动时进行解析。例如，您可以选择使用 {namespace} 作为 consumerGroup，以便在不同命名空间中使用相同的 appId 和主题，如本文中所述。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: kafka-binding
spec:
 type: bindings.kafka
 version: v1
 metadata:
 - name: topics # 可选。用于输入绑定。
 value: "topic1,topic2"
 - name: brokers # 必需。
 value: "localhost:9092,localhost:9093"
 - name: consumerGroup # 可选。用于输入绑定。
 value: "group1"
 - name: publishTopic # 可选。用于输出绑定。
 value: "topic3"
 - name: authRequired # 必需。
 value: "true"
 - name: saslUsername # 如果 authRequired 为 `true`，则必需。
 value: "user"
 - name: saslPassword # 如果 authRequired 为 `true`，则必需。
 secretKeyRef:
 name: kafka-secrets
 key: "saslPasswordSecret"
 - name: saslMechanism
 value: "SHA-512"
 - name: initialOffset # 可选。用于输入绑定。
 value: "newest"
 - name: maxMessageBytes # 可选。
 value: "1024"
 - name: heartbeatInterval # 可选。
 value: 5s
 - name: sessionTimeout # 可选。
 value: 15s
 - name: version # 可选。
 value: "2.0.0"
 - name: direction
 value: "input, output"
 - name: schemaRegistryURL # 可选。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry URL。
 value: http://localhost:8081
 - name: schemaRegistryAPIKey # 可选。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry API Key。
 value: XYAXXAZ
 - name: schemaRegistryAPISecret # 可选。当使用 Schema Registry Avro 序列化/反序列化时。Schema Registry 凭证 API Secret。
 value: "ABCDEFGMEADFF"
 - name: schemaCachingEnabled # 可选。当使用 Schema Registry Avro 序列化/反序列化时。启用 schema 缓存。
 value: true
 - name: schemaLatestVersionCacheTTL # 可选。当使用 Schema Registry Avro 序列化/反序列化时。发布消息时使用最新 schema 的缓存 TTL。
 value: 5m
 - name: escapeHeaders # 可选。
 value: false

规范元数据字段

字段	必需	绑定支持	详情	示例
`topics`	N	输入	逗号分隔的主题字符串。	`"mytopic1,topic2"`
`brokers`	Y	输入/输出	逗号分隔的 Kafka brokers 字符串。	`"localhost:9092,dapr-kafka.myapp.svc.cluster.local:9093"`
`clientID`	N	输入/输出	用户提供的字符串，随每个请求发送到 Kafka brokers 以用于日志记录、调试和审计。	`"my-dapr-app"`
`consumerGroup`	N	输入	监听的 kafka 消费者组。发布到主题的每条记录都会传递给订阅该主题的每个消费者组中的一个消费者。	`"group1"`
`consumeRetryEnabled`	N	输入/输出	通过设置为 `"true"` 启用消费重试。在 Kafka 绑定组件中默认为 `false`。	`"true"`, `"false"`
`publishTopic`	Y	输出	要发布到的主题。	`"mytopic"`
`authRequired`	N	已弃用	启用与 Kafka brokers 的 SASL 认证。	`"true"`, `"false"`
`authType`	Y	输入/输出	配置或禁用认证。支持的值：`none`、`password`、`mtls` 或 `oidc`	`"password"`, `"none"`
`saslUsername`	N	输入/输出	用于认证的 SASL 用户名。仅当 `authRequired` 设置为 `"true"` 时需要。	`"adminuser"`
`saslPassword`	N	输入/输出	用于认证的 SASL 密码。可以是 `secretKeyRef` 以使用secret 引用。仅当 `authRequired` 设置为 `"true"` 时需要。	`""`, `"KeFg23!"`
`saslMechanism`	N	输入/输出	您想要使用的 SASL 认证机制。仅当 `authtype` 设置为 `"password"` 时需要。如果未提供，默认为 `PLAINTEXT`，这可能会导致某些服务（如 Amazon Managed Service for Kafka）中断。	`"SHA-512", "SHA-256", "PLAINTEXT"`
`initialOffset`	N	输入	如果之前没有提交偏移量，则使用的初始偏移量。应为 “newest” 或 “oldest”。默认为 “newest”。	`"oldest"`
`maxMessageBytes`	N	输入/输出	单个 Kafka 消息允许的最大字节大小。默认为 1024。	`"2048"`
`oidcTokenEndpoint`	N	输入/输出	OAuth2 身份提供者访问令牌端点的完整 URL。当 `authType` 设置为 `oidc` 时需要	“https://identity.example.com/v1/token"
`oidcClientID`	N	输入/输出	在身份提供者中配置的 OAuth2 客户端 ID。当 `authType` 设置为 `oidc` 时需要	`"dapr-kafka"`
`oidcClientSecret`	N	输入/输出	在身份提供者中配置的 OAuth2 客户端 secret：当 `authType` 设置为 `oidc` 时需要	`"KeFg23!"`
`oidcScopes`	N	输入/输出	逗号分隔的 OAuth2/OIDC 范围列表，用于请求访问令牌。当 `authType` 设置为 `oidc` 时推荐。默认为 `"openid"`	`"openid,kafka-prod"`
`version`	N	输入/输出	Kafka 集群版本。默认为 2.0.0。请注意，对于使用 Kafka 的 EventHubs，必须将其设置为 `1.0.0`。	`"1.0.0"`
`direction`	N	输入/输出	绑定的方向。	`"input"`, `"output"`, `"input, output"`
`oidcExtensions`	N	输入/输出	包含 JSON 编码的 OAuth2/OIDC 扩展字典的字符串，用于请求访问令牌	`{"cluster":"kafka","poolid":"kafkapool"}`
`schemaRegistryURL`	N	使用 Schema Registry Avro 序列化/反序列化时必需。Schema Registry URL。	`http://localhost:8081`
`schemaRegistryAPIKey`	N	使用 Schema Registry Avro 序列化/反序列化时。Schema Registry 凭证 API Key。	`XYAXXAZ`
`schemaRegistryAPISecret`	N	使用 Schema Registry Avro 序列化/反序列化时。Schema Registry 凭证 API Secret。	`ABCDEFGMEADFF`
`schemaCachingEnabled`	N	使用 Schema Registry Avro 序列化/反序列化时。启用 schema 缓存。默认为 `true`	`true`
`schemaLatestVersionCacheTTL`	N	使用 Schema Registry Avro 序列化/反序列化时。发布消息时使用最新 schema 的缓存 TTL。默认为 5 分钟	`5m`
`clientConnectionTopicMetadataRefreshInterval`	N	输入/输出	客户端连接的主题元数据与 broker 刷新的间隔，以 Go 持续时间表示。默认为 `9m`。	`"4m"`
`clientConnectionKeepAliveInterval`	N	输入/输出	客户端连接与 broker 保持活动的最长时间，以 Go 持续时间表示，然后关闭连接。零值（默认）表示无限期保持活动。	`"4m"`
`consumerFetchDefault`	N	输入/输出	每个请求从 broker 获取的默认消息字节数。默认为 `"1048576"` 字节。	`"2097152"`
`heartbeatInterval`	N	输入	向消费者协调器发送心跳的间隔。最多应设置为 `sessionTimeout` 值的 1/3。默认为 `"3s"`。	`"5s"`
`sessionTimeout`	N	输入	使用 Kafka 的组管理功能时用于检测客户端故障的超时时间。如果 broker 在此会话超时之前未收到任何来自消费者的心跳，则消费者将被移除并启动重新平衡。默认为 `"10s"`。	`"20s"`
`escapeHeaders`	N	输入	启用对消费者接收的消息头值的 URL 转义。允许接收通常不允许在 HTTP 头中的特殊字符内容。默认为 `false`。	`true`

注意

使用 Azure EventHubs 和 Kafka 时，元数据 version 必须设置为 1.0.0。

Kitex

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

概述

Kitex 绑定主要利用其通用调用功能。可以从官方文档中了解更多关于 Kitex 通用调用的详细信息。目前，Kitex 仅支持 Thrift 通用调用。集成到 components-contrib 的实现采用了二进制通用调用方式。

组件格式

要设置 Kitex 绑定，创建一个类型为 bindings.kitex 的组件。请参阅如何：使用输出绑定与外部资源接口指南，了解如何创建和应用绑定配置。

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"

元数据字段说明

bindings.kitex 的 InvokeRequest.Metadata 要求客户端在调用时填写以下四个必需项：

hostPorts
destService
methodName
version

字段	必需	绑定支持	详情	示例
`hostPorts`	是	输出	Kitex 服务器（Thrift）的 IP 地址和端口信息	`"127.0.0.1:8888"`
`destService`	是	输出	Kitex 服务器（Thrift）的服务名称	`"echo"`
`methodName`	是	输出	Kitex 服务器（Thrift）中某个服务名称下的方法名称	`"echo"`
`version`	是	输出	Kitex 的版本号	`"0.5.0"`

绑定支持

此组件支持具有以下操作的输出绑定：

KubeMQ 绑定规范

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

组件格式

要设置 KubeMQ 绑定，需创建一个类型为 bindings.kubemq 的组件。请参阅本指南了解如何创建和应用绑定配置。

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"

规范元数据字段

字段	必需	详情	示例
`address`	Y	KubeMQ 服务器的地址	`"localhost:50000"`
`channel`	Y	队列通道名称	`"queue1"`
`authToken`	N	连接的 Auth JWT 令牌。请参阅 KubeMQ 认证	`"ew..."`
`autoAcknowledged`	N	设置是否自动确认接收到的队列消息	`"true"` 或 `"false"` (默认是 `"false"`)
`pollMaxItems`	N	设置每次连接轮询的消息数量	`"1"`
`pollTimeoutSeconds`	N	设置每个轮询间隔的时间（秒）	`"3600"`
`direction`	N	绑定的方向	`"input"`, `"output"`, `"input, output"`

绑定支持

该组件支持 输入和输出 绑定接口。

Kubernetes Events 绑定指南

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

组件格式

为了配置 Kubernetes Events 绑定，需要创建一个类型为 bindings.kubernetes 的组件。请参考本指南了解如何创建和应用绑定配置。

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"

元数据字段说明

字段	必需	绑定支持	详情	示例
`namespace`	是	输入	要读取事件的 Kubernetes 命名空间	`"default"`
`resyncPeriodInSec`	否	输入	从 Kubernetes API 服务器刷新事件列表的时间间隔，默认为 `"10"` 秒	`"15"`
`direction`	否	输入	绑定的方向	`"input"`
`kubeconfigPath`	否	输入	kubeconfig 文件的路径。如果未指定，将使用默认的集群内配置	`"/path/to/kubeconfig"`

绑定支持

此组件支持输入绑定接口。

MQTT3 绑定规范

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

组件格式

要设置 MQTT3 绑定，需要创建一个类型为 bindings.mqtt3 的组件。请参阅本指南了解如何创建和应用绑定配置。

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"
 # 以下字段是可选的：
 - name: retain
 value: "false"
 - name: cleanSession
 value: "false"
 - name: backOffMaxRetries
 value: "0"
 - name: direction
 value: "input, output"

警告

上述示例中，secret 以明文字符串形式使用。建议使用 secret 存储来保护这些信息，具体方法请参见此处。

规范元数据字段

字段	必需	绑定支持	详情	示例
`url`	Y	输入/输出	MQTT broker 的地址。可以使用 `secretKeyRef` 来引用 secret。对于非 TLS 通信，使用 `tcp://` URI 方案。对于 TLS 通信，使用 `ssl://` URI 方案。	`"tcp://[username][:password]@host.domain[:port]"`
`topic`	Y	输入/输出	要监听或发送事件的主题。	`"mytopic"`
`consumerID`	Y	输入/输出	用于连接到 MQTT broker 的客户端 ID。	`"myMqttClientApp"`
`retain`	N	输入/输出	定义消息是否由 broker 保存为指定主题的最后已知良好值。默认为 `"false"`。	`"true"`, `"false"`
`cleanSession`	N	输入/输出	如果为 `"true"`，则在连接消息中设置 `clean_session` 标志到 MQTT broker。默认为 `"false"`。	`"true"`, `"false"`
`caCert`	使用 TLS 时必需	输入/输出	用于验证服务器 TLS 证书的 PEM 格式的证书颁发机构 (CA) 证书。	见下例
`clientCert`	使用 TLS 时必需	输入/输出	PEM 格式的 TLS 客户端证书。必须与 `clientKey` 一起使用。	见下例
`clientKey`	使用 TLS 时必需	输入/输出	PEM 格式的 TLS 客户端密钥。必须与 `clientCert` 一起使用。可以使用 `secretKeyRef` 来引用 secret。	见下例
`backOffMaxRetries`	N	输入	在返回错误之前处理消息的最大重试次数。默认为 `"0"`，表示不会尝试重试。可以指定 `"-1"` 表示消息应无限期重试，直到成功处理或应用程序关闭。组件将在重试之间等待 5 秒。	`"3"`
`direction`	N	输入/输出	绑定的方向	`"input"`, `"output"`, `"input, output"`

使用 TLS 进行通信

要配置使用 TLS 的通信，请确保 MQTT broker（例如 emqx）配置为支持证书，并在组件配置中提供 caCert、clientCert、clientKey 元数据。例如：

MySQL & MariaDB 绑定规范

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

组件格式

MySQL 绑定支持连接 MySQL 和 MariaDB 数据库。在本文档中，“MySQL” 用于指代这两个数据库。

要设置 MySQL 绑定，请创建一个类型为 bindings.mysql 的组件。请参阅本指南了解如何创建和应用绑定配置。

MySQL 绑定使用 Go-MySQL-Driver 作为内部驱动。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.mysql
 version: v1
 metadata:
 - name: url # 必需，定义数据库连接的 DSN 格式
 value: "<CONNECTION_STRING>"
 - name: pemPath # 可选
 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>"

警告

上面的示例使用明文字符串作为 secret。建议使用 secret 存储来存储 secret，如此处所述。请注意，您不能仅为用户名/密码使用 secret。如果使用 secret，必须用于完整的连接字符串。

规范元数据字段

字段	必需	绑定支持	详情	示例
`url`	Y	输出	以数据源名称 (DSN) 格式表示数据库连接。查看此处的 SSL 详情	`"user:password@tcp(localhost:3306)/dbname"`
`pemPath`	Y	输出	PEM 文件的路径。用于 SSL 连接	`"path/to/pem/file"`
`maxIdleConns`	N	输出	最大空闲连接数。大于 0 的整数	`"10"`
`maxOpenConns`	N	输出	最大打开连接数。大于 0 的整数	`"10"`
`connMaxLifetime`	N	输出	最大连接生命周期。格式为持续时间字符串，例如 `"12s"`	`"12s"`
`connMaxIdleTime`	N	输出	最大连接空闲时间。格式为持续时间字符串，例如 `"12s"`	`"12s"`

SSL 连接

如果您的服务器需要 SSL，您的连接字符串必须以 &tls=custom 结尾，例如：

PostgreSQL 绑定组件规范

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

组件配置格式

要设置 PostgreSQL 绑定，请创建一个类型为 bindings.postgresql 的组件。请参阅本指南了解如何创建和应用绑定配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.postgresql
 version: v1
 metadata:
 # 连接字符串
 - name: connectionString
 value: "<CONNECTION STRING>"

警告

上述示例中，secret 以明文字符串形式使用。建议使用 secret 存储来保存 secret，具体方法请参见此处。

规范元数据字段

通过连接字符串进行身份验证

以下元数据选项是通过连接字符串进行身份验证时必需的。

字段	必需	详情	示例
`connectionString`	Y	PostgreSQL 数据库的连接字符串。有关如何定义连接字符串的信息，请参阅 PostgreSQL 数据库连接文档。	`"host=localhost user=postgres password=example port=5432 connect_timeout=10 database=my_db"`

通过 Microsoft Entra ID 进行身份验证

在 Azure Database for PostgreSQL 中支持通过 Microsoft Entra ID 进行身份验证。Dapr 支持的所有身份验证方法都可以使用，包括客户端凭据（“服务主体”）和托管身份。

Postmark 绑定说明

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

组件格式指南

要配置 Postmark 绑定，需创建一个类型为 bindings.postmark 的组件。请参阅本指南了解如何创建和应用绑定配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: postmark
spec:
 type: bindings.postmark
 metadata:
 - name: accountToken
 value: "YOUR_ACCOUNT_TOKEN" # 必需，这是您的 Postmark 账户令牌
 - name: serverToken
 value: "YOUR_SERVER_TOKEN" # 必需，这是您的 Postmark 服务器令牌
 - name: emailFrom
 value: "testapp@dapr.io" # 可选
 - name: emailTo
 value: "dave@dapr.io" # 可选
 - name: subject
 value: "Hello!" # 可选

警告

上述示例使用明文字符串作为 secret。建议使用 secret 存储来存储 secret，如此处所述。

元数据字段说明

字段	必需	绑定支持	详情	示例
`accountToken`	Y	输出	Postmark 账户令牌，应视为 secret 值	`"account token"`
`serverToken`	Y	输出	Postmark 服务器令牌，应视为 secret 值	`"server token"`
`emailFrom`	N	输出	如果设置，则指定电子邮件消息的“发件人”地址	`"me@exmaple.com"`
`emailTo`	N	输出	如果设置，则指定电子邮件消息的“收件人”地址	`"me@example.com"`
`emailCc`	N	输出	如果设置，则指定电子邮件消息的“抄送”地址	`"me@example.com"`
`emailBcc`	N	输出	如果设置，则指定电子邮件消息的“密送”地址	`"me@example.com"`
`subject`	N	输出	如果设置，则指定电子邮件消息的主题	`"me@example.com"`

在输出绑定请求中，您也可以指定任何可选的元数据属性（例如 emailFrom、emailTo、subject 等）。

RabbitMQ 绑定规范

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

组件格式

要设置 RabbitMQ 绑定，需创建一个类型为 bindings.rabbitmq 的组件。请参考本指南了解如何创建和应用绑定配置。

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"

警告

上述示例中，secret 使用了明文字符串。建议使用 secret 存储，如此处所述。

规范元数据字段

发布新的 RabbitMQ 消息时，所有关联元数据的值都会添加到消息的头部。

Redis 绑定规范

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

组件格式

要设置 Redis 绑定，需创建一个类型为 bindings.redis 的组件。请参考本指南了解如何创建和应用绑定配置。

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>"

警告

上述示例使用了明文字符串作为秘密。建议使用秘密存储，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`redisHost`	Y	输出	Redis 主机地址	`"localhost:6379"`
`redisPassword`	N	输出	Redis 密码	`"password"`
`redisUsername`	N	输出	Redis 主机的用户名。默认为空。确保您的 Redis 服务器版本为 6 或更高，并已正确创建 ACL 规则。	`"username"`
`useEntraID`	N	输出	实现 Azure Cache for Redis 的 EntraID 支持。启用此功能之前：必须以 `"server:port"` 的形式指定 `redisHost` 名称必须启用 TLS 更多信息请参见创建 Redis 实例 > Azure Cache for Redis部分。	`"true"`, `"false"`
`enableTLS`	N	输出	如果 Redis 实例支持带有公共证书的 TLS，则可以配置启用或禁用 TLS。默认为 `"false"`	`"true"`, `"false"`
`clientCert`	N	输出	客户端证书的内容，用于需要客户端证书的 Redis 实例。必须与 `clientKey` 一起使用，并且 `enableTLS` 必须设置为 true。建议使用秘密存储，如此处所述	`"----BEGIN CERTIFICATE-----\nMIIC..."`
`clientKey`	N	输出	客户端私钥的内容，与 `clientCert` 一起用于身份验证。建议使用秘密存储，如此处所述	`"----BEGIN PRIVATE KEY-----\nMIIE..."`
`failover`	N	输出	启用故障转移配置的属性。需要设置 sentinalMasterName。默认为 `"false"`	`"true"`, `"false"`
`sentinelMasterName`	N	输出	哨兵主名称。参见 Redis Sentinel 文档	`""`, `"127.0.0.1:6379"`
`redeliverInterval`	N	输出	检查待处理消息以重新传递的间隔。默认为 `"60s"`。`"0"` 禁用重新传递。	`"30s"`
`processingTimeout`	N	输出	消息在尝试重新传递之前必须挂起的时间。默认为 `"15s"`。`"0"` 禁用重新传递。	`"30s"`
`redisType`	N	输出	Redis 的类型。有两个有效值，一个是 `"node"` 表示单节点模式，另一个是 `"cluster"` 表示 Redis 集群模式。默认为 `"node"`。	`"cluster"`
`redisDB`	N	输出	连接到 Redis 后选择的数据库。如果 `"redisType"` 是 `"cluster"`，则忽略此选项。默认为 `"0"`。	`"0"`
`redisMaxRetries`	N	输出	在放弃之前重试命令的最大次数。默认情况下不重试失败的命令。	`"5"`
`redisMinRetryInterval`	N	输出	每次重试之间 Redis 命令的最小退避时间。默认为 `"8ms"`；`"-1"` 禁用退避。	`"8ms"`
`redisMaxRetryInterval`	N	输出	每次重试之间 Redis 命令的最大退避时间。默认为 `"512ms"`；`"-1"` 禁用退避。	`"5s"`
`dialTimeout`	N	输出	建立新连接的拨号超时时间。默认为 `"5s"`。	`"5s"`
`readTimeout`	N	输出	套接字读取的超时时间。如果达到，Redis 命令将因超时而失败而不是阻塞。默认为 `"3s"`，`"-1"` 表示无超时。	`"3s"`
`writeTimeout`	N	输出	套接字写入的超时时间。如果达到，Redis 命令将因超时而失败而不是阻塞。默认为 readTimeout。	`"3s"`
`poolSize`	N	输出	最大套接字连接数。默认是每个 CPU 10 个连接，如 runtime.NumCPU 报告。	`"20"`
`poolTimeout`	N	输出	如果所有连接都忙，客户端在返回错误之前等待连接的时间。默认是 readTimeout + 1 秒。	`"5s"`
`maxConnAge`	N	输出	客户端在此连接年龄时退役（关闭）连接。默认是不关闭老化连接。	`"30m"`
`minIdleConns`	N	输出	为了避免创建新连接的性能下降，保持打开的最小空闲连接数。默认为 `"0"`。	`"2"`
`idleCheckFrequency`	N	输出	空闲连接清理器进行空闲检查的频率。默认为 `"1m"`。`"-1"` 禁用空闲连接清理器。	`"-1"`
`idleTimeout`	N	输出	客户端关闭空闲连接的时间。应小于服务器的超时时间。默认为 `"5m"`。`"-1"` 禁用空闲超时检查。	`"10m"`

绑定支持

此组件支持具有以下操作的输出绑定：

RethinkDB 绑定规范

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

组件格式

RethinkDB 状态存储支持事务，因此可以用于支持 Dapr actor。Dapr 仅持久化 actor 的当前状态，因此用户无法跟踪 actor 状态随时间的变化。

为了让用户能够跟踪 actor 状态的变化，此绑定利用 RethinkDB 内置的功能来监控表和事件的变化，包括 old 和 new 状态。此绑定在 Dapr 状态表上创建一个订阅，并通过 Dapr 输入绑定接口流式传输这些变化。

要设置 RethinkDB 状态变化绑定，请创建一个类型为 bindings.rethinkdb.statechange 的组件。请参阅本指南了解如何创建和应用绑定配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: changes
spec:
 type: bindings.rethinkdb.statechange
 version: v1
 metadata:
 - name: address
 value: "<REPLACE-RETHINKDB-ADDRESS>" # 必需，例如 127.0.0.1:28015 或 rethinkdb.default.svc.cluster.local:28015）。
 - name: database
 value: "<REPLACE-RETHINKDB-DB-NAME>" # 必需，例如 dapr（仅限字母数字）
 - name: direction 
 value: "<DIRECTION-OF-RETHINKDB-BINDING>"

规范元数据字段

字段	必需	绑定支持	详情	示例
`address`	Y	输入	RethinkDB 服务器地址	`"27.0.0.1:28015"`，`"rethinkdb.default.svc.cluster.local:28015"`
`database`	Y	输入	RethinkDB 数据库名称	`"dapr"`
`direction`	N	输入	绑定的方向	`"input"`

绑定支持

此组件仅支持输入绑定接口。

SFTP 绑定规范

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

组件格式

要配置 SFTP 绑定，创建一个类型为 bindings.sftp 的组件。请参阅[本指南]({{ ref bindings-overview.md }})以了解如何创建和应用绑定配置。

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>"

元数据字段说明

字段	必需	绑定支持	详情	示例
`rootPath`	Y	输出	默认工作目录的根路径	`"/path"`
`address`	Y	输出	SFTP 服务器地址	`"localhost:22"`
`username`	Y	输出	用于身份验证的用户名	`"username"`
`password`	N	输出	用户名/密码身份验证的密码	`"password"`
`privateKey`	N	输出	公钥身份验证的私钥	"\|- —–BEGIN OPENSSH PRIVATE KEY—– ***************** —–END OPENSSH PRIVATE KEY—–"
`privateKeyPassphrase`	N	输出	公钥身份验证的私钥密码	`"passphrase"`
`hostPublicKey`	N	输出	主机验证的主机公钥	`"ecdsa-sha2-nistp256 *** root@openssh-server"`
`knownHostsFile`	N	输出	主机验证的已知主机文件	`"/path/file"`
`insecureIgnoreHostKey`	N	输出	允许跳过主机验证。默认为 `"false"`	`"true"`, `"false"`

绑定功能支持

此组件支持以下操作的输出绑定：

SMTP 绑定规范

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

组件格式

要设置 SMTP 绑定，您需要创建一个类型为 bindings.smtp 的组件。请参阅本指南了解如何创建和应用绑定配置。

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]"

警告

上面的示例配置中包含了明文形式的用户名和密码。建议使用 secret 存储来保护这些信息，详情请参阅此处。

规范元数据字段

字段	必需	绑定支持	详情	示例
`host`	Y	输出	SMTP 服务器的主机地址	`"smtphost"`
`port`	Y	输出	SMTP 服务器的端口号	`"9999"`
`user`	Y	输出	用于认证的用户名	`"user"`
`password`	Y	输出	用户的密码	`"password"`
`skipTLSVerify`	N	输出	如果设置为 true，将跳过对 SMTP 服务器 TLS 证书的验证。默认为 `"false"`	`"true"`, `"false"`
`emailFrom`	N	输出	如果设置，将指定发件人的电子邮件地址。参见示例请求	`"me@example.com"`
`emailTo`	N	输出	如果设置，将指定收件人的电子邮件地址。参见示例请求	`"me@example.com"`
`emailCc`	N	输出	如果设置，将指定抄送的电子邮件地址。参见示例请求	`"me@example.com"`
`emailBcc`	N	输出	如果设置，将指定密送的电子邮件地址。参见示例请求	`"me@example.com"`
`subject`	N	输出	如果设置，将指定电子邮件的主题。参见示例请求	`"subject of mail"`
`priority`	N	输出	如果设置，将指定电子邮件的优先级 (X-Priority)，范围从 1（最低）到 5（最高）（默认值：3）。参见示例请求	`"1"`

绑定支持

此组件支持输出绑定，可执行以下操作：

Twilio SendGrid 绑定规范

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

组件格式

要设置 Twilio SendGrid 绑定，您需要创建一个类型为 bindings.twilio.sendgrid 的组件。请参阅本指南了解如何创建和应用绑定配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: sendgrid
spec:
 type: bindings.twilio.sendgrid
 version: v1
 metadata:
 - name: emailFrom
 value: "testapp@dapr.io" # 可选
 - name: emailFromName
 value: "test app" # 可选
 - name: emailTo
 value: "dave@dapr.io" # 可选
 - name: emailToName
 value: "dave" # 可选
 - name: subject
 value: "Hello!" # 可选
 - name: emailCc
 value: "jill@dapr.io" # 可选
 - name: emailBcc
 value: "bob@dapr.io" # 可选
 - name: dynamicTemplateId
 value: "d-123456789" # 可选
 - name: dynamicTemplateData
 value: '{"customer":{"name":"John Smith"}}' # 可选
 - name: apiKey
 value: "YOUR_API_KEY" # 必需，这是您的 SendGrid 密钥

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来保存密钥，具体方法请参见此处。

元数据字段说明

字段	必需	绑定支持	详情	示例
`apiKey`	Y	输出	SendGrid API 密钥，应视为敏感信息	`"apikey"`
`emailFrom`	N	输出	若设置，指定电子邮件的“发件人”地址。仅允许一个电子邮件地址。可选字段，参见下文	`"me@example.com"`
`emailFromName`	N	输出	若设置，指定电子邮件的“发件人”名称。可选字段，参见下文	`"me"`
`emailTo`	N	输出	若设置，指定电子邮件的“收件人”地址。仅允许一个电子邮件地址。可选字段，参见下文	`"me@example.com"`
`emailToName`	N	输出	若设置，指定电子邮件的“收件人”名称。可选字段，参见下文	`"me"`
`emailCc`	N	输出	若设置，指定电子邮件的“抄送”地址。仅允许一个电子邮件地址。可选字段，参见下文	`"me@example.com"`
`emailBcc`	N	输出	若设置，指定电子邮件的“密件抄送”地址。仅允许一个电子邮件地址。可选字段，参见下文	`"me@example.com"`
`subject`	N	输出	若设置，指定电子邮件的主题。可选字段，参见下文	`"subject of the email"`

绑定支持

此组件支持以下操作的输出绑定：

Twilio SMS 绑定说明

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

组件格式指南

要配置 Twilio SMS 绑定组件，请创建一个类型为 bindings.twilio.sms 的组件。有关如何创建和应用绑定配置的详细信息，请参阅本指南。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.twilio.sms
 version: v1
 metadata:
 - name: toNumber # 必需。
 value: "111-111-1111"
 - name: fromNumber # 必需。
 value: "222-222-2222"
 - name: accountSid # 必需。
 value: "*****************"
 - name: authToken # 必需。
 value: "*****************"

警告

上述示例中，secret 以明文字符串形式使用。建议使用 secret 存储来存储 secret，如此处所述。

元数据字段说明

字段	必需	绑定支持	详情	示例
`toNumber`	Y	输出	发送短信的目标号码	`"111-111-1111"`
`fromNumber`	Y	输出	发送者的电话号码	`"222-222-2222"`
`accountSid`	Y	输出	Twilio 账户 SID	`"account sid"`
`authToken`	Y	输出	Twilio 认证令牌	`"auth token"`

支持的绑定功能

此组件支持以下输出绑定操作：

Wasm

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

概述

使用 WebAssembly，您可以安全地运行用其他语言编写并编译的代码。运行时执行 WebAssembly 模块（Wasm），这些模块通常是带有 .wasm 扩展名的二进制文件。

Wasm 绑定允许您通过传递命令行参数或环境变量来调用编译为 Wasm 的程序，就像使用普通子进程一样。例如，即使 Dapr 是用 Go 编写的并运行在没有安装 Python 的平台上，您也可以使用 Python 满足调用需求！

Wasm 二进制文件必须是使用 WebAssembly 系统接口（WASI）编译的程序。二进制文件可以是您编写的程序，例如用 Go 编写的，或者是您用来运行内联脚本的解释器，例如 Python。

至少，您需要指定一个使用标准 WASI 版本 wasi_snapshot_preview1（又名 wasip1）编译的 Wasm 二进制文件，通常缩写为 wasi。

注意： 如果在 Go 1.21+ 中编译，这是 GOOS=wasip1 GOARCH=wasm。在 TinyGo、Rust 和 Zig 中，这是目标 wasm32-wasi。

您还可以重用现有的二进制文件。例如，Wasm 语言运行时分发已经编译为 WASI 的解释器（包括 PHP、Python 和 Ruby）。

Wasm 二进制文件可以从 URL 加载。例如，URL file://rewrite.wasm 会从进程的当前目录加载 rewrite.wasm。在 Kubernetes 上，请参阅如何：将 Pod 卷挂载到 Dapr sidecar以配置可以包含 Wasm 二进制文件的文件系统挂载。也可以从远程 URL 获取 Wasm 二进制文件。在这种情况下，URL 必须准确指向一个 Wasm 二进制文件。例如：

Zeebe JobWorker 绑定说明

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

组件配置格式

要配置 Zeebe JobWorker 绑定，请创建一个类型为 bindings.zeebe.jobworker 的组件。请参考本指南了解如何创建和应用绑定配置。

有关 Zeebe JobWorker 的详细文档，请查看此处。

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"

元数据字段说明

字段	必需	绑定支持	详情	示例
`gatewayAddr`	Y	输入	Zeebe 网关地址	`"localhost:26500"`
`gatewayKeepAlive`	N	输入	设置发送到网关的保活消息频率，默认为 45 秒	`"45s"`
`usePlainTextConnection`	N	输入	是否使用纯文本连接	`"true"`, `"false"`
`caCertificatePath`	N	输入	CA 证书的路径	`"/path/to/ca-cert"`
`workerName`	N	输入	激活作业的 worker 名称，主要用于日志记录	`"products-worker"`
`workerTimeout`	N	输入	在此调用后返回的作业在超时之前不会被另一个调用激活，默认为 5 分钟	`"5m"`
`requestTimeout`	N	输入	请求将在至少一个作业被激活或达到 requestTimeout 后完成。如果 requestTimeout = 0，则使用默认超时。如果 requestTimeout < 0，则禁用长轮询，即使没有作业被激活，请求也会立即完成。默认为 10 秒	`"30s"`
`jobType`	Y	输入	在 BPMN 流程中定义的作业类型（例如 `<zeebe:taskDefinition type="fetch-products" />`）	`"fetch-products"`
`maxJobsActive`	N	输入	设置此 worker 同时激活的最大作业数，默认为 32	`"32"`
`concurrency`	N	输入	完成作业的最大并发 goroutines 数量，默认为 4	`"4"`
`pollInterval`	N	输入	设置轮询新作业的最大间隔，默认为 100 毫秒	`"100ms"`
`pollThreshold`	N	输入	设置缓冲激活作业的阈值以便轮询新作业，即阈值 * maxJobsActive，默认为 0.3	`"0.3"`
`fetchVariables`	N	输入	要获取的作业变量列表；如果为空，则在作业激活时返回作用域内的所有可见变量	`"productId"`, `"productName"`, `"productKey"`
`autocomplete`	N	输入	指示作业是否应自动完成。如果未设置，默认情况下所有作业将自动完成。如果 worker 应手动完成或因业务错误或事件而失败作业，请禁用此选项	`"true"`, `"false"`
`retryBackOff`	N	输入	作业失败时下次重试的回退超时	`15s`
`direction`	N	输入	绑定的方向	`"input"`

绑定支持

此组件支持输入绑定接口。

Zeebe 命令绑定说明

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

组件格式说明

要配置 Zeebe 命令绑定，请创建一个类型为 bindings.zeebe.command 的组件。请参考本指南了解如何创建和应用绑定配置。

有关 Zeebe 的更多信息，请查看此处的文档。

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"

元数据字段说明

字段	必需	绑定支持	详情	示例
`gatewayAddr`	Y	输出	Zeebe 网关地址	`"localhost:26500"`
`gatewayKeepAlive`	N	输出	设置发送到网关的保活消息的频率。默认为 45 秒	`"45s"`
`usePlainTextConnection`	N	输出	是否使用纯文本连接	`"true"`, `"false"`
`caCertificatePath`	N	输出	CA 证书的路径	`"/path/to/ca-cert"`

绑定支持

此组件支持以下操作的输出绑定：

阿里云 Tablestore 绑定组件规范

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

组件格式

要配置阿里云 Tablestore 绑定组件，请创建一个类型为 bindings.alicloud.tablestore 的组件。请参阅本指南了解如何创建和应用 secretstore 配置。有关如何引用 secrets以获取和使用 Dapr 组件的机密信息，请参阅此指南。

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]"

警告

上述示例中使用了明文字符串作为机密信息。建议使用 secret store 来存储机密信息，详情请参阅此处。

元数据字段说明

字段	必需	绑定支持	说明	示例
`endpoint`	是	输出	阿里云 Tablestore 的访问端点。	https://tablestore-cn-hangzhou.aliyuncs.com
`accessKeyID`	是	输出	访问密钥 ID。
`accessKey`	是	输出	访问密钥。
`instanceName`	是	输出	实例名称。
`tableName`	是	输出	表名称。

绑定功能支持

此组件支持以下操作的输出绑定：

阿里云钉钉绑定组件规范

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

配置 Dapr 组件

要配置阿里云钉钉绑定组件，请创建一个类型为 bindings.dingtalk.webhook 的组件。请参阅本指南了解如何创建和应用 secretstore 配置。有关如何引用和使用 Dapr 组件的密钥，请参阅此指南。

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"

警告

上述示例中使用了明文字符串作为密钥。建议使用密钥存储来存储密钥，详情请参阅此处。

元数据字段说明

字段	必需	绑定支持	详情	示例
`id`	是	输入/输出	唯一标识符	`"test_webhook_id"`
`url`	是	输入/输出	钉钉的 Webhook 地址	`"https://oapi.dingtalk.com/robot/send?access_token=******"`
`secret`	否	输入/输出	钉钉 Webhook 的密钥	`"****************"`
`direction`	否	输入/输出	绑定的方向	`"input"`, `"output"`, `"input, output"`

绑定支持

此组件支持输入和输出绑定接口。

阿里云对象存储服务绑定指南

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

组件格式

要配置阿里云对象存储绑定，请创建一个类型为 bindings.alicloud.oss 的组件。请参阅本指南了解如何创建和应用secretstore配置。有关如何引用secrets以检索和使用Dapr组件的secret，请参阅此指南。

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]"

警告

上述示例中使用了明文字符串作为secrets。建议使用secret store来存储secrets，详情请见此处。

元数据字段说明

字段	必需	绑定功能	详情	示例
`endpoint`	是	输出	阿里云OSS端点。	https://oss-cn-hangzhou.aliyuncs.com
`accessKeyID`	是	输出	访问密钥ID凭证。
`accessKey`	是	输出	访问密钥凭证。
`bucket`	是	输出	存储桶的名称。

绑定功能

此组件支持输出绑定，具有以下操作：

阿里云日志存储服务绑定指南

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

组件配置格式

要配置一个阿里云SLS绑定，请创建一个类型为bindings.alicloud.sls的组件。请参阅本指南以了解如何创建和应用绑定配置。

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]"

元数据字段说明

字段	必需	绑定支持	详情
`AccessKeyID`	是	输出	访问密钥ID凭证。
`AccessKeySecret`	是	输出	访问密钥凭证secret
`Endpoint`	是	输出	阿里云SLS端点。

绑定支持

该组件支持输出绑定，具有以下操作：

create: 创建对象

请求格式

要执行日志存储操作，请使用POST方法调用绑定，并使用以下JSON主体：

{
 "metadata":{
 "project":"your-sls-project-name",
 "logstore":"your-sls-logstore-name",
 "topic":"your-sls-topic-name",
 "source":"your-sls-source"
 },
 "data":{
 "custome-log-filed":"any other log info"
 },
 "operation":"create"
}

注意

请确保在元数据属性中提供"project"，“logstore”，“topic"和"source"的值。

示例

curl -X POST -H "Content-Type: application/json" -d "{\"metadata\":{\"project\":\"project-name\",\"logstore\":\"logstore-name\",\"topic\":\"topic-name\",\"source\":\"source-name\"},\"data\":{\"log-filed\":\"log info\"}" http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

curl -X POST -H "Content-Type: application/json" -d '{"metadata":{"project":"project-name","logstore":"logstore-name","topic":"topic-name","source":"source-name"},"data":{"log-filed":"log info"}' http://localhost:<dapr-port>/v1.0/bindings/<binding-name>

响应格式

由于阿里云SLS生产者API是异步的，因此此绑定没有直接响应（没有回调接口来接收成功或失败的响应，只有在失败时会记录到控制台日志）。

本地存储绑定规范

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

组件格式

要配置本地存储绑定，创建一个类型为 bindings.localstorage 的组件。请参阅本指南以了解如何创建和应用绑定配置。

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

元数据字段规范

字段	必需	绑定支持	详情	示例
`rootPath`	Y	输出	文件可读写的根路径	`"/temp/files"`

绑定支持

此组件支持输出绑定，具有以下操作：

create : 创建文件
get : 获取文件
list : 列出文件
delete : 删除文件

创建文件

要执行创建文件操作，使用 POST 方法调用本地存储绑定，并使用以下 JSON 正文：

注意：默认情况下，会生成一个随机的 UUID 作为文件名。请参阅下文的元数据支持以设置自定义文件名。

{
 "operation": "create",
 "data": "YOUR_CONTENT"
}

示例

将文本保存到随机生成的 UUID 文件

在 Windows 上，使用 cmd 提示符（PowerShell 有不同的转义机制）

华为 OBS 绑定规范

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

组件格式

要配置华为对象存储服务（OBS）的输出绑定，创建一个类型为 bindings.huawei.obs 的组件。请参阅本指南以了解如何创建和应用绑定配置。

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

警告

上述示例中，secret 使用了明文字符串。建议使用 secret 存储来存储 secret，如此处所述。

规范元数据字段

字段	必需	绑定支持	详情	示例
`bucket`	Y	输出	要写入的华为 OBS 存储桶名称	`"My-OBS-Bucket"`
`endpoint`	Y	输出	特定的华为 OBS 端点	`"obs.cn-north-4.myhuaweicloud.com"`
`accessKey`	Y	输出	访问此资源的华为访问密钥（AK）	`"************"`
`secretKey`	Y	输出	访问此资源的华为密钥（SK）	`"************"`
`region`	N	输出	存储桶的特定华为区域	`"cn-north-4"`

绑定功能

此组件支持以下输出绑定操作：