RealtimeTrigger

Consume a message in real-time from a Azure Event Hubs and create one execution per message.

If you would like to consume multiple messages processed within a given time frame and process them in batch, you can use the io.kestra.plugin.azure.eventhubs.Trigger instead.

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

Trigger flow based on events received from Azure Event Hubs in real-time.

yaml
id: azure_eventhubs_realtime_trigger
namespace: company.team

tasks:
  - id: log
    type: io.kestra.plugin.core.log.Log
    message: Hello there! I received {{ trigger.body }} from Azure EventHubs!

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

Dynamic YES

The event hub to read from.

Dynamic YES

Namespace name of the event hub to connect to.

Dynamic YES

Default STRING

Possible Values

STRINGBINARYIONJSON

The Deserializer to be used for serializing the event value.

Dynamic YES

Default {}

The config properties to be passed to the Deserializer.

Configs in key/value pairs.

SubType string

Dynamic YES

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.

Dynamic YES

Default 5

Dynamic YES

Default 500

SubType

Dynamic NO

List of conditions in order to limit the flow trigger.

Dynamic YES

Connection string of the Storage Account.

Dynamic YES

Default $Default

The consumer group.

Dynamic YES

Custom endpoint address when connecting to the Event Hubs service.

Dynamic YES

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

Configs in key/value pairs.

Dynamic YES

Default EARLIEST

Possible Values

EARLIESTLATESTINSTANT

The starting position.

Dynamic YES

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.

Dynamic YES

Shared Key access key for authenticating requests.

Dynamic YES

Shared Key account name for authenticating requests.

SubType string

Dynamic NO

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

​Realtime​Trigger

RealtimeTrigger