Azure Event Hubs 绑定规范

关于 Azure Event Hubs 绑定组件的详细文档

组件格式

要配置 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"

规范元数据字段

字段 必需 绑定支持 详情 示例
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 的文档。

绑定支持

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

  • create: 发布新消息到 Azure Event Hubs

输入绑定到 Azure IoT Hub 事件

Azure IoT Hub 提供了一个与 Event Hubs 兼容的端点，因此 Dapr 应用可以创建输入绑定以使用 Event Hubs 绑定组件读取 Azure IoT Hub 事件。

由 Azure IoT Hub 设备创建的设备到云事件将包含额外的IoT Hub 系统属性，Dapr 的 Azure Event Hubs 绑定将在响应元数据中返回以下内容：

系统属性名称 描述 & 路由查询关键字
iothub-connection-auth-generation-id 发送消息的设备的 connectionDeviceGenerationId。请参阅 IoT Hub 设备身份属性。
iothub-connection-auth-method 用于认证发送消息的设备的 connectionAuthMethod。
iothub-connection-device-id 发送消息的设备的 deviceId。请参阅 IoT Hub 设备身份属性。
iothub-connection-module-id 发送消息的设备的 moduleId。请参阅 IoT Hub 设备身份属性。
iothub-enqueuedtime 设备到云消息被 IoT Hub 接收的 enqueuedTime，格式为 RFC3339。
message-id 用户可设置的 AMQP messageId。

例如，HTTP Read() 响应的头部将包含：

{
  'user-agent': 'fasthttp',
  'host': '127.0.0.1:3000',
  'content-type': 'application/json',
  'content-length': '120',
  'iothub-connection-device-id': 'my-test-device',
  'iothub-connection-auth-generation-id': '637618061680407492',
  'iothub-connection-auth-method': '{"scope":"module","type":"sas","issuer":"iothub","acceptingIpFilterRule":null}',
  'iothub-connection-module-id': 'my-test-module-a',
  'iothub-enqueuedtime': '2021-07-13T22:08:09Z',
  'message-id': 'my-custom-message-id',
  'x-opt-sequence-number': '35',
  'x-opt-enqueued-time': '2021-07-13T22:08:09Z',
  'x-opt-offset': '21560',
  'traceparent': '00-4655608164bc48b985b42d39865f3834-ed6cf3697c86e7bd-01'
}

相关链接