Contact Us 1-800-596-4880
  1. Homepage
  2. Azure Service Bus Connector (3.7)

  3. Azure Service Bus Connector Reference

All Connectors

Azure Service Bus Connector 3.7 Reference

Anypoint Connector for Azure Service Bus (Azure Service Bus Connector) enables message integration with Azure Service Bus on the cloud.

Configurations

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Send Correlation Strategy

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Whether to specify a correlation ID when publishing messages. This applies both for custom correlation IDs specified at the operation level and for default correlation IDs taken from the current event.

AUTO

Zone Id

String

Zone ID property is used to identify the rules used to convert between an Instant and LocalDateTime. If the Zone ID equals Z, UTC is used. If the Zone ID is not specified, the system default Zone ID is used.

Connection Types

Shared Access Signature

The SAS connection type uses the SAS Key Name and the SAS Key to generate a token, which is used by the Azure Service Bus SDK to establish the connection to the Service Bus instance.

Parameters
Name Type Description Default Value Required

Service namespace

String

The namespace contains the resources to which the connector can establish a connection.

x

Shared access key name

String

Name of the Shared Access key

x

Shared access key

String

Shared Access key

x

Response Timeout

Number

Amount of time to wait for the operation to execute before throwing an error. This value is qualified by the Response Timeout TimeUnit.

30

Response Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout value

SECONDS

Minimum Retry Backoff

Number

The minimum backoff interval for the retry. This must be a positive integer and setting it to zero results in ineffective retry behavior.

1

Minimum Retry Backoff Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Minimum Retry Backoff value

SECONDS

Maximum Retry Backoff

Number

The maximum backoff interval for the retry

30

Maximum Retry Backoff Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Maximum Retry Backoff value

SECONDS

Retries

Number

The maximum amount of retries that the connector will attempt

10

Increased Wait On Server Busy (Deprecated)

Number

Amount of additional time to wait whenever there’s a ServerBusyException

0

Increased Wait On Server Busy Time Unit (Deprecated)

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Increased wait on server busy value

SECONDS

Cache Producers

Boolean

When checked the producer for a given destination is cached

true
Azure Active Directory

The Azure Active Directory (Azure AD) connection type provides role-based access control (RBAC), in which users can use Azure AD app registrations to generate a Client Id and a Client Secret for authentication.

Parameters
Name Type Description Default Value Required

Service namespace

String

Namespace that contains resources to which the connector establishes a connection.

x

Azure endpoint

String

Constructs the complete URL that the connector uses to establish a connection.

servicebus.windows.net

Tenant Id

String

Tenant in which the app registration and the Azure Service Bus instance are running.

x

Client Id

String

ID of the app registration.

x

Client Secret

String

Secret key of the app registration.

x

Response Timeout

Number

How long to wait for an operation to execute before throwing an error.

30

Response Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Minimum Retry Backoff

Number

Minimum backoff interval for the retry. This must be a positive integer and setting it to zero results in ineffective retry behavior.

1

Minimum Retry Backoff Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Minimum Retry Backoff field.

SECONDS

Maximum Retry Backoff

Number

Maximum backoff interval for the retry.

30

Maximum Retry Backoff Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Maximum Retry Backoff field.

SECONDS

Retries

Number

Maximum number of retries that the connector attempts.

10

Increased Wait On Server Busy (Deprecated)

Number

Amount of additional time to wait whenever there’s a ServerBusyException

0

Increased Wait On Server Busy Time Unit (Deprecated)

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Increased wait on server busy value

SECONDS

Cache Producers

Boolean

When checked the producer for a given destination is cached

true

List of Operations

List of Sources

Operations

Abandon

<azure-service-bus-messaging:abandon-message>

Abandon message stored in the current receiver (This is equivalent to a NACK operation). This operation can be used only from inside a flow that also includes a Message Listener Source operation.

Parameters

Name Type Description Default Value Required

Lock Token

String

Lock Token from the message to abandon. This represents a UUID for a message.

x

For Configurations

Throws

  • AZURE-SERVICE-BUS-MESSAGING:LOCK_TOKEN_NOT_FOUND

  • AZURE-SERVICE-BUS-MESSAGING:TOKEN_EXPIRED

  • AZURE-SERVICE-BUS-MESSAGING:OPERATION_TIMEOUT

  • AZURE-SERVICE-BUS-MESSAGING:ANY

Complete

<azure-service-bus-messaging:complete-message>

This operation completes a message received from within a flow with a Message Listener operation in the current source. This is the same as an acknowledge.

Parameters

Name Type Description Default Value Required

Lock Token

String

