Microsoft Service Bus Connector 2.2 Reference | MuleSoft Documentation
# Microsoft Service Bus Connector 2.2 Reference
Release Notes: Microsoft Service Bus Connector Release Notes
This connector supports connecting only to the Microsoft Windows Service Bus on-premises solution. To connect to Microsoft Azure Service Bus, use Anypoint Connector for Azure Service Bus.   
---  
## Configurations
### Default Configuration
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Name for this configuration. Connectors reference the configuration with this name.  
Connection | 
  * Shared Access Signature
  * Username Password

| Connection types to provide to this configuration  
Encoding | Default encoding of the Message body to use if the message doesn’t communicate it  
Content Type | Default contentType of the Message body to use if the message doesn’t communicate it  
Expiration Policy |  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.  
Ack Mode |  Enumeration, one of:
  * IMMEDIATE
  * MANUAL
  * DUPS_OK

| The `org.mule.jms.commons.api.config.ConsumerAckMode` to use when consuming a message. Override this setting at the message source level. This attribute must be `IMMEDIATE` if `transactionType` is `LOCAL` or `MULTI`  
Consumer Type |  One of:
  *   * Service Bus Queue Consumer

| The ConsumerType to use by default when consuming a Message. Override this setting at the message source level.  
Persistent Delivery | Sets the default value for the Message#getJMSDeliveryMode. If true, the DeliveryMode#PERSISTENT mode is used, which instructs the JMS provider to take extra care to insure the message is not lost in transit due to a JMS provider failure.  
Priority | Defines the default Message#getJMSPriority to use when sending messages  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A TimeUnit which qualifies the #timeToLive attribute. Defaults to MILLISECONDS | MILLISECONDS  
Disable Message Id | Defines the default value to use when producing messages, for disabling the Message#getJMSMessageID generation in the broker. Depending on the provider it may or may not have effect  
Disable Message Timestamp | Defines the default value to use, when producing messages, for disable Message#getJMSTimestamp generation in the broker. Depending on the provider it may or may not have effect.  
Delivery Delay | Determines the Message delivery delay time which is calculated by adding the deliveryDelay value specified on the send method to the time the message was sent. Only used in JMS_2_0  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A TimeUnit which qualifies the #deliveryDelay attribute. Defaults to MILLISECONDS | MILLISECONDS  
Jms Type | A message JMSType identifier supplied by a client when a message is sent.  
#### Connection Types
##### Shared Access Signature (Deprecated)
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Skip connectivity test | (Optional) Skips the connectivity test at connector startup (use this if your access policy is restricted).  
Max Connections | Maximum number of connections to keep in pool for the producer to reuse. If set to `-1`, a new connection is created every time.  
Caching Strategy |  One of:
  * no-caching
  * Default Caching

| Strategy to use for caching sessions and connections  
Service Namespace | Namespace for the Azure Service Bus service in your subscription.  
Storage Account Name | (Optional) The account name of the Blob Storage to use to store large messages.  
Storage Access Key | (Optional) The account key of the Blob Storage to use to store large messages.  
Container Name | (Optional) The container name in the Blob Storage to use to store large messages. If this parameter is not provided, a default container is created.  
Shared Access Signature | Unique security token that sets up one security profile for access to all your service resources. When the token expires, the connector cannot reconnect automatically, so you must stop the flow to update this configuration setting with a new token.  
SAS tokens provider |  SharedAccessSignatureProvider | Provider instance that provides SAS tokens when required.  
SAS tokens list |  Array of String | List of SAS tokens to use when required.  
Max redeliveries | Controls when an incoming message is rejected based on the number of times it was redelivered. The default value is -1 (disabled). A value of `0` means that no message redeliveries are accepted. A value of `5` means that a message is redelivered five times, and so forth.  
Enumeration, one of:
  * ACCEPTED
  * REJECTED
  * RELEASED
  * MODIFIED_FAILED
  * MODIFIED_FAILED_UNDELIVERABLE

| Controls the outcome to apply to a message that is rejected due to exceeding the configured maxRedeliveries value. | MODIFIED_FAILED_UNDELIVERABLE  
Reconnection |  | 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.  
##### Username Password (Deprecated)
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Skip connectivity test | (Optional) Skips the connectivity test at connector startup (use this if your access policy is restricted).  
Max Connections | Maximum number of connections to keep in pool for the producer to reuse. If set to `-1`, a new connection is created every time.  
Caching Strategy |  One of:
  * no-caching
  * Default Caching

