Azure Consume
CertifiedConsume messages from an Azure Service Bus queue
Azure Consume
Consume messages from an Azure Service Bus queue
Reads messages from the configured queue until the max records or duration is reached and writes them to internal storage.
type: io.kestra.plugin.azure.servicebus.ConsumeExamples
id: azure_service_bus_consume_example
namespace: company.team
tasks:
- id: create
type: io.kestra.plugin.azure.servicebus.Consume
maxMessages: 100
maxReceiveDuration: PT30S
queueName: your-queue-name
tenantId: "{{ secret('AZURE_TENANT_ID') }}"
clientId: "{{ secret('AZURE_CLIENT_ID') }}"
clientSecret: "{{ secret('AZURE_CLIENT_SECRET') }}"
Properties
tenantId *string
Azure AD tenant ID (GUID)
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150clientId string
Client ID of the Azure AD application
Application (client) ID used for service principal authentication.
clientSecret string
Client secret for the Azure AD application
Secret value associated with the client ID; store in a Kestra secret.
connectionString string
Connection string for the Service Bus namespace or entity; overrides client credential authentication
maxMessages integerstring
Maximum messages to consume before returning; leave empty for no cap
maxReceiveDuration string
PT10SMaximum time to wait for messages before returning; Consume defaults to PT10S and Trigger must provide a value
pemCertificate string
PEM-encoded certificate content for client authentication
PEM text for certificate-based auth; alternative to clientSecret.
queueName string
Name of the Service Bus queue to connect to; queueName and topicName are mutually exclusive
receiveMode string
PEEK_LOCKRECEIVE_AND_DELETEService Bus receive mode; defaults to PEEK_LOCK
serdeType string
STRINGSTRINGJSONPayload serializer
Serializer/deserializer for the message body; defaults to STRING
subQueue string
NONEDEAD_LETTER_QUEUETRANSFER_DEAD_LETTER_QUEUESubQueue type to connect to (e.g., DEAD_LETTER_QUEUE)
subscriptionName string
Subscription name when connecting to a topic
topicName string
Name of the Service Bus topic to connect to; queueName and topicName are mutually exclusive
Outputs
count integer
Number of consumed rows
uri string
uriFile URI containing consumed messages
