Azure Event Hubs binding spec

Detailed documentation on the Azure Event Hubs binding component

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

Setup Dapr component

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4. name: <NAME>
  5. namespace: <NAMESPACE>
  6. spec:
  7. type: bindings.azure.eventhubs
  8. version: v1
  9. metadata:
  10. - name: connectionString # Azure EventHubs connection string
  11. value: "Endpoint=sb://****"
  12. - name: consumerGroup # EventHubs consumer group
  13. value: "group1"
  14. - name: storageAccountName # Azure Storage Account Name
  15. value: "accountName"
  16. - name: storageAccountKey # Azure Storage Account Key
  17. value: "accountKey"
  18. - name: storageContainerName # Azure Storage Container Name
  19. value: "containerName"
  20. - name: partitionID # (Optional) PartitionID to send and receive events
  21. value: 0
  • connectionString is the EventHubs connection string. Note that this is the EventHub itself and not the EventHubs namespace. Make sure to use the child EventHub shared access policy connection string.
  • consumerGroup is the name of an EventHubs Consumer Group to listen on.
  • storageAccountName Is the name of the account of the Azure Storage account to persist checkpoints data on.
  • storageAccountKey Is the account key for the Azure Storage account to persist checkpoints data on.
  • storageContainerName Is the name of the container in the Azure Storage account to persist checkpoints data on.
  • partitionID (Optional) ID of the partition to send and receive events.

Warning

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

Output Binding Supported Operations

  • create

Related links

Last modified February 16, 2021: Merge pull request #1235 from dapr/update-v0.11 (b4e9fbb)