Skip to content

Azure Service Bus Connector Reference

This documentation provides a reference guide for the Azure Service Bus Connector. The Azure Service Bus connector enables you to connect to an Azure Service Bus namespace and perform administration, message sending, and message receiving operations. Click an operation name to see parameter details and samples on how to use it.

Connection Configurations

The Azure Service Bus Connector supports three connection types, each corresponding to a different client: Administrator, MessageSender, and MessageReceiver. Each connection type requires its own initialization configuration.


Administrator Connection

Administrator

The Administrator connection allows you to manage Azure Service Bus resources such as queues, topics, subscriptions, and rules.

Parameter Name Display Name Description Required Default Value
connectionName Connection Name A unique name to identify this connection. Yes -
connectionString Connection String The connection string for the Azure Service Bus namespace. Obtain this from the Azure portal under Shared Access Policies. Yes -

Sample configuration

<asb.init>
    <connectionType>ADMINISTRATOR</connectionType>
    <name>asbAdminConnection</name>
    <connectionString>Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xxxxxxxx</connectionString>
</asb.init>

MessageSender Connection

MessageSender

The MessageSender connection allows you to send messages to a specific queue or topic.

Parameter Name Display Name Description Required Default Value
connectionName Connection Name A unique name to identify this connection. Yes -
connectionString Connection String The connection string for the Azure Service Bus namespace. Yes -
entityType Entity Type The type of Service Bus entity to send messages to. Possible values: QUEUE, TOPIC. Yes -
topicOrQueueName Topic or Queue Name The name of the queue or topic to send messages to. Yes -
AMQP Retry Options
amqpRetryOptions_maxRetries Max Retries The maximum number of retry attempts. No -
amqpRetryOptions_delay Delay The initial delay between retry attempts in seconds. No -
amqpRetryOptions_maxDelay Max Delay The maximum delay between retry attempts in seconds. No -
amqpRetryOptions_tryTimeout Try Timeout The timeout per retry attempt in seconds. No -
amqpRetryOptions_retryMode Retry Mode The retry mode to use. Possible values: EXPONENTIAL, FIXED. No -

Sample configuration

<asb.init>
    <connectionType>MESSAGE_SENDER</connectionType>
    <name>asbSenderConnection</name>
    <connectionString>Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xxxxxxxx</connectionString>
    <entityType>QUEUE</entityType>
    <topicOrQueueName>myQueue</topicOrQueueName>
</asb.init>

MessageReceiver Connection

MessageReceiver

The MessageReceiver connection allows you to receive messages from a specific queue or topic subscription.

Parameter Name Display Name Description Required Default Value
connectionName Connection Name A unique name to identify this connection. Yes -
connectionString Connection String The connection string for the Azure Service Bus namespace. Yes -
entityConfigDataType Entity Config Type The type of entity to receive messages from. Possible values: TopicSubsConfig (for topic subscriptions), QueueConfig (for queues). Yes -
Topic Subscription Configuration (when entityConfigDataType is TopicSubsConfig)
entityConfig_topicName Topic Name The name of the topic to receive messages from. Yes (for TopicSubsConfig) -
entityConfig_subscriptionName Subscription Name The name of the subscription to receive messages from. Yes (for TopicSubsConfig) -
Queue Configuration (when entityConfigDataType is QueueConfig)
entityConfig_queueName Queue Name The name of the queue to receive messages from. Yes (for QueueConfig) -
Receive Options
receiveMode Receive Mode The mode for receiving messages. Possible values:
  • PEEK_LOCK: Messages are locked for the receiver but not removed from the queue. The receiver must complete, abandon, defer, or dead-letter the message.
  • RECEIVE_AND_DELETE: Messages are immediately removed from the queue upon receipt.
No PEEK_LOCK
maxAutoLockRenewDuration Max Auto Lock Renew Duration The maximum duration (in seconds) for automatically renewing message locks. No -
AMQP Retry Options
amqpRetryOptions_maxRetries Max Retries The maximum number of retry attempts. No -
amqpRetryOptions_delay Delay The initial delay between retry attempts in seconds. No -
amqpRetryOptions_maxDelay Max Delay The maximum delay between retry attempts in seconds. No -
amqpRetryOptions_tryTimeout Try Timeout The timeout per retry attempt in seconds. No -
amqpRetryOptions_retryMode Retry Mode The retry mode to use. Possible values: EXPONENTIAL, FIXED. No -

Sample configuration (Queue)