| The strategy to use for caching sessions and connections  
Service Namespace | Namespace for the Azure Service Bus service in your subscription.  
Storage Account Name | (Optional) The account name of the Blob Storage to use to store large messages  
Storage Access Key | (Optional) The account key of the Blob Storage to use to store large messages.  
Container Name | (Optional) The container name in the Blob Storage to use to store large messages. If this parameter is not provided, a default container is created.  
Shared Access Key Name | Name of the access key configured on the namespace. Any access key created at a lower level, such as a topic level shared key, does not work with this option, unless you disable the connectivity test at startup.  
Shared Access Key | 256-bit primary key.  
Points to the Proxy type.  
Security | Points to the TLS type.  
Advanced | Points to the Advanced type.  
Max redeliveries | Controls when an incoming message is rejected based on the number of times it was redelivered. The default value is -1 (disabled). A value of `0` means that no message redeliveries are accepted. A value of `5` means that a message is redelivered five times, and so forth.  
Enumeration, one of:
  * ACCEPTED
  * REJECTED
  * RELEASED
  * MODIFIED_FAILED
  * MODIFIED_FAILED_UNDELIVERABLE

| Controls the outcome to apply to a message that is rejected due to exceeding the configured maxRedeliveries value. | MODIFIED_FAILED_UNDELIVERABLE  
Reconnection |  | 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.  
##### Windows
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Skip connectivity test | (Optional) Skips the connectivity test at connector startup (use this if your access policy is restricted).  
Max Connections | Maximum number of connections to keep in pool for the producer to reuse. If set to `-1`, a new connection is created every time.  
Caching Strategy |  One of:
  * no-caching
  * Default Caching

| The strategy to use for caching sessions and connections  
Service Namespace | Namespace for the Azure Service Bus service in your subscription.  
Username | Username used for authentication.  
Password | Password used for authentication.  
Fully Qualified Domain Name | Fully qualified domain name of your Windows Service Bus server.  
Server port number.  
Disable SSL certificate validation | Set to `true` when using a self-signed SSL certificate.  
Idle timeout | The idle timeout in milliseconds after which the connection fails if the peer sends no AMQP frames.  
Points to the Proxy type.  
Security | Points to the TLS type.  
Advanced | Points to the Advanced type.  
Max redeliveries | Controls when an incoming message is rejected based on the number of times it was redelivered. The default value is -1 (disabled). A value of `0` means that no message redeliveries are accepted. A value of `5` means that a message is redelivered five times, and so forth.  
Enumeration, one of:
  * ACCEPTED
  * REJECTED
  * RELEASED
  * MODIFIED_FAILED
  * MODIFIED_FAILED_UNDELIVERABLE
| The strategy to use for caching sessions and connections  
Service Namespace | Namespace for the Azure Service Bus service in your subscription.  
Username | Username used for authentication.  
Password | Password used for authentication.  
Fully Qualified Domain Name | Fully qualified domain name of your Windows Service Bus server.  
Server port number.  
Disable SSL certificate validation | Set to `true` when using a self-signed SSL certificate.  
Idle timeout | The idle timeout in milliseconds after which the connection fails if the peer sends no AMQP frames.  
Points to the Proxy type.  
Security | Points to the TLS type.  
Advanced | Points to the Advanced type.  
Max redeliveries | Controls when an incoming message is rejected based on the number of times it was redelivered. The default value is -1 (disabled). A value of `0` means that no message redeliveries are accepted. A value of `5` means that a message is redelivered five times, and so forth.  
Enumeration, one of:
  * ACCEPTED
  * REJECTED
  * RELEASED
  * MODIFIED_FAILED
  * MODIFIED_FAILED_UNDELIVERABLE

| Controls the outcome to apply to a message that is rejected due to exceeding the configured maxRedeliveries value. | MODIFIED_FAILED_UNDELIVERABLE  
Reconnection |  | 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.  
## Associated Operations
  *   *   *   *   *   * Recover Session
  *   *   *   * Subscription Create
  * Subscription Delete
  * Subscription Get
  * Subscription Update
  *   *   *   *   *   * 

