Nav

Microsoft Service Bus Connector Reference

The Service Bus Connector.

Configurations


Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types that can be provided to this configuration.

x

Encoding

String

The default encoding of the Message body to be used if the message doesn’t communicate it

Content Type

String

The default contentType of the Message body to be used if the message doesn’t communicate it

/

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances when it sees fit.

Ack Mode

Enumeration, one of:

  • IMMEDIATE

  • AUTO

  • MANUAL

  • DUPS_OK

The org.mule.jms.commons.api.config.ConsumerAckMode to use when consuming a Message Can be overridden at the message source level. This attribute has to be IMMEDIATE if transactionType is LOCAL or MULTI

AUTO

Consumer Type

The ConsumerType to be used by default when consuming a Message Can be overridden at the message source level.

Selector

String

Default selector to be used for filtering when consuming a Message Can be overridden at the message source level.

Persistent Delivery

Boolean

Sets the default value for the Message#getJMSDeliveryMode. If true, the DeliveryMode#PERSISTENT mode will be 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 will be 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

This is used to determine 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

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 the pool for reuse by the producer. If set to "-1" it will create a new connection each time.

-1

Caching Strategy

One of:

The strategy to be used for caching of Sessions and Connections

Service Namespace

String

x

Storage Account Name

String

(Optional) The account name of the Blob Storage that will be used to store large messages.

Storage Access Key

String

(Optional) The account key of the Blob Storage that will be used to store large messages.

Container Name

String

(Optional) The container name in the Blob Storage that will be used to store large messages. If this parameter is not provided a default container will be created

Shared Access Signature

String

SAS tokens provider

SharedAccessSignatureProvider

Provider instance that will provide SAS tokens when required.

SAS tokens list

Array of String

List of SAS tokens that will be used when required.

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

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 the pool for reuse by the producer. If set to "-1" it will create a new connection each time.

-1

Caching Strategy

One of:

The strategy to be used for caching of Sessions and Connections

Service Namespace

String

x

Storage Account Name

String

(Optional) The account name of the Blob Storage that will be used to store large messages.

Storage Access Key

String

(Optional) The account key of the Blob Storage that will be used to store large messages.

Container Name

String

(Optional) The container name in the Blob Storage that will be used to store large messages. If this parameter is not provided a default container will be created

Shared Access Key Name

String

x

Shared Access Key

String

x

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

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 the pool for reuse by the producer. If set to "-1", it creates a new connection each time.

-1

Caching Strategy

One of:

The strategy to be used for caching of Sessions and Connections

Service Namespace

String

x

Username

String

x

Password

String

x

Fully Qualified Domain Name

String

x

Port

String

9355

Disable SSL certificate validation

Boolean

false

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 Sources

Operations

Ack

<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

String

The name of the configuration to use.

x

Ack Id

String

The AckId of the Message to ACK

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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

String

The name of the configuration to use.

x

Queue Path

String

The name of the queue

x

Queue Description

A InternalQueueDescription object containing the desired values of the queue’s properties that will be created

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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

String

The name of the configuration to use.

x

Queue Path

String

The name of the queue

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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>

Retrieves the specified queue from the service bus instance

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Path

String

The name of the queue

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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>

Sends a message to a Queue

Parameters

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

The destination where a reply to this Message should be sent

User Properties

Object

The custom user properties that should be set to this Message

JMSX Properties

The JMSX properties that should be set to this Message

Persistent Delivery

Boolean

If true, the Message will be sent using the PERSISTENT JMSDeliveryMode

Priority

Number

The default JMSPriority value to be used when sending the message

Time To Live

Number

Defines the default time the message will be 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 be used in the timeToLive configurations

Disable Message Id

Boolean

If true, the Message will be flagged to avoid generating its MessageID

Disable Message Timestamp

Boolean

If true, the Message will be flagged to avoid generating its sent Timestamp

Delivery Delay

Number