<asb.init>
    <connectionType>MESSAGE_RECEIVER</connectionType>
    <name>asbReceiverConnection</name>
    <connectionString>Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xxxxxxxx</connectionString>
    <entityConfigDataType>QueueConfig</entityConfigDataType>
    <entityConfig_queueName>myQueue</entityConfig_queueName>
    <receiveMode>PEEK_LOCK</receiveMode>
</asb.init>

Sample configuration (Topic Subscription)

<asb.init>
    <connectionType>MESSAGE_RECEIVER</connectionType>
    <name>asbReceiverConnection</name>
    <connectionString>Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=xxxxxxxx</connectionString>
    <entityConfigDataType>TopicSubsConfig</entityConfigDataType>
    <entityConfig_topicName>myTopic</entityConfig_topicName>
    <entityConfig_subscriptionName>mySubscription</entityConfig_subscriptionName>
    <receiveMode>PEEK_LOCK</receiveMode>
</asb.init>

Operations

The following operations allow you to work with the Azure Service Bus Connector. Click an operation name to see parameter details and samples on how to use it.

Administrator Operations

The following operations require an Administrator connection.

Queue Operations

createQueue

Creates a new queue in the Azure Service Bus namespace.

Parameter Name Display Name Description Required Default Value
queueName Queue Name The name of the queue to create. Yes -
Queue Options
autoDeleteOnIdle_seconds Auto Delete On Idle (Seconds) The idle interval after which the queue is automatically deleted (seconds component). No -
autoDeleteOnIdle_nanoseconds Auto Delete On Idle (Nanoseconds) The idle interval after which the queue is automatically deleted (nanoseconds component). No -
defaultMessageTimeToLive_seconds Default Message TTL (Seconds) The default time-to-live for messages in the queue (seconds component). No -
defaultMessageTimeToLive_nanoseconds Default Message TTL (Nanoseconds) The default time-to-live for messages in the queue (nanoseconds component). No -
duplicateDetectionHistoryTimeWindow_seconds Duplicate Detection Window (Seconds) The duration of the duplicate detection history (seconds component). No -
duplicateDetectionHistoryTimeWindow_nanoseconds Duplicate Detection Window (Nanoseconds) The duration of the duplicate detection history (nanoseconds component). No -
lockDuration_seconds Lock Duration (Seconds) The lock duration for messages received from the queue (seconds component). No -
lockDuration_nanoseconds Lock Duration (Nanoseconds) The lock duration for messages received from the queue (nanoseconds component). No -
maxDeliveryCount Max Delivery Count The maximum number of delivery attempts before a message is dead-lettered. No -
maxMessageSizeInKilobytes Max Message Size (KB) The maximum message size in kilobytes. No -
maxSizeInMegabytes Max Size (MB) The maximum size of the queue in megabytes. No -
status Status The status of the queue. Possible values: Active, Disabled, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Restoring, Unknown. No -
userMetadata User Metadata Custom metadata associated with the queue. No -
enableBatchedOperations Enable Batched Operations Whether to enable batched operations on the queue. No -
deadLetteringOnMessageExpiration Dead Lettering On Message Expiration Whether to move expired messages to the dead-letter sub-queue. No -
requiresDuplicateDetection Requires Duplicate Detection Whether the queue requires duplicate detection. No -
enablePartitioning Enable Partitioning Whether to partition the queue across multiple message brokers. No -
requiresSession Requires Session Whether the queue requires sessions for message processing. No -
forwardTo Forward To The name of the queue or topic to forward messages to. No -
forwardDeadLetteredMessagesTo Forward Dead Lettered Messages To The name of the queue or topic to forward dead-lettered messages to. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.createQueue configKey="asbAdminConnection">
    <queueName>myQueue</queueName>
    <maxDeliveryCount>10</maxDeliveryCount>
    <defaultMessageTimeToLive_seconds>3600</defaultMessageTimeToLive_seconds>
    <enableBatchedOperations>true</enableBatchedOperations>
    <responseVariable>asb_createQueue_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.createQueue>
getQueue

Retrieves the properties of a queue.

Parameter Name Display Name Description Required Default Value
queueName Queue Name The name of the queue to retrieve. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.getQueue configKey="asbAdminConnection">
    <queueName>myQueue</queueName>
    <responseVariable>asb_getQueue_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.getQueue>
updateQueue

Updates the properties of an existing queue.