## Associated Sources
## Operations
`<servicebus:ack>`
Allows the user to perform an ACK when the JmsAckMode#MANUAL mode is elected while consuming the Message. As per JMS Spec, performing an ACK over a single Message automatically works as an ACK for all the Messages produced in the same JmsSession.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
The AckId of the Message to ACK | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Queue Create
`<servicebus:queue-create>`
Creates a queue in the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Queue Path | The name of the queue  
Queue Description |  Service Bus Queue Description | An InternalQueueDescription object containing the desired values of the queue’s properties to create | `#[payload]`  
Target Variable | Name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Service Bus Queue  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Queue Delete
`<servicebus:queue-delete>`
Deletes the specified queue in the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
Queue Path | Name of the queue | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Queue Get
`<servicebus:queue-get>`
This operation retrieves the specified queue from the Service Bus instance.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
Queue Path | Name of the queue | `#[payload]`  
Target Variable | Name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors  
#### Output
Service Bus Queue  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Queue Send
`<servicebus:queue-send>`
This operation sends a message to a queue.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Destination Queue | The name of the queue.  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| Type of transactional action. | NOT_SUPPORTED  
Send Correlation Id |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Correlation strategy id for operation.  
The body of the Message | `#[payload]`  
JMS Type | The JMSType identifier header of the Message  
Correlation ID | The JMSCorrelationID header of the Message  
Send Content Type | Whether or not the body content type should be sent as a property  
Content Type | The content type of the message’s body  
Send Encoding | Whether or not the body outboundEncoding should be sent as a Message property  
Encoding | The encoding of the message’s body  
Reply To |  Service Bus JMS Destination | The destination where a reply to this Message should be sent  
User Properties | The custom user properties to set for this message  
JMSX Properties |  JMSX Properties | The JMSX properties to set for this message  
Persistent Delivery | If true, the Message is sent using the PERSISTENT JMSDeliveryMode.  
Priority | The default JMSPriority value to use when sending the message.  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded.  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the timeToLive configurations.  
Disable Message Id | If true, flags the message to avoid generating its MessageID.  
Disable Message Timestamp | If true, flags the message to avoid generating its sent Timestamp.  
Delivery Delay | Only used by JMS 2.0. Sets the delivery delay to apply to postpone the message delivery.  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the deliveryDelay configurations.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Queue Update
`<servicebus:queue-update>`
This operation updates the specified queue in the Service Bus instance.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Queue Path | The name of the queue  
Queue Description |  Service Bus Queue Description | An InternalQueueDescription oject containing the desired values of the queue’s properties that will be updated | `#[payload]`  
Target Variable | The name of a variable that stores the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Service Bus Queue  
---  
### For Configurations
  * Default Configuration
| Time unit to use in the deliveryDelay configurations.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Queue Update
`<servicebus:queue-update>`
This operation updates the specified queue in the Service Bus instance.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Queue Path | The name of the queue  
Queue Description |  Service Bus Queue Description | An InternalQueueDescription oject containing the desired values of the queue’s properties that will be updated | `#[payload]`  
Target Variable | The name of a variable that stores the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Service Bus Queue  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Queues
`<servicebus:queues>`
This operation retrieves all existing queues from the Service Bus instance.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Target Variable | The name of a variable that stores the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Array of Service Bus Queue  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Recover Session
`<servicebus:recover-session>`
Allows the user to recover a session when the JmsAckMode#MANUAL mode is elected while consuming the message. Per the JMS Spec, performing a session recover automatically redelivers all the consumed messages that were not acknowledged before the recover.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
The AckId of the Message Session to recover | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Rule Create
`<servicebus:rule-create>`
This operation creates a rule for the specified topic and subscription.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
Rule Path | Name of the rule to create  
Rule Description |  Service Bus Rule Description | An InternalRuleDescription object containing the desired values of the new rule’s properties | `#[payload]`  
Topic Path | Name of the topic that contains the subscription for which to create a rule  
Subscription Path | Name of the subscription that contains the new rule  
Target Variable | Name of a variable that stores the operation’s output  
Target Value | Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Service Bus Rule  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Rule Delete
`<servicebus:rule-delete>`
This operation deletes a rule from the specified topic and subscription.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
Topic Path | Name of the topic that contains the subscription from which to delete the rule  
Subscription Path | Name of the subscription from which to delete the rule  
Rule Path | Name of the rule to delete  
Reconnection Strategy | 
  *   * Reconnect Forever

