--- schema_version: "1" id: 4f6da88c77dafe271bce33178befb44b9fe783d17179ca2263b8ff43d6ec16b9 title: Microsoft Service Bus Connector 2.2 Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/microsoft-service-bus-connector/latest/ms-service-bus-connector-reference.md canonical_url: https://docs.mulesoft.com/microsoft-service-bus-connector/latest/ms-service-bus-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 96620effc69af18e15e5129acc95b2b994548d90761f3d1083c5e735e18a2ea6 description: MuleSoft Documentation Site release: "2.2" latest: true --- --- product: Microsoft Service Bus Connector version: 2.2 is-latest-version: true --- # Microsoft Service Bus Connector 2.2 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Release Notes: [Microsoft Service Bus Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/ms-service-bus-connector-release-notes-mule-4) > [!NOTE] 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](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-azure-service-bus-connector). ## Configurations --- ### Default Configuration #### Parameters

Name	Type	Description	Default Value	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.		x
Connection	Shared Access Signature Username Password Windows	Connection types to provide to this configuration		x
Encoding	String	Default encoding of the Message body to use if the message doesn’t communicate it
Content Type	String	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 AUTO 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`	`AUTO`
Consumer Type	One of: Topic Consumer Service Bus Queue Consumer	The ConsumerType to use by default when consuming a Message. Override this setting at the message source level.
Persistent Delivery	Boolean	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.	false
Priority	Number	Defines the default Message#getJMSPriority to use when sending messages	4
Time To Live	Number	Defines the default time the message is in the broker before it expires and is discarded	0
Time To Live Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A TimeUnit which qualifies the #timeToLive attribute. Defaults to MILLISECONDS	MILLISECONDS
Disable Message Id	Boolean	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	false
Disable Message Timestamp	Boolean	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.	false
Delivery Delay	Number	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 DAYS	A TimeUnit which qualifies the #deliveryDelay attribute. Defaults to MILLISECONDS	MILLISECONDS
Jms Type	String	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	Boolean	(Optional) Skips the connectivity test at connector startup (use this if your access policy is restricted).	false
Max Connections	Number	Maximum number of connections to keep in pool for the producer to reuse. If set to `-1`, a new connection is created every time.	-1
Caching Strategy	One of: no-caching Default Caching	Strategy to use for caching sessions and connections
Service Namespace	String	Namespace for the Azure Service Bus service in your subscription.		x
Storage Account Name	String	(Optional) The account name of the Blob Storage to use to store large messages.
Storage Access Key	String	(Optional) The account key of the Blob Storage to use to store large messages.
Container Name	String	(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	String	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	Number	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.	-1
Outcome	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	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.	`true`

##### Username Password (Deprecated) ###### Parameters

Name	Type	Description	Default Value	Required
Skip connectivity test	Boolean	(Optional) Skips the connectivity test at connector startup (use this if your access policy is restricted).	false
Max Connections	Number	Maximum number of connections to keep in pool for the producer to reuse. If set to `-1`, a new connection is created every time.	-1
Caching Strategy	One of: no-caching Default Caching	The strategy to use for caching sessions and connections
Service Namespace	String	Namespace for the Azure Service Bus service in your subscription.		x
Storage Account Name	String	(Optional) The account name of the Blob Storage to use to store large messages
Storage Access Key	String	(Optional) The account key of the Blob Storage to use to store large messages.
Container Name	String	(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	String	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.		x
Shared Access Key	String	256-bit primary key.		x
Proxy	Proxy	Points to the Proxy type.
Security	TLS	Points to the TLS type.
Advanced	Advanced	Points to the Advanced type.
Max redeliveries	Number	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.	-1
Outcome	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	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.	`true`

##### Windows ###### Parameters

Name	Type	Description	Default Value	Required
Skip connectivity test	Boolean	(Optional) Skips the connectivity test at connector startup (use this if your access policy is restricted).	false
Max Connections	Number	Maximum number of connections to keep in pool for the producer to reuse. If set to `-1`, a new connection is created every time.	-1
Caching Strategy	One of: no-caching Default Caching	The strategy to use for caching sessions and connections
Service Namespace	String	Namespace for the Azure Service Bus service in your subscription.		x
Username	String	Username used for authentication.		x
Password	String	Password used for authentication.		x
Fully Qualified Domain Name	String	Fully qualified domain name of your Windows Service Bus server.		x
Port	String	Server port number.	9355
Disable SSL certificate validation	Boolean	Set to `true` when using a self-signed SSL certificate.	false
Idle timeout	Number	The idle timeout in milliseconds after which the connection fails if the peer sends no AMQP frames.	60000
Proxy	Proxy	Points to the Proxy type.
Security	TLS	Points to the TLS type.
Advanced	Advanced	Points to the Advanced type.
Max redeliveries	Number	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.	-1
Outcome	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	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.	`true`

## Associated Operations - [Ack](#ack) - [Queue Create](#queueCreate) - [Queue Delete](#queueDelete) - [Queue Get](#queueGet) - [Queue Send](#queueSend) - [Queue Update](#queueUpdate) - [Queues](#queues) - [Recover Session](#recoverSession) - [Rule Create](#ruleCreate) - [Rule Delete](#ruleDelete) - [Rule Get](#ruleGet) - [Rule Update](#ruleUpdate) - [Rules](#rules) - [Subscription Create](#subscriptionCreate) - [Subscription Delete](#subscriptionDelete) - [Subscription Get](#subscriptionGet) - [Subscription Update](#subscriptionUpdate) - [Subscriptions](#subscriptions) - [Topic Create](#topicCreate) - [Topic Delete](#topicDelete) - [Topic Get](#topicGet) - [Topic Send](#topicSend) - [Topic Update](#topicUpdate) - [Topics](#topics) ## Associated Sources - [Listener](#listener) ## Operations ### 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	String	Name of the configuration to use		x
Ack Id	String	The AckId of the Message to ACK	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Queue Path	String	The name of the queue		x
Queue Description	Service Bus Queue Description	An InternalQueueDescription object containing the desired values of the queue’s properties to create	`#[payload]`
Target Variable	String	Name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