Parameter Name Display Name Description Required Default Value
queueName Queue Name The name of the queue to update. Yes -
Update Options
autoDeleteOnIdle_seconds Auto Delete On Idle (Seconds) The idle interval after which the queue is automatically deleted (seconds component). No -
autoDeleteOnIdle_nanoseconds Auto Delete On Idle (Nanoseconds) The idle interval after which the queue is automatically deleted (nanoseconds component). No -
defaultMessageTimeToLive_seconds Default Message TTL (Seconds) The default time-to-live for messages (seconds component). No -
defaultMessageTimeToLive_nanoseconds Default Message TTL (Nanoseconds) The default time-to-live for messages (nanoseconds component). No -
duplicateDetectionHistoryTimeWindow_seconds Duplicate Detection Window (Seconds) The duration of the duplicate detection history (seconds component). No -
duplicateDetectionHistoryTimeWindow_nanoseconds Duplicate Detection Window (Nanoseconds) The duration of the duplicate detection history (nanoseconds component). No -
lockDuration_seconds Lock Duration (Seconds) The lock duration for messages (seconds component). No -
lockDuration_nanoseconds Lock Duration (Nanoseconds) The lock duration for messages (nanoseconds component). No -
maxDeliveryCount Max Delivery Count The maximum number of delivery attempts before a message is dead-lettered. No -
maxMessageSizeInKilobytes Max Message Size (KB) The maximum message size in kilobytes. No -
maxSizeInMegabytes Max Size (MB) The maximum size of the queue in megabytes. No -
status Status The status of the queue. Possible values: Active, Disabled, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Restoring, Unknown. No -
userMetadata User Metadata Custom metadata associated with the queue. No -
enableBatchedOperations Enable Batched Operations Whether to enable batched operations on the queue. No -
deadLetteringOnMessageExpiration Dead Lettering On Message Expiration Whether to move expired messages to the dead-letter sub-queue. No -
requiresDuplicateDetection Requires Duplicate Detection Whether the queue requires duplicate detection. No -
enablePartitioning Enable Partitioning Whether to partition the queue across multiple message brokers. No -
requiresSession Requires Session Whether the queue requires sessions for message processing. No -
forwardTo Forward To The name of the queue or topic to forward messages to. No -
forwardDeadLetteredMessagesTo Forward Dead Lettered Messages To The name of the queue or topic to forward dead-lettered messages to. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.updateQueue configKey="asbAdminConnection">
    <queueName>myQueue</queueName>
    <maxDeliveryCount>15</maxDeliveryCount>
    <status>Active</status>
    <responseVariable>asb_updateQueue_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.updateQueue>
deleteQueue

Deletes a queue from the Azure Service Bus namespace.

Parameter Name Display Name Description Required Default Value
queueName Queue Name The name of the queue to delete. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.deleteQueue configKey="asbAdminConnection">
    <queueName>myQueue</queueName>
    <responseVariable>asb_deleteQueue_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.deleteQueue>
listQueues

Lists all queues in the Azure Service Bus namespace.

Parameter Name Display Name Description Required Default Value
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.listQueues configKey="asbAdminConnection">
    <responseVariable>asb_listQueues_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.listQueues>
queueExists

Checks whether a queue exists in the Azure Service Bus namespace.

Parameter Name Display Name Description Required Default Value
queueName Queue Name The name of the queue to check. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.queueExists configKey="asbAdminConnection">
    <queueName>myQueue</queueName>
    <responseVariable>asb_queueExists_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.queueExists>

Topic Operations

createTopic