Lock Token from the message to ACK. This represents a UUID for a message.

x

For Configurations

Throws

  • AZURE-SERVICE-BUS-MESSAGING:LOCK_TOKEN_NOT_FOUND

  • AZURE-SERVICE-BUS-MESSAGING:TOKEN_EXPIRED

  • AZURE-SERVICE-BUS-MESSAGING:OPERATION_TIMEOUT

  • AZURE-SERVICE-BUS-MESSAGING:ANY

Dead Letter

<azure-service-bus-messaging:dead-letter-message>

Sends the message associated with the Lock Token to the entity’s native dead-letter sub-queue, recording an optional reason and description on the dead-lettered message. This operation can be used only from inside a flow that also includes a Message Listener source.

Parameters

Name Type Description Default Value Required

Lock Token

String

Lock Token from the message to dead-letter. This represents a UUID for a message.

x

Dead Letter Reason

String

Reason recorded on the dead-lettered message describing why it was dead-lettered

Dead Letter Description

String

Human-readable description recorded on the dead-lettered message providing further detail about the dead-lettering

Properties To Modify

Object

Map of properties to stamp onto the dead-lettered message as application properties

For Configurations

Throws

  • AZURE-SERVICE-BUS-MESSAGING:LOCK_TOKEN_NOT_FOUND

  • AZURE-SERVICE-BUS-MESSAGING:TOKEN_EXPIRED

  • AZURE-SERVICE-BUS-MESSAGING:OPERATION_TIMEOUT

  • AZURE-SERVICE-BUS-MESSAGING:ANY

Receive

<azure-service-bus-messaging:receive>

This operation receives a message from a specific queue or subscription. In this version of the connector, only Immediate Receive Mode (RECEIVEANDDELETE) is supported.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Destination Name

String

Name of the destination from which messages are received

x

Subscription Name

String

Name of the subscription from which messages are received

NONE

Output

Type

Binary

Attributes Type

Attributes Without Lock Token

For Configurations

Throws

  • AZURE-SERVICE-BUS-MESSAGING:OPERATION_TIMEOUT

  • AZURE-SERVICE-BUS-MESSAGING:CONNECTIVITY

  • AZURE-SERVICE-BUS-MESSAGING:DESTINATION_NOT_FOUND

  • AZURE-SERVICE-BUS-MESSAGING:ANY

Receive Batch

<azure-service-bus-messaging:receive-batch>

This operation attempts to receive up to maxMessageCount messages from a specific queue or subscription. In this version of the connector, only Immediate Receive Mode (RECEIVEANDDELETE) is supported.

Due to the design of the Azure-provided SDK that Azure Service Bus Connector uses, the actual number of messages received may be fewer or more than the maxMessageCount specified. This behavior occurs because the Azure-provided SDK treats maxMessageCount as an approximation rather than a strict limit. Additionally, a null value may be returned if the operation exceeds the specified timeout or if there are no more messages to receive.

To ensure that all available messages are received, you might need to call this operation multiple times.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Destination Name

String

Name of the destination from which messages are received

x

Subscription Name

String

Name of the subscription from which messages are received

NONE

Max Message Count

Number

Maximum number of messages that can be received

x

Output

Type

Array of Message of [Binary] payload and [Attributes Without Lock Token] attributes

For Configurations

Throws

  • AZURE-SERVICE-BUS-MESSAGING:OPERATION_TIMEOUT

  • AZURE-SERVICE-BUS-MESSAGING:CONNECTIVITY

  • AZURE-SERVICE-BUS-MESSAGING:DESTINATION_NOT_FOUND

  • AZURE-SERVICE-BUS-MESSAGING:ANY

Send

<azure-service-bus-messaging:send>

This operation sends a message to a Queue or Topic.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Destination Name

String

Destination name to which to send the message

x

Body

Binary

Body of this message

#[payload]

Message Id

String

Message identifier is an application-defined value that uniquely identifies the message and its payload

Send Correlation Strategy

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Lists the possible strategies to determine the correlation ID to send on an outbound operation that supports correlation

Correlation Id

String

Allows an application to specify a context for the message for the purposes of correlation

Message Session Id

String

Session identifier for a session-aware entity

Reply To

String

Name of the destination to which to send the message reply

Reply To Session Id

String

The ID of the Session associated with the message.

Label

String

Enables the application to indicate the purpose of the message to the receiver

Partition Key

String

For partitioned entities, setting this value enables assigning related messages to the same internal partition, so that the submission sequence order is correctly recorded.

Time To Live

Number

Relative duration, in milliseconds, after which the message expires, starting from the instant the message is accepted and stored by the broker