#### Output

Type	Service Bus Queue

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use		x
Queue Path	String	Name of the queue	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use		x
Queue Path	String	Name of the queue	`#[payload]`
Target Variable	String	Name of a variable that stores 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	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors

#### Output

Type	Service Bus Queue

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Destination Queue	String	The name of the queue.		x
Transactional Action	Enumeration, one of: ALWAYS_JOIN JOIN_IF_POSSIBLE NOT_SUPPORTED	Type of transactional action.	NOT_SUPPORTED
Send Correlation Id	Enumeration, one of: AUTO ALWAYS NEVER	Correlation strategy id for operation.	AUTO
Body	Any	The body of the Message	`#[payload]`
JMS Type	String	The JMSType identifier header of the Message
Correlation ID	String	The JMSCorrelationID header of the Message
Send Content Type	Boolean	Whether or not the body content type should be sent as a property	true
Content Type	String	The content type of the message’s body
Send Encoding	Boolean	Whether or not the body outboundEncoding should be sent as a Message property	true
Encoding	String	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	Object	The custom user properties to set for this message
JMSX Properties	JMSX Properties	The JMSX properties to set for this message
Persistent Delivery	Boolean	If true, the Message is sent using the PERSISTENT JMSDeliveryMode.
Priority	Number	The default JMSPriority value to use when sending the message.
Time To Live	Number	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 DAYS	Time unit to use in the timeToLive configurations.
Disable Message Id	Boolean	If true, flags the message to avoid generating its MessageID.
Disable Message Timestamp	Boolean	If true, flags the message to avoid generating its sent Timestamp.
Delivery Delay	Number	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 DAYS	Time unit to use in the deliveryDelay configurations.
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Queue Path	String	The name of the queue		x
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	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Service Bus Queue

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Array of Service Bus Queue