Creates a new topic in the Azure Service Bus namespace.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic to create. Yes -
Topic Options
autoDeleteOnIdle_seconds Auto Delete On Idle (Seconds) The idle interval after which the topic is automatically deleted (seconds component). No -
autoDeleteOnIdle_nanoseconds Auto Delete On Idle (Nanoseconds) The idle interval after which the topic is automatically deleted (nanoseconds component). No -
defaultMessageTimeToLive_seconds Default Message TTL (Seconds) The default time-to-live for messages sent to the topic (seconds component). No -
defaultMessageTimeToLive_nanoseconds Default Message TTL (Nanoseconds) The default time-to-live for messages sent to the topic (nanoseconds component). No -
duplicateDetectionHistoryTimeWindow_seconds Duplicate Detection Window (Seconds) The duration of the duplicate detection history (seconds component). No -
duplicateDetectionHistoryTimeWindow_nanoseconds Duplicate Detection Window (Nanoseconds) The duration of the duplicate detection history (nanoseconds component). No -
lockDuration_seconds Lock Duration (Seconds) The lock duration for messages (seconds component). No -
lockDuration_nanoseconds Lock Duration (Nanoseconds) The lock duration for messages (nanoseconds component). No -
maxDeliveryCount Max Delivery Count The maximum number of delivery attempts. No -
maxMessageSizeInKilobytes Max Message Size (KB) The maximum message size in kilobytes. No -
maxSizeInMegabytes Max Size (MB) The maximum size of the topic in megabytes. No -
status Status The status of the topic. Possible values: Active, Disabled, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Restoring, Unknown. No -
userMetadata User Metadata Custom metadata associated with the topic. No -
enableBatchedOperations Enable Batched Operations Whether to enable batched operations on the topic. No -
deadLetteringOnMessageExpiration Dead Lettering On Message Expiration Whether to move expired messages to the dead-letter sub-queue. No -
requiresDuplicateDetection Requires Duplicate Detection Whether the topic requires duplicate detection. No -
enablePartitioning Enable Partitioning Whether to partition the topic across multiple message brokers. No -
requiresSession Requires Session Whether the topic requires sessions. No -
supportOrdering Support Ordering Whether the topic supports message ordering. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.createTopic configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <enableBatchedOperations>true</enableBatchedOperations>
    <supportOrdering>true</supportOrdering>
    <responseVariable>asb_createTopic_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.createTopic>
getTopic

Retrieves the properties of a topic.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic to retrieve. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.getTopic configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <responseVariable>asb_getTopic_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.getTopic>
updateTopic

Updates the properties of an existing topic.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic to update. Yes -
Update Options
autoDeleteOnIdle_seconds Auto Delete On Idle (Seconds) The idle interval after which the topic is automatically deleted (seconds component). No -
autoDeleteOnIdle_nanoseconds Auto Delete On Idle (Nanoseconds) The idle interval after which the topic is automatically deleted (nanoseconds component). No -
defaultMessageTimeToLive_seconds Default Message TTL (Seconds) The default time-to-live for messages (seconds component). No -
defaultMessageTimeToLive_nanoseconds Default Message TTL (Nanoseconds) The default time-to-live for messages (nanoseconds component). No -
duplicateDetectionHistoryTimeWindow_seconds Duplicate Detection Window (Seconds) The duration of the duplicate detection history (seconds component). No -
duplicateDetectionHistoryTimeWindow_nanoseconds Duplicate Detection Window (Nanoseconds) The duration of the duplicate detection history (nanoseconds component). No -
maxDeliveryCount Max Delivery Count The maximum number of delivery attempts. No -
maxMessageSizeInKilobytes Max Message Size (KB) The maximum message size in kilobytes. No -
maxSizeInMegabytes Max Size (MB) The maximum size of the topic in megabytes. No -
status Status The status of the topic. Possible values: Active, Disabled, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Restoring, Unknown. No -
userMetadata User Metadata Custom metadata associated with the topic. No -
enableBatchedOperations Enable Batched Operations Whether to enable batched operations. No -
deadLetteringOnMessageExpiration Dead Lettering On Message Expiration Whether to move expired messages to the dead-letter sub-queue. No -
requiresDuplicateDetection Requires Duplicate Detection Whether the topic requires duplicate detection. No -
enablePartitioning Enable Partitioning Whether to partition the topic across multiple message brokers. No -
requiresSession Requires Session Whether the topic requires sessions. No -
supportOrdering Support Ordering Whether the topic supports message ordering. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.updateTopic configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <supportOrdering>true</supportOrdering>
    <status>Active</status>
    <responseVariable>asb_updateTopic_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.updateTopic>
deleteTopic

Deletes a topic from the Azure Service Bus namespace.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic to delete. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.deleteTopic configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <responseVariable>asb_deleteTopic_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.deleteTopic>
listTopics

Lists all topics in the Azure Service Bus namespace.

Parameter Name Display Name Description Required Default Value
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.listTopics configKey="asbAdminConnection">
    <responseVariable>asb_listTopics_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.listTopics>
topicExists

Checks whether a topic exists in the Azure Service Bus namespace.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic to check. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.topicExists configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <responseVariable>asb_topicExists_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.topicExists>

Subscription Operations

createSubscription

