Consume

Consume events from Azure Event Hubs.

yaml
type: "io.kestra.plugin.azure.eventhubs.Consume"

Consume data events from Azure EventHubs.

yaml
id: azure_eventhubs_consume_data_events
namespace: company.team

tasks:
  - id: consume_from_eventhub
    type: io.kestra.plugin.azure.eventhubs.Consume
    eventHubName: my_eventhub
    namespace: my_eventhub_namespace
    connectionString: "{{ secret('EVENTHUBS_CONNECTION') }}"
    bodyDeserializer: JSON
    consumerGroup: "$Default"
    checkpointStoreProperties:
      containerName: kestra
      connectionString: "{{ secret('BLOB_CONNECTION') }}"

The event hub to read from.

Namespace name of the event hub to connect to.

Default STRING

Possible Values

STRINGBINARYIONJSON

The Deserializer to be used for serializing the event value.

Default {}

The config properties to be passed to the Deserializer.

Configs in key/value pairs.

SubType string

Default {}

The config properties to be used for configuring the BlobCheckpointStore.

Azure Event Hubs Checkpoint Store can be used for storing checkpoints while processing events from Azure Event Hubs.

Default 5

The maximum number of retry attempts before considering a client operation to have failed.

Default 500

The maximum permissible delay between retry attempts in milliseconds.

Connection string of the Storage Account.

Default $Default

The consumer group.

Custom endpoint address when connecting to the Event Hubs service.

The ISO Datetime to be used when PartitionStartingPosition is configured to INSTANT.

Configs in key/value pairs.

Default 50

The maximum number of events to consume per event hub partition per poll.

Default PT10S

Format duration

The max time duration to wait to receive events from all partitions.

Default PT5S

Format duration

The max time duration to wait to receive a batch of events up to the maxBatchSizePerPartition.

Default EARLIEST

Possible Values

EARLIESTLATESTINSTANT

The starting position.

The SAS token to use for authenticating requests.

This string should only be the query parameters (with or without a leading '?') and not a full URL.

Shared Key access key for authenticating requests.

Shared Key account name for authenticating requests.

Number of events consumed from Azure Event Hubs.

Format uri

URI of a kestra internal storage file containing the messages.

​Consume

Consume