| Retry strategy in case of connectivity errors  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Rule Get
`<servicebus:rule-get>`
This operation retrieves a rule from the specified topic and subscription.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
Topic Path | Name of the topic that contains the subscription from which to retrieve the rule  
Subscription Path | Name of the subscription from which to retrieve the rule  
Rule Path | Name of the rule to retrieve  
Target Variable | Name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Service Bus Rule  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Rule Update
`<servicebus:rule-update>`
This operation updates a rule from the specified topic and subscription.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Rule Description |  Service Bus Rule Description | An InternalRuleDescription object containing the desired values for the rule’s updated properties | `#[payload]`  
Topic Path | The name of the topic that contains the subscription for which to update the rule  
Subscription Path | The name of the subscription for which to update the rule  
Rule Path | The name of the rule to update  
Target Variable | The name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Service Bus Rule  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Rules
`<servicebus:rules>`
Retrieves all rules from the specified topic and subscription
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Topic Path | The name of the topic that contains the subscription from which to retrieve all rules  
Subscription Path | The name of the subscription from which to retrieve all rules  
Target Variable | The name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Array of Service Bus Rule  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR
#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Rules
`<servicebus:rules>`
Retrieves all rules from the specified topic and subscription
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Topic Path | The name of the topic that contains the subscription from which to retrieve all rules  
Subscription Path | The name of the subscription from which to retrieve all rules  
Target Variable | The name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Array of Service Bus Rule  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Subscription Create
`<servicebus:subscription-create>`
Creates a subscription in the specified topic
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Topic Path | The name of the topic to contain the new subscription  
Subscription Path | The name of the subscription to create  
Subscription Description |  Service Bus Subscription Description | An InternalSubscriptionDescription object containing the desired values of the new subscription’s properties | `#[payload]`  
Target Variable | The name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Service Bus Subscription  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Subscription Delete
`<servicebus:subscription-delete>`
Deletes a subscription from the specified topic
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Topic Path | The name of the topic from which to delete the subscription  
Subscription Path | The name of the subscription to delete  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Subscription Get
`<servicebus:subscription-get>`
Retrieves a subscription from the specified topic
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Topic Path | The name of the topic from which to retrieve the subscription  
Subscription Path | The name of the subscription to retrieve  
Target Variable | The name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Service Bus Subscription  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Subscription Update
`<servicebus:subscription-update>`
Updates a subscription from the specified topic
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Subscription Description |  Service Bus Subscription Description | An InternalSubscriptionDescription object containing the desired values of the subscription’s updated properties | `#[payload]`  
Topic Path | The name of the topic from which to update the subscription  
Subscription Path | The name of the subscription to update  
Target Variable | The name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
#### Output
Service Bus Subscription  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Subscriptions
`<servicebus:subscriptions>`
Retrieves all subscriptions from the specified topic
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use  
Topic Path | The name of the topic from which to retrieve all subscriptions | `#[payload]`  
Target Variable | The name of a variable that stores the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Array of Service Bus Subscription  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Topic Create
`<servicebus:topic-create>`
Creates a topic in the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Topic Path | The name of the topic  
Topic Description |  Service Bus Topic Description | An InternalTopicDescription object containing the desired values of the topic’s properties that will be created. | `#[payload]`  
Target Variable | The name of a variable that stores the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Service Bus Topic  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Topic Delete
`<servicebus:topic-delete>`
Deletes the specified topic from the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Topic Path | The name of the topic | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Topic Get
`<servicebus:topic-get>`
Retrieves the specified topic from the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Topic Path | The name of the topic | `#[payload]`  
Target Variable | The name of a variable that stores the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever
### Topic Delete
`<servicebus:topic-delete>`
Deletes the specified topic from the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Topic Path | The name of the topic | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Topic Get
`<servicebus:topic-get>`
Retrieves the specified topic from the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Topic Path | The name of the topic | `#[payload]`  
Target Variable | The name of a variable that stores the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Service Bus Topic  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Topic Send
`<servicebus:topic-send>`
Sends a message to a Topic
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Destination Topic | The name of the topic.  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| Type of transactional action.  
Send Correlation Id |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Correlation strategy id for operation.  
The body of the Message | `#[payload]`  
JMS Type | The JMSType identifier header of the Message  
Correlation ID | The JMSCorrelationID header of the Message  
Send Content Type | Whether or not the body content type should be sent as a property  
Content Type | The content type of the message’s body  
Send Encoding | Whether or not the body outboundEncoding should be sent as a Message property  
Encoding | The encoding of the message’s body  
Reply To |  Service Bus JMS Destination | The destination where a reply to this Message should be sent  
User Properties | The custom user properties to set for this message  
JMSX Properties |  JMSX Properties | The JMSX properties to set for this message  
Persistent Delivery | If true, the Message is sent using the PERSISTENT JMSDeliveryMode.  
Priority | The default JMSPriority value to use when sending the message.  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded.  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the timeToLive configurations.  
Disable Message Id | If true, flags the message to avoid generating its MessageID.  
Disable Message Timestamp | If true, flags the message to avoid generating its sent Timestamp.  
Delivery Delay | Only used by JMS 2.0. Sets the delivery delay to apply to postpone the message delivery.  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the deliveryDelay configurations.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Topic Update
`<servicebus:topic-update>`
Updates the specified topic from the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Topic Path | The name of the topic  
Topic Description |  Service Bus Topic Description | An InternalTopicDescription object containing the desired values of the topic’s properties that will be updated. | `#[payload]`  
Target Variable | The name of a variable that stores the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Service Bus Topic  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