Creates a new subscription for a topic.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic to create the subscription for. Yes -
subscriptionName Subscription Name The name of the subscription to create. Yes -
Subscription Options
autoDeleteOnIdle_seconds Auto Delete On Idle (Seconds) The idle interval after which the subscription is automatically deleted (seconds component). No -
autoDeleteOnIdle_nanoseconds Auto Delete On Idle (Nanoseconds) The idle interval after which the subscription is automatically deleted (nanoseconds component). No -
defaultMessageTimeToLive_seconds Default Message TTL (Seconds) The default time-to-live for messages (seconds component). No -
defaultMessageTimeToLive_nanoseconds Default Message TTL (Nanoseconds) The default time-to-live for messages (nanoseconds component). No -
lockDuration_seconds Lock Duration (Seconds) The lock duration for messages (seconds component). No -
lockDuration_nanoseconds Lock Duration (Nanoseconds) The lock duration for messages (nanoseconds component). No -
maxDeliveryCount Max Delivery Count The maximum number of delivery attempts before a message is dead-lettered. No -
status Status The status of the subscription. Possible values: Active, Disabled, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming, Restoring, Unknown. No -
userMetadata User Metadata Custom metadata associated with the subscription. No -
enableBatchedOperations Enable Batched Operations Whether to enable batched operations. No -
deadLetteringOnMessageExpiration Dead Lettering On Message Expiration Whether to move expired messages to the dead-letter sub-queue. No -
deadLetteringOnFilterEvaluationExceptions Dead Lettering On Filter Evaluation Exceptions Whether to move messages to the dead-letter sub-queue when filter evaluation fails. No -
requiresSession Requires Session Whether the subscription requires sessions. No -
forwardTo Forward To The name of the queue or topic to forward messages to. No -
forwardDeadLetteredMessagesTo Forward Dead Lettered Messages To The name of the queue or topic to forward dead-lettered messages to. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.createSubscription configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <maxDeliveryCount>10</maxDeliveryCount>
    <responseVariable>asb_createSubscription_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.createSubscription>
getSubscription

Retrieves the properties of a subscription.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription to retrieve. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.getSubscription configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <responseVariable>asb_getSubscription_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.getSubscription>
updateSubscription

Updates the properties of an existing subscription.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription to update. Yes -
Update Options
autoDeleteOnIdle_seconds Auto Delete On Idle (Seconds) The idle interval after which the subscription is automatically deleted (seconds component). No -
autoDeleteOnIdle_nanoseconds Auto Delete On Idle (Nanoseconds) The idle interval after which the subscription is automatically deleted (nanoseconds component). No -
defaultMessageTimeToLive_seconds Default Message TTL (Seconds) The default time-to-live for messages (seconds component). No -
defaultMessageTimeToLive_nanoseconds Default Message TTL (Nanoseconds) The default time-to-live for messages (nanoseconds component). No -
lockDuration_seconds Lock Duration (Seconds) The lock duration for messages (seconds component). No -
lockDuration_nanoseconds Lock Duration (Nanoseconds) The lock duration for messages (nanoseconds component). No -
maxDeliveryCount Max Delivery Count The maximum number of delivery attempts. No -
status Status The status of the subscription. No -
userMetadata User Metadata Custom metadata associated with the subscription. No -
enableBatchedOperations Enable Batched Operations Whether to enable batched operations. No -
deadLetteringOnMessageExpiration Dead Lettering On Message Expiration Whether to move expired messages to the dead-letter sub-queue. No -
deadLetteringOnFilterEvaluationExceptions Dead Lettering On Filter Evaluation Exceptions Whether to move messages to the dead-letter sub-queue when filter evaluation fails. No -
forwardTo Forward To The name of the queue or topic to forward messages to. No -
forwardDeadLetteredMessagesTo Forward Dead Lettered Messages To The name of the queue or topic to forward dead-lettered messages to. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.updateSubscription configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <maxDeliveryCount>15</maxDeliveryCount>
    <responseVariable>asb_updateSubscription_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.updateSubscription>
deleteSubscription

Deletes a subscription from a topic.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription to delete. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.deleteSubscription configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <responseVariable>asb_deleteSubscription_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.deleteSubscription>
listSubscriptions

Lists all subscriptions for a topic.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic to list subscriptions for. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.listSubscriptions configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <responseVariable>asb_listSubscriptions_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.listSubscriptions>
subscriptionExists

Checks whether a subscription exists for a topic.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription to check. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.subscriptionExists configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <responseVariable>asb_subscriptionExists_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.subscriptionExists>

Rule Operations

createRule

Creates a new rule for a subscription to filter messages.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription. Yes -
ruleName Rule Name The name of the rule to create. Yes -
Rule Options
rule_filter Filter The SQL filter expression for the rule (e.g., priority = 'high'). No -
rule_action Action The SQL action expression for the rule (e.g., SET sys.label = 'important'). No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.createRule configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <ruleName>highPriorityRule</ruleName>
    <rule_filter>priority = 'high'</rule_filter>
    <rule_action>SET sys.label = 'important'</rule_action>
    <responseVariable>asb_createRule_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.createRule>