Time To Live Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Write Concern Timeout

SECONDS

Scheduled Enqueue Time Utc

DateTime

Defines the UTC instant at which the message is logically enqueued, sequenced, and therefore made available for retrieval

Properties

Object

Map of user application properties set on the message

For Configurations

Throws

  • AZURE-SERVICE-BUS-MESSAGING:PAYLOAD_SIZE_EXCEEDED

  • AZURE-SERVICE-BUS-MESSAGING:OPERATION_TIMEOUT

  • AZURE-SERVICE-BUS-MESSAGING:INVALID_SIGNATURE

  • AZURE-SERVICE-BUS-MESSAGING:NOT_ENOUGH_PERMITS

  • AZURE-SERVICE-BUS-MESSAGING:CONNECTIVITY

  • AZURE-SERVICE-BUS-MESSAGING:DESTINATION_NOT_FOUND

  • AZURE-SERVICE-BUS-MESSAGING:INVALID_PARAMS

  • AZURE-SERVICE-BUS-MESSAGING:ANY

Send batch of messages

<azure-service-bus-messaging:send-message-batch>

This operation sends a list of messages to a queue or topic.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Destination Name

String

Destination name to which to send the message

x

Messages

Array of Object

Messages to send

#[payload]

For Configurations

Throws

  • AZURE-SERVICE-BUS-MESSAGING:PAYLOAD_SIZE_EXCEEDED

  • AZURE-SERVICE-BUS-MESSAGING:OPERATION_TIMEOUT

  • AZURE-SERVICE-BUS-MESSAGING:INVALID_SIGNATURE

  • AZURE-SERVICE-BUS-MESSAGING:NOT_ENOUGH_PERMITS

  • AZURE-SERVICE-BUS-MESSAGING:CONNECTIVITY

  • AZURE-SERVICE-BUS-MESSAGING:DESTINATION_NOT_FOUND

  • AZURE-SERVICE-BUS-MESSAGING:INVALID_PARAMS

  • AZURE-SERVICE-BUS-MESSAGING:ANY

Sources

Message Listener

<azure-service-bus-messaging:message-listener>

Listens for messages from an Azure Service Bus queue or topic subscription. The source consumes messages and dispatches them to the flow for processing. Supports PeekLock and ReceiveAndDelete receive modes, session-aware receivers, configurable auto-lock renewal, and dead-letter queue consumption.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Ack Mode

Enumeration, one of:

  • IMMEDIATE

  • AUTO

  • MANUAL

Specifies the way to acknowledge received messages. AUTO and MANUAL uses the PeekLock mode. IMMEDIATE uses the ReceiveAndDelete mode.

x

Prefetch Count

Number

When Prefetch is enabled, the receiver quietly acquires more messages, up to the PrefetchCount limit, beyond what the application initially requested. Setting this value to zero (0) disables prefetching.

0

Number Of Consumers

Number

Number of concurrent consumers to use to receive messages

Enable Auto Lock Renewal

Boolean

Specifies whether the source should automatically renew message locks for session-aware queues, which prevents lock expiration during long-running message processing. The message lock renewal duration defaults to 5 minutes (hardcoded per Azure SDK). Flows exceeding 5 minutes of processing time experience lock expiration.

true

Max Auto Lock Renew Duration

String

Maximum duration for which the SDK keeps renewing the message lock automatically, expressed as an ISO-8601 duration (for example, PT5M, PT30M, PT2H). Only applies when Enable Auto Lock Renewal is enabled. Raise it for flows whose processing legitimately exceeds the broker-side lock duration. Longer values delay broker redelivery if the consumer hangs.

PT5M

Primary Node Only

Boolean

Whether this source should be executed only on the primary node when running in a cluster

true

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Destination Name

String

Name of the destination from which messages are received

x

Subscription Name

String

Name of the subscription from which messages are received

NONE

Consume From Dead Letter Queue

Boolean

When enabled, the listener consumes messages from the entity’s native dead-letter sub-queue ($deadletterqueue) instead of the main entity. Cannot be combined with a Session Id, since dead-letter queue messages are session-less.

false

Inactivity Timeout Minutes

Number

Inactivity timeout, in minutes. If no message is received within this period, the listener triggers a reconnection. Set to 0 to disable inactivity monitoring.

0

Reconnection Strategy

Retry strategy in case of connectivity errors

Session Id

String

Session identifier for a session-aware entity

Output

Type

Binary

Attributes Type

Azure Message Attributes

For Configurations

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Azure Message Attributes

Field Type Description Default Value Required

Correlation Id

String

Specifies a context for the message for correlation purposes