### For Configurations - [Default Configuration](#config) #### Throws - SERVICEBUS:INVALID\_TOKEN - SERVICEBUS:RETRY\_EXHAUSTED - SERVICEBUS:CONNECTION\_EXCEPTION - SERVICEBUS:UNKNOWN - SERVICEBUS:AMQP\_ERROR - SERVICEBUS:CONNECTIVITY - SERVICEBUS:REST\_ERROR ### 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	String	The name of the configuration to use		x
Ack Id	String	The AckId of the Message Session to recover	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use		x
Rule Path	String	Name of the rule to create		x
Rule Description	Service Bus Rule Description	An InternalRuleDescription object containing the desired values of the new rule’s properties	`#[payload]`
Topic Path	String	Name of the topic that contains the subscription for which to create a rule		x
Subscription Path	String	Name of the subscription that contains the new rule
Target Variable	String	Name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

#### Output

Type	Service Bus Rule

Name	Type	Description	Required
Configuration	String	Name of the configuration to use	x
Topic Path	String	Name of the topic that contains the subscription from which to delete the rule	x
Subscription Path	String	Name of the subscription from which to delete the rule	x
Rule Path	String	Name of the rule to delete	x
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use		x
Topic Path	String	Name of the topic that contains the subscription from which to retrieve the rule		x
Subscription Path	String	Name of the subscription from which to retrieve the rule		x
Rule Path	String	Name of the rule to retrieve		x
Target Variable	String	Name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

#### Output

Type	Service Bus Rule

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Rule Description	Service Bus Rule Description	An InternalRuleDescription object containing the desired values for the rule’s updated properties	`#[payload]`
Topic Path	String	The name of the topic that contains the subscription for which to update the rule		x
Subscription Path	String	The name of the subscription for which to update the rule		x
Rule Path	String	The name of the rule to update		x
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

#### Output

Type	Service Bus Rule

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Topic Path	String	The name of the topic that contains the subscription from which to retrieve all rules		x
Subscription Path	String	The name of the subscription from which to retrieve all rules
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

#### Output

Type	Array of Service Bus Rule

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Topic Path	String	The name of the topic to contain the new subscription		x
Subscription Path	String	The name of the subscription to create		x
Subscription Description	Service Bus Subscription Description	An InternalSubscriptionDescription object containing the desired values of the new subscription’s properties	`#[payload]`
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

#### Output

Type	Service Bus Subscription

Name	Type	Description	Required
Configuration	String	The name of the configuration to use	x
Topic Path	String	The name of the topic from which to delete the subscription	x
Subscription Path	String	The name of the subscription to delete
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Topic Path	String	The name of the topic from which to retrieve the subscription		x
Subscription Path	String	The name of the subscription to retrieve
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

#### Output

Type	Service Bus Subscription

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Subscription Description	Service Bus Subscription Description	An InternalSubscriptionDescription object containing the desired values of the subscription’s updated properties	`#[payload]`
Topic Path	String	The name of the topic from which to update the subscription		x
Subscription Path	String	The name of the subscription to update
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

#### Output