getRule

Retrieves the properties of a rule.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription. Yes -
ruleName Rule Name The name of the rule to retrieve. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.getRule configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <ruleName>highPriorityRule</ruleName>
    <responseVariable>asb_getRule_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.getRule>
updateRule

Updates the properties of an existing rule.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription. Yes -
ruleName Rule Name The name of the rule to update. Yes -
Rule Options
rule_filter Filter The SQL filter expression for the rule. No -
rule_action Action The SQL action expression for the rule. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.updateRule configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <ruleName>highPriorityRule</ruleName>
    <rule_filter>priority = 'critical'</rule_filter>
    <responseVariable>asb_updateRule_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.updateRule>
deleteRule

Deletes a rule from a subscription.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription. Yes -
ruleName Rule Name The name of the rule to delete. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.deleteRule configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <ruleName>highPriorityRule</ruleName>
    <responseVariable>asb_deleteRule_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.deleteRule>
listRules

Lists all rules for a subscription.

Parameter Name Display Name Description Required Default Value
topicName Topic Name The name of the topic. Yes -
subscriptionName Subscription Name The name of the subscription to list rules for. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.listRules configKey="asbAdminConnection">
    <topicName>myTopic</topicName>
    <subscriptionName>mySubscription</subscriptionName>
    <responseVariable>asb_listRules_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.listRules>

MessageSender Operations

The following operations require a MessageSender connection.

send

Sends a single message to the configured queue or topic with full message properties.

Parameter Name Display Name Description Required Default Value
Message Properties
body Body The message body content. Yes -
contentType Content Type The content type of the message (e.g., application/json, text/plain). No -
messageId Message ID A unique identifier for the message. No -
to To The destination address of the message. No -
replyTo Reply To The address to reply to. No -
replyToSessionId Reply To Session ID The session ID for reply messages. No -
label Label An application-specific label for the message. No -
sessionId Session ID The session identifier for session-aware entities. No -
correlationId Correlation ID The correlation identifier for correlating messages. No -
partitionKey Partition Key The partition key for routing messages to specific partitions. No -
timeToLive Time To Live The message time-to-live in seconds. No -
applicationProperties_properties Application Properties Custom application properties as key-value pairs. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.send configKey="asbSenderConnection">
    <body>Hello, Azure Service Bus!</body>
    <contentType>text/plain</contentType>
    <timeToLive>3600</timeToLive>
    <responseVariable>asb_send_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.send>
sendPayload

Sends a message with just the payload content to the configured queue or topic.

Parameter Name Display Name Description Required Default Value
messagePayload Message Payload The payload content to send. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.sendPayload configKey="asbSenderConnection">
    <messagePayload>{${payload.message}}</messagePayload>
    <responseVariable>asb_sendPayload_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.sendPayload>
sendBatch

Sends a batch of messages to the configured queue or topic.

Parameter Name Display Name Description Required Default Value
messageCount Message Count The number of messages in the batch. Yes -
messages Messages The array of messages to send. Each message can include body, contentType, messageId, and other message properties. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.sendBatch configKey="asbSenderConnection">
    <messageCount>2</messageCount>
    <messages>[{"body": "Message 1"}, {"body": "Message 2"}]</messages>
    <responseVariable>asb_sendBatch_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.sendBatch>
schedule

Sends a message to be enqueued at a scheduled time.

Parameter Name Display Name Description Required Default Value
Message Properties
body Body The message body content. Yes -
contentType Content Type The content type of the message. No -
messageId Message ID A unique identifier for the message. No -
timeToLive Time To Live The message time-to-live in seconds. No -
applicationProperties_properties Application Properties Custom application properties as key-value pairs. No -
Scheduled Enqueue Time
year Year The year of the scheduled enqueue time. Yes -
month Month The month of the scheduled enqueue time (1-12). Yes -
day Day The day of the scheduled enqueue time. Yes -
hour Hour The hour of the scheduled enqueue time (0-23). Yes -
minute Minute The minute of the scheduled enqueue time (0-59). Yes -
second Second The second of the scheduled enqueue time. No 0
timeAbbrev Time Zone The time zone abbreviation (e.g., UTC, Z). No -
Output
responseVariable Response Variable The name of the variable to store the operation output. Returns the sequence number of the scheduled message. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.schedule configKey="asbSenderConnection">
    <body>Scheduled message</body>
    <contentType>text/plain</contentType>
    <year>2026</year>
    <month>4</month>
    <day>1</day>
    <hour>10</hour>
    <minute>30</minute>
    <second>0</second>
    <timeAbbrev>UTC</timeAbbrev>
    <responseVariable>asb_schedule_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.schedule>
