Azure Event Hubs binding spec

Detailed documentation on the Azure Event Hubs binding component

Component format

To setup 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>
  namespace: <NAMESPACE>
spec:
  type: bindings.azure.eventhubs
  version: v1
  metadata:
  - name: connectionString      # Azure EventHubs connection string
    value: "Endpoint=sb://****"
  - name: consumerGroup         # EventHubs consumer group
    value: "group1"
  - name: storageAccountName    # Azure Storage Account Name
    value: "accountName"
  - name: storageAccountKey     # Azure Storage Account Key
    value: "accountKey"
  - name: storageContainerName  # Azure Storage Container Name
    value: "containerName"
  - name: partitionID           # (Optional) PartitionID to send and receive events
    value: 0

Spec metadata fields

FieldRequiredBinding supportDetailsExample
connectionStringYOutputThe 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"Endpoint=sb://****"
consumerGroupYOutputThe name of an EventHubs Consumer Group to listen on"group1"
storageAccountNameYOutputThe name of the account of the Azure Storage account to persist checkpoints data on"accountName"
storageAccountKeyYOutputThe account key for the Azure Storage account to persist checkpoints data on"accountKey"
storageContainerNameYOutputThe name of the container in the Azure Storage account to persist checkpoints data on"contianerName"
partitionIDNOutputID of the partition to send and receive events0

Binding support

This component supports output binding with the following operations:

  • create
Last modified May 22, 2021: docs: clean up white noise (#1491) (fe1ab8eb)