### Topics
`<servicebus:topics>`
Retrieves all existing topics from the service bus instance
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Target Variable | The name of a variable that stores the operation’s output.  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Array of Service Bus Topic  
---  
### For Configurations
  * Default Configuration


#### Throws
  * SERVICEBUS:INVALID_TOKEN
  * SERVICEBUS:RETRY_EXHAUSTED
  * SERVICEBUS:CONNECTION_EXCEPTION
  * SERVICEBUS:UNKNOWN
  * SERVICEBUS:AMQP_ERROR
  * SERVICEBUS:CONNECTIVITY
  * SERVICEBUS:REST_ERROR


## Sources
### Listener
`<servicebus:listener>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Ack Mode |  Enumeration, one of:
  * IMMEDIATE
  * MANUAL
  * DUPS_OK

| The Session ACK mode to use when consuming a message  
Number Of Consumers | The number of concurrent consumers to use to receive JMS Messages  
Primary Node Only | Whether this source should be executed only on the primary node when running in a cluster  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message  
Source Type | Indicates whether to retrieve messages from a queue or topic.  
Destination | Name of the destination queue, topic, or custom destination type from which to retrieve messages.  
Subscription | Name of the subscription used when subscribing to topics. If the destination is a queue, select `NONE`.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
The body of the Message | `#[payload]`  
JMS Type | The JMSType identifier header of the Message  
Correlation ID | The JMSCorrelationID header of the Message  
Send Content Type | Whether or not the body content type should be sent as a property  
Content Type | Content type of the message body.  
Send Encoding | Whether or not the body outboundEncoding should be sent as a Message property  
Encoding | Encoding of the message body.  
Reply To |  Service Bus JMS Destination | The destination where a reply to this Message should be sent  
User Properties | The custom user properties to set for this message  
JMSX Properties |  JMSX Properties | The JMSX properties to set for this message  
Persistent Delivery | Whether or not the delivery should be done with a persistent configuration  
Priority | The default JMSPriority value to use when sending the message  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| A retry strategy in case of connectivity errors.  
The body of the Message | `#[payload]`  
JMS Type | The JMSType identifier header of the Message  
Correlation ID | The JMSCorrelationID header of the Message  
Send Content Type | Whether or not the body content type should be sent as a property  
Content Type | Content type of the message body.  
Send Encoding | Whether or not the body outboundEncoding should be sent as a Message property  
Encoding | Encoding of the message body.  
Reply To |  Service Bus JMS Destination | The destination where a reply to this Message should be sent  
User Properties | The custom user properties to set for this message  
JMSX Properties |  JMSX Properties | The JMSX properties to set for this message  
Persistent Delivery | Whether or not the delivery should be done with a persistent configuration  
Priority | The default JMSPriority value to use when sending the message  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the timeToLive configurations  
Disable Message Id | If true, flags the message to avoid generating its MessageID  
Disable Message Timestamp | If true, flags the message to avoid generating its sent Timestamp  
Delivery Delay | Only used by JMS 2.0. Sets the delivery delay to apply to postpone the message delivery.  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the deliveryDelay configurations  
#### Output
Attributes Type |  Service Bus JMS Attributes  
---|---  
### For Configurations
  * Default Configuration


## Types
### Proxy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Hostname or IP address of the proxy server.  
Port of the proxy server.  
Username to authenticate against the proxy server.  
Password to authenticate against the proxy server.  
### Advanced
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Read Timeout** |  How long a client waits for a response before timing out. `0` specifies that the client waits indefinitely.  
**Read Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Read Timeout** field. |  MILLISECONDS  
**Connection Timeout** |  How long the connector waits before timing out when establishing a connection to the remote service.  
**Connection Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Connection Timeout** field. |  MILLISECONDS  
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Enabled Protocols** |  Comma-separated list of protocols enabled for this context.  
**Enabled Cipher Suites** |  Comma-separated list of cipher suites enabled for this context.  
**Trust Store** |  Configures the TLS truststore.  
Configures the TLS keystore.  
**Revocation Check** | 
  * Standard Revocation Check
  * custom-ocsp-responder
  * crl-file