Only used by JMS 2.0. Sets the delivery delay to be applied in order to postpone the Message delivery

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the deliveryDelay configurations

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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>

Updates the specified queue in the service bus instance

Parameters

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

A InternalQueueDescription oject containing the desired values of the queue’s properties that will be updated

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:CONNECTION_EXCEPTION

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:REST_ERROR

Queues

<servicebus:queues>

Retrieves all existing queues from the service bus instance

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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 perform a session recover when the JmsAckMode#MANUAL mode is elected while consuming the Message. As per JMS Spec, performing a session recover automatically will redeliver all the consumed messages that had not being acknowledged before this 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

A retry strategy in case of connectivity errors

For Configurations

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>

Creates a rule in the specified topic and subscription

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Rule Path

String

The name of the rule

x

Rule Description

A InternalRuleDescription object containing the desired values of the rule’s properties that will be created

#[payload]

Topic Path

String

x

Subscription Path

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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>

Deletes the specified rule from the specified topic and subscription

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Path

String

x

Subscription Path

String

x

Rule Path

String

x

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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>

Retrieves the specified rule from the specified topic and subscription

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Path

String

x

Subscription Path

String

x

Rule Path

String

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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>

Updates the specified rule from the specified topic and subscription

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Rule Description

A InternalRuleDescription object containing the desired values of the rule’s properties that will be updated

#[payload]

Topic Path

String

x

Subscription Path

String

x

Rule Path

String

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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

String

The name of the configuration to use.

x

Topic Path

String

x

Subscription Path

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Service Bus Rule

For Configurations

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

String

The name of the configuration to use.

x

Topic Path

String

The name of the topic

x

Subscription Path

String

The name of the subscription

x

Subscription Description

A InternalSubscriptionDescription object containing the desired values of the subscription’s properties that will be created

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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 the specified subscription from the specified topic

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Path

String

x

Subscription Path

String

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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 the specified subscription from the specified topic

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Path

String

x

Subscription Path

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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 the specified subscription from the specified topic

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription Description

A InternalSubscriptionDescription object containing the desired values of the subscription’s properties that will be updated

#[payload]

Topic Path

String

x

Subscription Path

String

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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

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 on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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

String

The name of the configuration to use.

x

Topic Path

String

The name of the topic

x

Topic Description

A InternalTopicDescription object containing the desired values of the topic’s properties that will be created.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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

String

The name of the configuration to use.

x

Topic Path

String

The name of the topic

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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

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 on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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

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

The destination where a reply to this Message should be sent

User Properties

Object

The custom user properties that should be set to this Message

JMSX Properties

The JMSX properties that should be set to this Message

Persistent Delivery

Boolean

If true, the Message will be sent using the PERSISTENT JMSDeliveryMode

Priority

Number

The default JMSPriority value to be used when sending the message

Time To Live

Number

Defines the default time the message will be 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 be used in the timeToLive configurations

Disable Message Id

Boolean

If true, the Message will be flagged to avoid generating its MessageID

Disable Message Timestamp

Boolean

If true, the Message will be flagged to avoid generating its sent Timestamp

Delivery Delay

Number

Only used by JMS 2.0. Sets the delivery delay to be applied in order to postpone the Message delivery

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the deliveryDelay configurations

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

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

String

The name of the configuration to use.

x

Topic Path

String

The name of the topic

x

Topic Description

A InternalTopicDescription object containing the desired values of the topic’s properties that will be updated.

#[payload]

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable on which the operation’s output will be placed

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

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

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

Selector

String

JMS selector to be used for filtering incoming messages

Number Of Consumers

Number

The number of concurrent consumers that will be used to receive JMS Messages

1

Primary Node Only

Boolean

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

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Source Type

String

x

Destination

String

x

Subscription

String

x

Content Type

String

Encoding

String

Reconnection Strategy

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

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

The destination where a reply to this Message should be sent

User Properties

Object

The custom user properties that should be set to this Message

JMSX Properties

The JMSX properties that should be set to this Message

Persistent Delivery

