Contact Free trial Login

Microsoft Service Bus Connector 2.2 Reference - Mule 4

Support Category: Select

This connector supports connecting only to the Microsoft Windows Service Bus on-premises solution. To connect to Microsoft Azure Service Bus, use Anypoint Connector for Azure Service Bus.

Configurations


Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

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

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

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:

Strategy to use for caching sessions and connections

Service Namespace

String

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

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

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:

The strategy to use for caching sessions and connections

Service Namespace

String

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

x

Shared Access Key

String

x

Proxy

Security

TLS

Advanced

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

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:

The strategy to use for caching 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

Idle timeout

Number

The idle timeout in milliseconds after which the connection fails if the peer sends no AMQP frames.

60000

Proxy

Security

TLS

Advanced

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

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

Operations

Associated Sources

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

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

Types

Proxy

Field Type Description Default Value Required

Host

String

Host of the proxy

Port

String

Port of the proxy

Username

String

Username of the proxy

Password

String

Password for the proxy

Advanced

Name Type Description Default Value Required

Read Timeout

Number

Amount of time that the client waits for a response before it times out. Zero (0) specifies that the client waits indefinitely.

60000

Read Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Read Timeout.

MILLISECONDS

 

Connection Timeout

Number

The amount of time that the client attempts to establish a connection before it times out. Zero (0) specifies that the client continues to attempt to open a connection indefinitely.

60000

 

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Connection Timeout

MILLISECONDS

 

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

Location, which is resolved relative to the current classpath and file system if possible, of the truststore

Password

String

Password used to protect the truststore

Type

String

Type of store used

Algorithm

String

Algorithm used by the truststore

Insecure

Boolean

If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

Location, which is resolved relative to the current classpath and file system, if possible, of the keystore

Type

String

Type of store used

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.

Key Password

String

Password used to protect the private key

Password

String

Password used to protect the keystore

Algorithm

String

Algorithm used by the keystore

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not previously selected).

Soft Fail

Boolean

Avoid verification failure when the revocation server can’t be reached or is busy.

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

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

A retry strategy in case of connectivity errors

Output

Type

Service Bus Queue

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

Name of the configuration to use

x

Queue Path

String

Name of the queue

#[payload]

Reconnection Strategy

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>

This operation retrieves the specified queue from the Service Bus instance.

Parameters

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

Retry strategy in case of connectivity errors

Output

Type

Service Bus Queue

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>

This operation 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 to set for this message

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

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>

This operation 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

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

A retry strategy in case of connectivity errors.

Output

Type

Service Bus Queue

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>

This operation 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 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

A retry strategy in case of connectivity errors.

Output

Type

Array of Service Bus Queue

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 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

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>

This operation creates a rule for the specified topic and subscription.

Parameters

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

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

A retry strategy in case of connectivity errors

Output

Type

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

Rule Delete

<servicebus:rule-delete>

This operation deletes a rule from the specified topic and subscription.

Parameters

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 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

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>

This operation retrieves a rule from the specified topic and subscription.

Parameters

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

A retry strategy in case of connectivity errors

Output

Type

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

Rule Update

<servicebus:rule-update>

This operation updates a 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

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

A retry strategy in case of connectivity errors

Output

Type

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

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

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

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 to contain the new subscription

x

Subscription Path

String

The name of the subscription to create

x

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

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 a 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

The name of the topic from which to delete the subscription

x

Subscription Path

String

The name of the subscription to delete

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 a 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

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

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

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

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 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

A retry strategy in case of connectivity errors.

Output

Type

Array of Service Bus Subscription

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

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

A retry strategy in case of connectivity errors.

Output

Type

Service Bus Topic

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 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

A retry strategy in case of connectivity errors.

Output

Type

Service Bus Topic

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 to set for this message

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

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

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

A retry strategy in case of connectivity errors.

Output

Type

Service Bus Topic

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 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

A retry strategy in case of connectivity errors.

Output

Type

Array of Service Bus Topic

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

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

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 to set for this message

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

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 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 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.

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

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 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

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

The action that the rule performs

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

  • EmptyRuleAction

Service Bus Rule Filter

Field Type Description Default Value Required

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

  • 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 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

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 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 Required

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

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 to use to receive JMS Messages

4