Azure Consume

Azure Consume
Certified
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.

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

Examples

yaml
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)

clientId 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

DefaultPT10S

Maximum 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.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

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

Payload serializer

Serializer/deserializer for the message body; defaults to STRING

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

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

Formaturi

File URI containing consumed messages

NetBox

Enterprise

Enterprise NetBox tasks to create, update, and query devices, IP addresses, and sites over the NetBox API.

Infrastructure

Clickhouse

Tasks that connect to ClickHouse via JDBC to run queries and loads.

Data

Azure ConsumeCertifiedConsume messages from an Azure Service Bus queue

More Plugins in this Category

NetBox

Clickhouse

Azure Consume
Certified
Consume messages from an Azure Service Bus queue