|  Configures a revocation checking mechanism.  
### Truststore
Configures the truststore for TLS.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.  
Password used to protect the truststore.  
Type of truststore.  
Encryption algorithm that the truststore uses.  
If `true`, Mule stops performing certificate validations. Setting this to `true` can make connections vulnerable to attacks.  
### Keystore
Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.  
Type of store used.  
Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.  
**Key Password** |  Password used to protect the private key.  
Password used to protect the keystore.  
Encryption algorithm that the keystore uses.  
### Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Only End Entities** |  Which elements to verify in the certificate chain: Verify only the last element in the certificate chain. Verify all elements in the certificate chain.  
**Prefer Crls** |  How to check certificate validity: Check the Certification Revocation List (CRL) for certificate validity. Use the Online Certificate Status Protocol (OCSP) to check certificate validity.  
**No Fallback** |  Whether to use the secondary method to check certificate validity: Use the method that wasn’t specified in the **Prefer Crls** field (the secondary method) to check certificate validity. Do not use the secondary method to check certificate validity.  
What to do if the revocation server can’t be reached or is busy: Avoid verification failure. Allow the verification to fail.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | 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 | 
  *   * Reconnect Forever

| The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
How many reconnection attempts to make.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration  
Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
How many reconnection attempts to make.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration  
Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the maxIdleTime attribute  
### Service Bus JMS Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Properties |  JMS Message Properties | Container element for all the properties present in a JMS Message.  
All the possible headers of a JMS message.  
Session ackID that acknowledges the current message if available. If not, the ackID is null.  
### JMS Message Properties
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
All the properties of the JMS message as a flattened map.  
User Properties | User-provided properties of the JMS message.  
Jms Properties | JMS message broker and provider properties.  
Jmsx Properties |  JMSX Properties | JMSX properties of the JMS message.  
### JMSX Properties
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Jmsx User ID | User identity that sends the message.  
Jmsx App ID | Identity of the application that sends the message.  
Jmsx Delivery Count | Number of message delivery attempts.  
Jmsx Group ID | Message group identity of the message.  
Jmsx Group Seq | Sequence number of the message in the group.  
Jmsx Producer TXID | Identifier of the transaction that produced the message.  
Jmsx Consumer TXID | Identifier of the transaction that consumed the message.  
Jmsx Rcv Timestamp | The time JMS delivered the message to the consumer.  
### JMS Headers
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Destination |  Service Bus JMS Destination | Destination of the sent message.  
Delivery Mode | Delivery mode of the message.  
Expiration | Expiration time of the message, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC. If set to `0`, the message does not expire.  
Priority | Priority of the message, from 0-9. Higher numbers signify a higher priority.  
Message Id | Unique ID of the message.  
Timestamp | Time a message is handed to a JMS provider to be sent, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
Correlation Id | JMSCorrelationID header of the message.  
Reply To |  Service Bus JMS Destination | Destination of where a reply to this message is sent.  
Type of this destination.  
Redelivered | Set to `true` when the JMS provider has delivered the message at least once before.  
Delivery Time | Time the message is delivered.  
### Redelivery Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Redelivery Count | The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message  
Use Secure Hash | Whether to use a secure hash algorithm to identify a redelivered message.  
Message Digest Algorithm | The secure hashing algorithm to use.  
Id Expression | Defines one or more expressions used to determine when a message has been redelivered. This property can be set only when useSecureHash is false.  
Object Store |  Object Store | The object store where the redelivery counter for each message is going to be stored.  
### Service Bus JMS Destination
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Destination | Name that identifies the destination of where to send a reply to the message.  
Destination Type |  Enumeration, one of:
  * QUEUE
  * TOPIC
