Azure RealTimeTrigger

Azure RealTimeTrigger
Certified
Consume messages in real time from an Azure Service Bus queue

Fires one execution per message received from the configured Service Bus queue.

yaml
type: io.kestra.plugin.azure.servicebus.RealTimeTrigger

Examples

yaml
id: service_bus_listen
namespace: company.team

tasks:
  - id: log_messages
    type: io.kestra.plugin.core.log.Log
    message: "Trigger body: {{trigger.body}}."

triggers:
  - id: watch
    type: io.kestra.plugin.azure.servicebus.RealTimeTrigger
    queueName: your-queue-name
    tenantId: "{{ secret('AZURE_TENANT_ID') }}"
    clientId: "{{ secret('AZURE_CLIENT_ID') }}"
    clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"

Properties

allowConcurrent boolean

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

clientId string

clientSecret string

connectionString string

Connection string for the Service Bus namespace or entity; overrides client credential authentication

pemCertificate string

queueName string

Name of the Service Bus queue to connect to; queueName and topicName are mutually exclusive

receiveMode string

Possible Values

PEEK_LOCKRECEIVE_AND_DELETE

Service Bus receive mode; defaults to PEEK_LOCK

serdeType string

DefaultSTRING

Possible Values

STRINGJSON

Serializer/deserializer for the message body; defaults to STRING

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

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

subQueue string

Possible Values

NONEDEAD_LETTER_QUEUETRANSFER_DEAD_LETTER_QUEUE

SubQueue type to connect to (e.g., DEAD_LETTER_QUEUE)

subscriptionName string

Subscription name when connecting to a topic

tenantId string

topicName string

Name of the Service Bus topic to connect to; queueName and topicName are mutually exclusive

when string

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

Outputs

applicationProperties object

Application properties

body object

Body

messageId string

Message id

subject string

Subject

timeToLive string

Formatduration

Time to live