Boolean

Whether or not the delivery should be done with a persistent configuration

Priority

Number

The default JMSPriority value to be used when sending the message

Time To Live

Number

Defines the default time the message will be 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 be used in the timeToLive configurations

Disable Message Id

Boolean

If true, the Message will be flagged to avoid generating its MessageID

Disable Message Timestamp

Boolean

If true, the Message will be flagged to avoid generating its sent Timestamp

Delivery Delay

Number

Only used by JMS 2.0. Sets the delivery delay to be applied in order to postpone the Message delivery

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to be used in the deliveryDelay configurations

Output

Type

Message

Attributes Type

For Configurations

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

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

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Count

Number

How many reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in ms) to reconnect

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance 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 Default Value Required

Properties

x

Headers

x

Ack Id

String

Jms Message Properties

Field Type Description Default Value Required

All

Object

x

User Properties

Object

x

Jms Properties

Object

x

Jmsx Properties

x

Jmsx Properties

Field Type Description Default Value Required

Jmsx User ID

String

Jmsx App ID

String

Jmsx Delivery Count

Number

Jmsx Group ID

String

Jmsx Group Seq

Number

Jmsx Producer TXID

String

Jmsx Consumer TXID

String

Jmsx Rcv Timestamp

Number

Jms Headers

Field Type Description Default Value Required

Destination

x

Delivery Mode

Number

x

Expiration

Number

x

Priority

Number

x

Message Id

String

Timestamp

Number

x

Correlation Id

String

Reply To

Type

String

x

Redelivered

Boolean

false

Delivery Time

Number

Redelivery Policy

Field Type Description Default Value Required

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. If not set, the default is SHA-256.

Id Expression

String

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

Object Store

ObjectStore

The object store where the redelivery counter for each message is going to be stored; for example, _defaultPersistentObjectStore

Service Bus JMS Destination

Field Type Description Default Value Required

Destination

String

x

Destination Type

Enumeration, one of:

  • QUEUE

  • TOPIC

QUEUE

Service Bus Queue

Field Type Description Default Value Required

Author

String

Id

String

Link

String

Published

Date

Queue Description

Title

String

Updated

Date

Service Bus Queue Description

Field Type Description Default Value Required

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 will cause 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/batches multiple operations to the back end, in order 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 dead letter queue 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 - 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

Field Type Description Default Value Required

Id

String

Link

String

Published

Date

Rule Description

Title

String

Updated

Date

Service Bus Rule Description

Field Type Description Default Value Required

Action

Filter

Service Bus Rule Action

Field Type Description Default Value Required

Sql Expression

String

Type

Enumeration, one of:

  • SqlRuleAction

  • EmptyRuleAction

Service Bus Rule Filter

Field Type Description Default Value Required

Correlation Id

String

Sql Expression

String

Type

Enumeration, one of:

  • SqlFilter

  • TrueFilter

  • FalseFilter

  • CorrelationFilter

Service Bus Subscription

Field Type Description Default Value Required

Id

String

Link

String

Published

Date

Subscription Description

Title

String

Updated

Date

Service Bus Subscription Description

Field Type Description Default Value Required

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 collects and batches 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 dead letter queue, 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

Field Type Description Default Value Required

Author

String

Id

String

Link

String

Published

Date

Title

String

Topic Description

Updated

Date

Service Bus Topic Description

Field Type Description Default Value Required

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 in order 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 dead letter queue 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 - 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 Required

Session Cache Size

Number

Cache Producers

Boolean

true

Cache Consumers

Boolean

true

Topic Consumer

Field Type Description Default Value Required

Topic Consumer

x

Topic Subscription

x

Topic Subscription

Field Type Description Default Value Required

Topic Path

String

x

Subscription Path

String

Service Bus Queue Consumer

Field Type Description Default Value Required

Queue Consumer

queue-consumer

Source Queue

String

Number Of Consumers

Number

The number of concurrent consumers that will be used to receive JMS Messages

4