| Type of this destination.  
### Service Bus Queue
The queue is represented by an object containing the following fields:
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Author of the ServiceBusQueue object.  
Unique identifier of the ServiceBusQueue object.  
Link of the ServiceBusQueue object.  
Published | Date when the ServiceBusQueue object is published, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
Queue Description |  Service Bus Queue Description | ServiceBusQueueDescription object containing the desired values of the queue’s properties that is created.  
Title of the ServiceBusQueue object.  
Date when the ServiceBusQueue object is updated, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
### Service Bus Queue Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Lock Duration | Determines the amount of time in seconds in which a message should be locked for processing by a receiver. After this period, the message is unlocked and available for consumption by the next receiver. Settable only at queue creation time. Valid values: Range: 0 - 5 minutes. 0 means that the message is not locked. Format: PTx3Mx4S, where x1 number of days, x2 number of hours, x3 number of minutes, x4 number of seconds (Examples: PT5M (5 minutes), PT1M30S (1 minute, 30 seconds)).  
Max Size In Megabytes | Specifies the maximum queue size in megabytes. Any attempt to enqueue a message that causes the queue to exceed this value fails. Valid values are: 1024, 2048, 3072, 4096, 5120  
Requires Duplicate Detection | Settable only at queue creation time.  
Requires Session | Settable only at queue creation time. If set to true, the queue will be session-aware and only SessionReceiver will be supported. Session-aware queues are not supported through REST.  
Dead Lettering On Message Expiration | This field controls how the Service Bus handles a message with an expired TTL. If it is enabled and a message expires, Service Bus moves the message from the queue into the queue’s dead-letter sub-queue. If disabled, message is permanently deleted from the queue. Settable only at queue creation time.  
Enable Batched Operations | Enables or disables service-side batching behavior when performing operations for the specific queue. When enabled, Service Bus collects or batches multiple operations to the back end, to be more efficient with the connection. If you want lower operation latency, you can disable this feature.  
Default Message Time To Live | Depending on whether DeadLettering is enabled, a message is automatically moved to the DeadLetterQueue or deleted if it has been stored in the queue for longer than the specified time. This value is overwritten by a TTL specified on the message if and only if the message TTL is smaller than the TTL set on the queue. This value is immutable after the queue has been created. Format: Px1DTx2Hx3Mx4S, where x1 number of days, x2 number of hours, x3 number of minutes, x4 number of seconds (Examples: PT10M (10 minutes), P1DT2H (1 day, 2 hours) | P10675199DT2H48M5.4775807S  
Duplicate Detection History Time Window | Specifies the time span during which Service Bus detects message duplication Valid values: Range: 1 second - 7 days. Format: Px1DTx2Hx3Mx4S, where x1 number of days, x2 number of hours, x3 number of minutes, x4 number of seconds (Examples: PT10M (10 minutes), P1DT2H (1 day, 2 hours)).  
Max Delivery Count | The maximum number of times Service Bus tries to deliver a message before being dead-lettered or discarded.  
### Service Bus Rule
Represents a rule for processing messages. Service Bus matches messages with the filter represented by its `Filter` property and performs actions represented by its `Action` property, against the messages that match the filter.
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Unique identifier of the ServiceBusRule object.  
Link of the ServiceBusRule object.  
Published | Date when the ServiceBusRule object is published, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
Rule Description |  Service Bus Rule Description | ServiceBusRuleDescription object containing the desired values of the properties of the rule that is created.  
Title of the ServiceBusRule object.  
Date when the ServiceBusRule object is updated, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
### Service Bus Rule Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Service Bus Rule Action | The action that the rule performs  
Service Bus Rule Filter | The filter for the associated subscription  
### Service Bus Rule Action
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Sql Expression | The SQL expression for the action to perform  
Enumeration, one of:
  * SqlRuleAction

A type of FilterAction that represents an SQL expression.
  * EmptyRuleAction

A type of FilterAction that represents an empty action. | Type of the ServiceBusRuleAction object.  
### Service Bus Rule Filter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Correlation Id | The ID to match if this filter is a correlation filter  
Sql Expression | The SQL expression for the action to perform  
Enumeration, one of:
  * SqlFilter

A type of filter that represents an SQL expression.
  * TrueFilter

Shortcut for returning `true`. It is a type of SqlFilter.
  * FalseFilter

Shortcut for returning `false`. It is a type of SqlFilter.
  * CorrelationFilter
A type of FilterAction that represents an SQL expression.
  * EmptyRuleAction

A type of FilterAction that represents an empty action. | Type of the ServiceBusRuleAction object.  
### Service Bus Rule Filter
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Correlation Id | The ID to match if this filter is a correlation filter  
Sql Expression | The SQL expression for the action to perform  
Enumeration, one of:
  * SqlFilter

A type of filter that represents an SQL expression.
  * TrueFilter

Shortcut for returning `true`. It is a type of SqlFilter.
  * FalseFilter

Shortcut for returning `false`. It is a type of SqlFilter.
  * CorrelationFilter

A type of filter that matches the correlationId property of BrokeredMessage. | Type of the ServiceBusRuleFilter object.  
### Service Bus Subscription
The subscription is represented by an object containing the following fields:
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Unique identifier of the ServiceBusSubscription object.  
Link of the ServiceBusSubscription object.  
Published | Date when the ServiceBusSubscription object is published, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
Subscription Description |  Service Bus Subscription Description | ServiceBusSubscriptionDescription object containing the desired values of the properties of the subscription that is created.  
Title of the ServiceBusSubscription object.  
Date when the ServiceBusSubscription object is updated, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
### Service Bus Subscription Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Lock Duration | The default lock duration is applied to subscriptions that do not define a lock duration. You can only set this property at subscription creation time. Valid values: Range: 0 - 5 minutes. 0 means that the message is not locked. Format: PTx3Mx4S, where x1 number of days, x2 number of hours, x3 number of minutes, x4 number of seconds (Examples: PT5M (5 minutes), PT1M30S (1 minute, 30 seconds)).  
Requires Session | You can only set this property at subscription creation time. If set to true, the subscription will be session-aware and only SessionReceiver will be supported. Session-aware subscriptions are not supported through REST.  
Dead Lettering On Message Expiration | This field controls how Service Bus handles a message with an expired TTL. If it is enabled and a message expires, Service Bus moves the message from the queue into the subscription’s dead-letter sub-queue. If disabled, message is permanently deleted from the subscription’s main queue. Settable only at subscription creation time.  
Dead Lettering On Filter Evaluation Exceptions | Determines how Service Bus handles a message that causes an exception during a subscription’s filter evaluation. If the value is set to true, the message that caused the exception is moved to the subscription’s dead-letter queue. Otherwise, it is discarded. By default, this parameter is set to true, enabling you to investigate the cause of the exception. It can occur from a malformed message or some incorrect assumptions being made in the filter about the form of the message. Settable only at subscription creation time.  
Enable Batched Operations | Enables or disables service-side batching behavior when performing operations for the specific queue. When enabled, Service Bus will collect/batch multiple operations to the backend to be more connection efficient. If you want lower operation latency, then you can disable this feature.  
Default Message Time To Live | Determines how long a message lives in the subscription. Based on whether dead-lettering is enabled, a message whose Time To Live (TTL) has expired is either moved to the subscription’s associated DeadLetterQueue, or permanently deleted. If the topic specifies a smaller TTL than the subscription, the topic TTL is applied. Format: Px1DTx2Hx3Mx4S, where x1 number of days, x2 number of hours, x3 number of minutes, x4 number of seconds (Examples: PT10M (10 minutes), P1DT2H (1 day, 2 hours) | P10675199DT2H48M5.4775807S  
Max Delivery Count | The maximum number of times Service Bus tries to deliver a message before that message is dead lettered or discarded.  
### Service Bus Topic
The topic is represented by an object containing the following fields:
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Author of the ServiceBusTopic object.  
Unique identifier of the ServiceBusTopic object.  
Link of the ServiceBusTopic object.  
Published | Date when the ServiceBusTopic object is published, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
Title of the ServiceBusTopic object.  
Topic Description |  Service Bus Topic Description | ServiceBusTopicDescription object containing the desired values of the properties of the topic that is created.  
Date when the ServiceBusTopic object is updated, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.  
### Service Bus Topic Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Size In Megabytes | Specifies the maximum queue size in megabytes. Any attempt to enqueue a message that will cause the queue to exceed this value fails. Valid values are: 1024, 2048, 3072, 4096, 5120  
Requires Duplicate Detection | If enabled, the topic detects duplicate messages within the time span specified by the DuplicateDetectionHistoryTimeWindow property. Settable only at topic creation time.  
Enable Batched Operations | Enables or disables service side batching behavior when performing operations for the specific queue. When enabled, Service Bus collects/batches multiple operations to the back end to be more connection efficient. If you want lower operation latency, you can disable this feature.  
Default Message Time To Live | Determines how long a message lives in the associated subscriptions. Subscriptions inherit the TTL from the topic unless they are created explicitly with a smaller TTL. Based on whether dead-lettering is enabled, a message whose TTL has expired will either be moved to the subscription’s associated DeadLetterQueue or will be permanently deleted. Format: Px1DTx2Hx3Mx4S, where x1 number of days, x2 number of hours, x3 number of minutes, x4 number of seconds (Examples: PT10M (10 minutes), P1DT2H (1 day, 2 hours)). | P10675199DT2H48M5.4775807S  
Duplicate Detection History Time Window | Specifies the time span during which Service Bus detects message duplication Valid values: Range: 1 second - 7 days. Format: Px1DTx2Hx3Mx4S, where x1 number of days, x2 number of hours, x3 number of minutes, x4 number of seconds (Examples: PT10M (10 minutes), P1DT2H (1 day, 2 hours)).  
### Default Caching
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Session Cache Size | Number of sessions to cache.  
Cache Producers | true if the ConnectionFactory should cache the MessageProducers  
Cache Consumers | true if the ConnectionFactory should cache the MessageConsumers  
### Topic Consumer
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Topic Consumer |  | Points to the Topic Consumer type.  
Topic Subscription |  Topic Subscription | Points to the Topic Subscription type.  
### Topic Subscription
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Topic Path | Name of the topic where the subscription is created.  
Subscription Path | Name of the subscription that is created.  
### Service Bus Queue Consumer
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Queue Consumer |  queue-consumer | ConsumerType that marks the consumed destination as a queue.  
Source Queue | Queue that receives events.  
Number Of Consumers | The number of concurrent consumers to use to receive JMS Messages  
## See Also
MuleSoft Help Center