Consume
Consume events from Azure Event Hubs.
Consume events from Azure Event Hubs.
Consume events from Azure Event Hubs.
type: "io.kestra.plugin.azure.eventhubs.Consume"Examples
Consume data events from Azure EventHubs.
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') }}"
Properties
checkpointStoreProperties*Requiredobject
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.
eventHubName*Requiredstring
The event hub to read from.
namespace*Requiredstring
Namespace name of the event hub to connect to.
bodyDeserializerstring
STRINGSTRINGBINARYIONJSONThe Deserializer to be used for serializing the event value.
bodyDeserializerPropertiesobject
{}The config properties to be passed to the Deserializer.
clientMaxRetriesintegerstring
5The maximum number of retry attempts before considering a client operation to have failed.
clientRetryDelayintegerstring
500The maximum permissible delay between retry attempts in milliseconds.
connectionStringstring
Connection string of the Storage Account.
consumerGroupstring
$DefaultThe consumer group.
customEndpointAddressstring
Custom endpoint address when connecting to the Event Hubs service.
enqueueTimestring
The ISO Datetime to be used when PartitionStartingPosition is configured to INSTANT.
Configs in key/value pairs.
maxBatchSizePerPartitionintegerstring
50The maximum number of events to consume per event hub partition per poll.
maxDurationstring
PT10SdurationThe max time duration to wait to receive events from all partitions.
maxWaitTimePerPartitionstring
PT5SdurationThe max time duration to wait to receive a batch of events up to the maxBatchSizePerPartition.
partitionStartingPositionstring
EARLIESTEARLIESTLATESTINSTANTThe starting position.
sasTokenstring
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.
Outputs
eventsCountinteger
Number of events consumed from Azure Event Hubs.
uristring
uriURI of a kestra internal storage file containing the messages.
Metrics
records.consumedcounter
The total number of events consumed.