cancel

Cancels a previously scheduled message using its sequence number.

Parameter Name Display Name Description Required Default Value
sequenceNumber Sequence Number The sequence number of the scheduled message to cancel. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.cancel configKey="asbSenderConnection">
    <sequenceNumber>12345</sequenceNumber>
    <responseVariable>asb_cancel_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.cancel>
close (Sender)

Closes the MessageSender connection.

Parameter Name Display Name Description Required Default Value
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.close configKey="asbSenderConnection">
    <responseVariable>asb_close_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.close>

MessageReceiver Operations

The following operations require a MessageReceiver connection.

Receive Operations

receive

Receives a single message from the configured queue or subscription.

Parameter Name Display Name Description Required Default Value
serverWaitTime Server Wait Time The maximum time (in seconds) the server waits for a message to arrive before returning. No 60
deadLettered Dead Lettered Whether to receive from the dead-letter sub-queue instead of the main queue. No false
Output
returnType Message Body Type Expected type of the message body. Determines how the body is bound when receiving the message. Possible values: json, xml, text. No json
responseVariable Output Variable Name The name of the variable to store the received message. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.receive configKey="asbReceiverConnection">
    <serverWaitTime>60</serverWaitTime>
    <returnType>json</returnType>
    <responseVariable>asb_receive_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.receive>
receiveBatch

Receives a batch of messages from the configured queue or subscription.

Parameter Name Display Name Description Required Default Value
maxMessageCount Max Message Count The maximum number of messages to receive in the batch. Yes -
serverWaitTime Server Wait Time The maximum time (in seconds) the server waits for messages to arrive. No -
deadLettered Dead Lettered Whether to receive from the dead-letter sub-queue. No false
Output
responseVariable Response Variable The name of the variable to store the received messages. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.receiveBatch configKey="asbReceiverConnection">
    <maxMessageCount>10</maxMessageCount>
    <serverWaitTime>60</serverWaitTime>
    <responseVariable>asb_receiveBatch_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.receiveBatch>
receivePayload

Receives the message from the configured queue or subscription directly bound to the configured output type. This operation can only be used in Receive and Delete mode and is not compatible with Peek Lock mode.

Parameter Name Display Name Description Required Default Value
serverWaitTime Server Wait Time The maximum time (in seconds) the server waits for a message to arrive. No 60
deadLettered Dead Lettered Whether to receive from the dead-letter sub-queue. No false
Output
T Output Type Type to bind the received message body to. Possible values: json (for JSON payloads), xml (for XML), string (for plain-text/binary content). Important: This must match the format in which the message was originally sent. For example, if the message was sent as JSON, you must select json - selecting a different type will result in a binding error. No json
responseVariable Output Variable Name The name of the variable to store the received payload. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.receivePayload configKey="asbReceiverConnection">
    <T>json</T>
    <serverWaitTime>60</serverWaitTime>
    <responseVariable>asb_receivePayload_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.receivePayload>
receiveDeferred

Receives a deferred message by its sequence number.

Parameter Name Display Name Description Required Default Value
sequenceNumber Sequence Number The sequence number of the deferred message to receive. Yes -
Output
responseVariable Response Variable The name of the variable to store the received message. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.receiveDeferred configKey="asbReceiverConnection">
    <sequenceNumber>12345</sequenceNumber>
    <responseVariable>asb_receiveDeferred_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.receiveDeferred>

Message Settlement and Lock Management Operations

These operations are used with the PEEK_LOCK receive mode to settle received messages or manage message locks.

Important

Message settlement operations (complete, abandon, defer, deadLetter) and the renewLock operation must be used in the same integration flow as the receive or receiveDeferred operation that retrieved the message. You cannot receive a message in one request and settle or renew its lock in a separate request. The receive and settlement/lock operations must be part of a single message processing flow.

complete

Marks a message as successfully processed and removes it from the queue.

Parameter Name Display Name Description Required Default Value
sequenceNumber Sequence Number The sequence number of the message to complete. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.complete configKey="asbReceiverConnection">
    <sequenceNumber>{${vars.asb_receive_1.payload.sequenceNumber}}</sequenceNumber>
    <responseVariable>asb_complete_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.complete>