Type	Service Bus Subscription

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use		x
Topic Path	String	The name of the topic from which to retrieve all subscriptions	`#[payload]`
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Array of Service Bus Subscription

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Topic Path	String	The name of the topic		x
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	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Service Bus Topic

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Topic Path	String	The name of the topic	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Topic Path	String	The name of the topic	`#[payload]`
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Service Bus Topic

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Destination Topic	String	The name of the topic.		x
Transactional Action	Enumeration, one of: ALWAYS_JOIN JOIN_IF_POSSIBLE NOT_SUPPORTED	Type of transactional action.		x
Send Correlation Id	Enumeration, one of: AUTO ALWAYS NEVER	Correlation strategy id for operation.		x
Body	Any	The body of the Message	`#[payload]`
JMS Type	String	The JMSType identifier header of the Message
Correlation ID	String	The JMSCorrelationID header of the Message
Send Content Type	Boolean	Whether or not the body content type should be sent as a property	true
Content Type	String	The content type of the message’s body
Send Encoding	Boolean	Whether or not the body outboundEncoding should be sent as a Message property	true
Encoding	String	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	Object	The custom user properties to set for this message
JMSX Properties	JMSX Properties	The JMSX properties to set for this message
Persistent Delivery	Boolean	If true, the Message is sent using the PERSISTENT JMSDeliveryMode.
Priority	Number	The default JMSPriority value to use when sending the message.
Time To Live	Number	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 DAYS	Time unit to use in the timeToLive configurations.
Disable Message Id	Boolean	If true, flags the message to avoid generating its MessageID.
Disable Message Timestamp	Boolean	If true, flags the message to avoid generating its sent Timestamp.
Delivery Delay	Number	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 DAYS	Time unit to use in the deliveryDelay configurations.
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Topic Path	String	The name of the topic		x
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	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Service Bus Topic

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Target Variable	String	The name of a variable that stores 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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Array of Service Bus Topic

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Ack Mode	Enumeration, one of: IMMEDIATE AUTO MANUAL DUPS_OK	The Session ACK mode to use when consuming a message
Number Of Consumers	Number	The number of concurrent consumers to use to receive JMS Messages	1
Primary Node Only	Boolean	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	String	Indicates whether to retrieve messages from a queue or topic.		x
Destination	String	Name of the destination queue, topic, or custom destination type from which to retrieve messages.		x
Subscription	String	Name of the subscription used when subscribing to topics. If the destination is a queue, select `NONE`.		x
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.
Body	Any	The body of the Message	`#[payload]`
JMS Type	String	The JMSType identifier header of the Message
Correlation ID	String	The JMSCorrelationID header of the Message
Send Content Type	Boolean	Whether or not the body content type should be sent as a property	true
Content Type	String	Content type of the message body.
Send Encoding	Boolean	Whether or not the body outboundEncoding should be sent as a Message property	true
Encoding	String	Encoding of the message body.
Reply To	Service Bus JMS Destination	The destination where a reply to this Message should be sent
User Properties	Object	The custom user properties to set for this message
JMSX Properties	JMSX Properties	The JMSX properties to set for this message
Persistent Delivery	Boolean	Whether or not the delivery should be done with a persistent configuration
Priority	Number	The default JMSPriority value to use when sending the message
Time To Live	Number	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 DAYS	Time unit to use in the timeToLive configurations
Disable Message Id	Boolean	If true, flags the message to avoid generating its MessageID
Disable Message Timestamp	Boolean	If true, flags the message to avoid generating its sent Timestamp
Delivery Delay	Number	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 DAYS	Time unit to use in the deliveryDelay configurations

#### Output

Type	Message
Attributes Type	Service Bus JMS Attributes

### For Configurations - [Default Configuration](#config) ## Types ### Proxy

Field	Type	Description
Host	String	Hostname or IP address of the proxy server.
Port	String	Port of the proxy server.
Username	String	Username to authenticate against the proxy server.
Password	String	Password to authenticate against the proxy server.

### Advanced

Name	Type	Description	Default Value
Read Timeout	Number	How long a client waits for a response before timing out. `0` specifies that the client waits indefinitely.	60000
Read Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Read Timeout field.	MILLISECONDS
Connection Timeout	Number	How long the connector waits before timing out when establishing a connection to the remote service.	60000
Connection Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Connection Timeout field.	MILLISECONDS

### TLS