Dead Letter Error Description

String

Read-only, human-readable error description recorded on the dead-lettered message. Only populated when consuming from a dead-letter sub-queue.

Dead Letter Reason

String

Read-only reason recorded on the dead-lettered message describing why it was dead-lettered. Only populated when consuming from a dead-letter sub-queue.

Dead Letter Source

String

Read-only property that indicates the entity in which the message was unable to be delivered

Delivery Count

Number

Number of times message delivery was attempted. When a message lock expires, or when the message is abandoned by the receiver, delivery count increases.

Enqueued Time Utc

LocalDateTime

The instant in UTC time when the message is accepted and stored in the entity

Expires At

LocalDateTime

The instant in UTC time when the message is marked for removal and no longer able to be retrieved from the entity because of its expiration, which is controlled by Time to Live.

Label

String

States the purpose of the message to the receiver

Lock Token

String

Lock token for the message. Used for MANUAL acknowledgment operations (Complete, Abandon, Dead Letter).

Locked Until Utc

LocalDateTime

UTC instant until which the message is kept locked in the queue or subscription

Message Id

String

Uniquely identifies the message and its payload

Partition Key

String

Used for partitioned entities to enable related messages to be assigned to the same internal partition so that submission sequence order of the messages is recorded correctly

Properties

Object

Reply To

String

Path for where the receiver of the message can reply

Reply To Session Id

String

Specify the specific session ID for where the application can receive messages

Scheduled Enqueue Time Utc

LocalDateTime

Schedule the UTC time for when the message will appear in the queue

Sequence Number

Number

Unique 64-bit integer that is assigned to a message when the message is accepted and stored by the broker, and which functions as the message’s true ID

Session Id

String

Specifies the session association of the message for session-aware entities

Time To Live

Duration

Relative duration after which time the message expires, starting at the moment the message is accepted and stored by the broker, as defined in Enqueued Time UTC

To

String

Reserved for future use in routing scenarios and currently ignored by the broker. Can be used by applications in rule-driven, auto-forward chaining interactions to specify the intended logical destination of the message

Via Partition Key

String

Selects the transfer queue partition when a message is sent through a transfer queue in the scope of a transaction

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returns. If not set, the default is SHA-256.

SHA-256

Id Expression

String

Defines one or more expressions to use to determine when a message is redelivered. This property can be set only if useSecureHash is false.

Object Store

Object Store

Object store where the redelivery counter for each message is stored

Attributes Without Lock Token

Field Type Description Default Value Required

Correlation Id

String

Specifies a context for the message for correlation purposes

Dead Letter Error Description

String

Read-only, human-readable error description recorded on the dead-lettered message. Only populated when consuming from a dead-letter sub-queue.

Dead Letter Reason

String

Read-only reason recorded on the dead-lettered message describing why it was dead-lettered. Only populated when consuming from a dead-letter sub-queue.

Dead Letter Source

String

Read-only property that indicates the entity in which the message was unable to be delivered

Delivery Count

Number

Number of times message delivery was attempted. When a message lock expires, or when the message is abandoned by the receiver, delivery count increases.

Enqueued Time Utc

LocalDateTime

The instant in UTC time when the message is accepted and stored in the entity

Expires At

LocalDateTime

The instant in UTC time when the message is marked for removal and no longer able to be retrieved from the entity because of its expiration, which is controlled by Time to Live.

Label

String

States the purpose of the message to the receiver

Locked Until Utc

LocalDateTime

UTC instant until which the message is kept locked in the queue or subscription

Message Id

String

Uniquely identifies the message and its payload

Partition Key

String

Used for partitioned entities to enable related messages to be assigned to the same internal partition so that submission sequence order of the messages is recorded correctly

Properties

Object

Reply To

String

Path for where the receiver of the message can reply

Reply To Session Id

String

Specify the specific session ID for where the application can receive messages

Scheduled Enqueue Time Utc

LocalDateTime

Schedule the UTC time for when the message will appear in the queue

Sequence Number

Number

Unique 64-bit integer that is assigned to a message when the message is accepted and stored by the broker, and which functions as the message’s true ID

Session Id

String

Specifies the session association of the message for session-aware entities

Time To Live

Duration

Relative duration after which time the message expires, starting at the moment the message is accepted and stored by the broker, as defined in Enqueued Time UTC

To

String

Reserved for future use in routing scenarios and currently ignored by the broker. Can be used by applications in rule-driven, auto-forward chaining interactions to specify the intended logical destination of the message

Via Partition Key

String

Selects the transfer queue partition when a message is sent through a transfer queue in the scope of a transaction

See Also

Back to top