abandon

Releases the lock on a message, making it available for other receivers.

Parameter Name Display Name Description Required Default Value
sequenceNumber Sequence Number The sequence number of the message to abandon. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.abandon configKey="asbReceiverConnection">
    <sequenceNumber>{${vars.asb_receive_1.payload.sequenceNumber}}</sequenceNumber>
    <responseVariable>asb_abandon_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.abandon>
defer

Defers a message for later retrieval using its sequence number.

Parameter Name Display Name Description Required Default Value
sequenceNumber Sequence Number The sequence number of the message to defer. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.defer configKey="asbReceiverConnection">
    <sequenceNumber>{${vars.asb_receive_1.payload.sequenceNumber}}</sequenceNumber>
    <responseVariable>asb_defer_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.defer>
deadLetter

Moves a message to the dead-letter sub-queue with an optional reason and description.

Parameter Name Display Name Description Required Default Value
sequenceNumber Sequence Number The sequence number of the message to dead-letter. Yes -
deadLetterReason Dead Letter Reason The reason for dead-lettering the message. No -
deadLetterErrorDescription Dead Letter Error Description A description of the error that caused the message to be dead-lettered. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.deadLetter configKey="asbReceiverConnection">
    <sequenceNumber>{${vars.asb_receive_1.payload.sequenceNumber}}</sequenceNumber>
    <deadLetterReason>Processing failed</deadLetterReason>
    <deadLetterErrorDescription>Invalid message format</deadLetterErrorDescription>
    <responseVariable>asb_deadLetter_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.deadLetter>
renewLock

Renews the lock on a message to extend the processing time. Only applicable in PEEK_LOCK mode.

Parameter Name Display Name Description Required Default Value
sequenceNumber Sequence Number The sequence number of the message whose lock should be renewed. Yes -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.renewLock configKey="asbReceiverConnection">
    <sequenceNumber>{${vars.asb_receive_1.payload.sequenceNumber}}</sequenceNumber>
    <responseVariable>asb_renewLock_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.renewLock>

Connection Operations

close (Receiver)

Closes the MessageReceiver connection.

Parameter Name Display Name Description Required Default Value
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.close configKey="asbReceiverConnection">
    <responseVariable>asb_close_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.close>

Message Settlement (Only For Event Integration)

The following operations are used exclusively within the mediation sequence of the Azure Service Bus Inbound Endpoint (event integration). They record a settlement decision for the message currently being processed by the inbound endpoint. Unlike the MessageReceiver settlement operations above, these do not require a connection configuration or a sequence number — the inbound endpoint automatically correlates the decision to the in-flight message.

Note

These operations are only applicable when the inbound endpoint's receiveMode is PEEK_LOCK. In RECEIVE_AND_DELETE mode, the message is already removed on receipt and settlement is not needed.

consumer_complete

Records a complete decision — the message is removed from the queue (successful processing).

Parameter Name Display Name Description Required Default Value
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.consumer_complete>
    <responseVariable>asb_consumer_complete_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.consumer_complete>
consumer_abandon

Records an abandon decision — the message lock is released so the message becomes available for redelivery.

Parameter Name Display Name Description Required Default Value
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.consumer_abandon>
    <responseVariable>asb_consumer_abandon_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.consumer_abandon>
consumer_defer

Records a defer decision — the message is deferred for later retrieval by sequence number.

Parameter Name Display Name Description Required Default Value
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.consumer_defer>
    <responseVariable>asb_consumer_defer_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.consumer_defer>
consumer_deadLetter

Records a dead-letter decision — the message is moved to the dead-letter sub-queue, optionally with a reason and error description.

Parameter Name Display Name Description Required Default Value
deadLetterReason Dead Letter Reason The reason for dead-lettering the message. No -
deadLetterErrorDescription Dead Letter Error Description A description of the error that caused the message to be dead-lettered. No -
Output
responseVariable Response Variable The name of the variable to store the operation output. No -
overwriteBody Overwrite Message Body Whether to replace the message body with the operation output. No false

Sample configuration

<asb.consumer_deadLetter>
    <deadLetterReason>DEADLETTERED_BY_RECEIVER</deadLetterReason>
    <deadLetterErrorDescription>Fault in processing</deadLetterErrorDescription>
    <responseVariable>asb_consumer_deadLetter_1</responseVariable>
    <overwriteBody>false</overwriteBody>
</asb.consumer_deadLetter>