String
Azure Service Bus Connector 3.0 Reference - Mule 4
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 |
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:
|
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 |
||
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
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:
|
A time unit that qualifies the Response Timeout value |
SECONDS |
|
Minimum Retry Backoff |
Number |
The minimum backoff interval for the retry |
0 |
|
Minimum Retry Backoff Time Unit |
Enumeration, one of:
|
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:
|
A time unit which qualifies the Maximum Retry Backoff value |
SECONDS |
|
Retries |
Number |
The maximum amount of retries that the connector will attempt |
10 |
|
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to |
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.
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.
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 |
|
Output Mime Type |
String |
MIME type of the payload that this operation outputs |
||
Output Encoding |
String |
Encoding of the payload that this operation outputs |
||
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 |
|
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors |
Receive Batch
<azure-service-bus-messaging:receive-batch>
This operation receives a maximum of maxMessageCount messages 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 |
|
Max Message Count |
Number |
Maximum number of messages that can be received |
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 |
|
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors |
Output
Type |
Array of Message of [Binary] payload and [Attributes Without Lock Token] attributes |
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:
|
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 |
||
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:
|
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 |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors |
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:RETRY_EXHAUSTED
-
AZURE-SERVICE-BUS-MESSAGING:INVALID_PARAMS
-
MULE: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 Any |
Messages to send |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
For Configurations
Throws
-
AZURE-SERVICE-BUS-MESSAGING:PAYLOAD_SIZE_EXCEEDED
-
AZURE-SERVICE-BUS-MESSAGING:OPERATION_TIMEOUT
-
AZURE-SERVICE-BUS-MESSAGING:INVALID_SIGNATURE
-
MULE:ANY
-
AZURE-SERVICE-BUS-MESSAGING:NOT_ENOUGH_PERMITS
-
AZURE-SERVICE-BUS-MESSAGING:CONNECTIVITY
-
AZURE-SERVICE-BUS-MESSAGING:DESTINATION_NOT_FOUND
-
AZURE-SERVICE-BUS-MESSAGING:RETRY_EXHAUSTED
-
AZURE-SERVICE-BUS-MESSAGING:INVALID_PARAMS
Sources
Message Listener
<azure-service-bus-messaging:message-listener>
This operation receives messages from a specific queue or subscription.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Acknowledgment mode |
Enumeration, one of:
|
Specifies the way to acknowledge received messages |
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 |
|
Number Of Consumers |
Number |
Number of concurrent consumers to use to receive messages |
||
Output Mime Type |
String |
MIME type of the payload that this operation outputs |
||
Output Encoding |
String |
Encoding of the payload that this operation outputs |
||
Primary Node Only |
Boolean |
Whether this source should be executed only on the primary node when running in a cluster |
true |
|
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 |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors |
|||
Body |
Binary |
Body of the message |
#[payload] |
|
Message Id |
String |
The message identifier is an application-defined value that uniquely identifies the message and its payload. |
||
Send Correlation Strategy |
Enumeration, one of:
|
AUTO |
||
Correlation Id |
String |
Allows an application to specify a context for the message for the purposes of correlation |
||
Session Id |
String |
Session identifier for a session-aware entity |
||
Reply To |
String |
Standard way to express a reply path to the receiver of the message |
||
Reply To Session Id |
String |
Session identifier for a session-aware entity |
||
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 |
This value is the relative duration 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:
|
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 made available for retrieval |
||
Properties |
Object |
Map of user application properties set on the message |
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:
|
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 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 |
DateTime |
The instant in UTC time when the message is accepted and stored in the entity |
||
Expires At |
DateTime |
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 |
Read-only property that references the lock that is in peek-lock receive mode |
||
Locked Until Utc |
DateTime |
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 |
DateTime |
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 |
Any |
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 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 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 |
DateTime |
The instant in UTC time when the message is accepted and stored in the entity |
||
Expires At |
DateTime |
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 |
DateTime |
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 |
DateTime |
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 |
Any |
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 |