Field	Type	Description
Enabled Protocols	String	Comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	Comma-separated list of cipher suites enabled for this context.
Trust Store	Truststore	Configures the TLS truststore.
Key Store	Keystore	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
Path	String	Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.
Password	String	Password used to protect the truststore.
Type	String	Type of truststore.
Algorithm	String	Encryption algorithm that the truststore uses.
Insecure	Boolean	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
Path	String	Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.
Type	String	Type of store used.
Alias	String	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	String	Password used to protect the private key.
Password	String	Password used to protect the keystore.
Algorithm	String	Encryption algorithm that the keystore uses.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.

Field	Type	Description
Only End Entities	Boolean	Which elements to verify in the certificate chain: `true` Verify only the last element in the certificate chain. `false` Verify all elements in the certificate chain.
Prefer Crls	Boolean	How to check certificate validity: `true` Check the Certification Revocation List (CRL) for certificate validity. `false` Use the Online Certificate Status Protocol (OCSP) to check certificate validity.
No Fallback	Boolean	Whether to use the secondary method to check certificate validity: `true` Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity. `false` Do not use the secondary method to check certificate validity.
Soft Fail	Boolean	What to do if the revocation server can’t be reached or is busy: `true` Avoid verification failure. `false` Allow the verification to fail.

### 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	Reconnect Reconnect Forever	The reconnection strategy to use.

### Reconnect

Field	Type	Description	Default Value
Frequency	Number	How often in milliseconds to reconnect.
Count	Number	How many reconnection attempts to make.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

### Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often in milliseconds to reconnect.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

### 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 should be 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

### Service Bus JMS Attributes

Field	Type	Description	Required
Properties	JMS Message Properties	Container element for all the properties present in a JMS Message.	x
Headers	JMS Headers	All the possible headers of a JMS message.	x
Ack Id	String	Session ackID that acknowledges the current message if available. If not, the ackID is null.

### JMS Message Properties

Field	Type	Description	Required
All	Object	All the properties of the JMS message as a flattened map.	x
User Properties	Object	User-provided properties of the JMS message.	x
Jms Properties	Object	JMS message broker and provider properties.	x
Jmsx Properties	JMSX Properties	JMSX properties of the JMS message.	x

### JMSX Properties

Field	Type	Description
Jmsx User ID	String	User identity that sends the message.
Jmsx App ID	String	Identity of the application that sends the message.
Jmsx Delivery Count	Number	Number of message delivery attempts.
Jmsx Group ID	String	Message group identity of the message.
Jmsx Group Seq	Number	Sequence number of the message in the group.
Jmsx Producer TXID	String	Identifier of the transaction that produced the message.
Jmsx Consumer TXID	String	Identifier of the transaction that consumed the message.
Jmsx Rcv Timestamp	Number	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.		x
Delivery Mode	Number	Delivery mode of the message.		x
Expiration	Number	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.		x
Priority	Number	Priority of the message, from 0-9. Higher numbers signify a higher priority.		x
Message Id	String	Unique ID of the message.
Timestamp	Number	Time a message is handed to a JMS provider to be sent, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.		x
Correlation Id	String	JMSCorrelationID header of the message.
Reply To	Service Bus JMS Destination	Destination of where a reply to this message is sent.
Type	String	Type of this destination.		x
Redelivered	Boolean	Set to `true` when the JMS provider has delivered the message at least once before.	false
Delivery Time	Number	Time the message is delivered.

### Redelivery Policy

Field	Type	Description	Default Value
Max Redelivery Count	Number	The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message
Use Secure Hash	Boolean	Whether to use a secure hash algorithm to identify a redelivered message.
Message Digest Algorithm	String	The secure hashing algorithm to use.	SHA-256
Id Expression	String	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	String	Name that identifies the destination of where to send a reply to the message.		x
Destination Type	Enumeration, one of: QUEUE TOPIC	Type of this destination.	QUEUE

### Service Bus Queue The queue is represented by an object containing the following fields:

Field	Type	Description
Author	String	Author of the ServiceBusQueue object.
Id	String	Unique identifier of the ServiceBusQueue object.
Link	String	Link of the ServiceBusQueue object.
Published	Date	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	String	Title of the ServiceBusQueue object.
Updated	Date	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
Lock Duration	String	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)).	PT1M
Max Size In Megabytes	Number	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	1024
Requires Duplicate Detection	Boolean	Settable only at queue creation time.	false
Requires Session	Boolean	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.	false
Dead Lettering On Message Expiration	Boolean	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.	false
Enable Batched Operations	Boolean	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.	true
Default Message Time To Live	String	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	String	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)).	PT10M
Max Delivery Count	Number	The maximum number of times Service Bus tries to deliver a message before being dead-lettered or discarded.	10

### 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
Id	String	Unique identifier of the ServiceBusRule object.
Link	String	Link of the ServiceBusRule object.
Published	Date	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	String	Title of the ServiceBusRule object.
Updated	Date	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
Action	Service Bus Rule Action	The action that the rule performs
Filter	Service Bus Rule Filter	The filter for the associated subscription

### Service Bus Rule Action

Field	Type	Description	Default Value	Required
Sql Expression	String	The SQL expression for the action to perform
Type	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
Correlation Id	String	The ID to match if this filter is a correlation filter
Sql Expression	String	The SQL expression for the action to perform
Type	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
Id	String	Unique identifier of the ServiceBusSubscription object.
Link	String	Link of the ServiceBusSubscription object.
Published	Date	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	String	Title of the ServiceBusSubscription object.
Updated	Date	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
Lock Duration	String	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)).	PT1M
Requires Session	Boolean	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.	false
Dead Lettering On Message Expiration	Boolean	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.	false
Dead Lettering On Filter Evaluation Exceptions	Boolean	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.	false
Enable Batched Operations	Boolean	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.	false
Default Message Time To Live	String	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	Number	The maximum number of times Service Bus tries to deliver a message before that message is dead lettered or discarded.	10

### Service Bus Topic The topic is represented by an object containing the following fields:

Field	Type	Description
Author	String	Author of the ServiceBusTopic object.
Id	String	Unique identifier of the ServiceBusTopic object.
Link	String	Link of the ServiceBusTopic object.
Published	Date	Date when the ServiceBusTopic object is published, expressed in number of milliseconds elapsed since midnight January 1, 1970, UTC.
Title	String	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.
Updated	Date	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
Max Size In Megabytes	Number	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	1024
Requires Duplicate Detection	Boolean	If enabled, the topic detects duplicate messages within the time span specified by the DuplicateDetectionHistoryTimeWindow property. Settable only at topic creation time.	false
Enable Batched Operations	Boolean	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.	true
Default Message Time To Live	String	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	String	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)).	PT10M

### Default Caching

Field	Type	Description	Default Value
Session Cache Size	Number	Number of sessions to cache.
Cache Producers	Boolean	true if the ConnectionFactory should cache the MessageProducers	true
Cache Consumers	Boolean	true if the ConnectionFactory should cache the MessageConsumers	true

### Topic Consumer

Field	Type	Description	Default Value	Required
Topic Consumer	Topic Consumer	Points to the Topic Consumer type.		x
Topic Subscription	Topic Subscription	Points to the Topic Subscription type.		x

### Topic Subscription

Field	Type	Description	Default Value	Required
Topic Path	String	Name of the topic where the subscription is created.		x
Subscription Path	String	Name of the subscription that is created.

### Service Bus Queue Consumer

Field	Type	Description	Default Value
Queue Consumer	queue-consumer	ConsumerType that marks the consumed destination as a queue.
Source Queue	String	Queue that receives events.
Number Of Consumers	Number	The number of concurrent consumers to use to receive JMS Messages	4

## See Also [Salesforce Help](https://help.salesforce.com)