Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Microsoft Service Bus Connector Reference

The Microsoft Service Bus Connector.

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

  • Shared Access Signature

  • Username Password

  • Windows

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

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 the platform expires the instance at the exact moment when it becomes eligible. The runtime actually purges the instances as it sees fit.

Shared Access Signature Connection Type

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 in order to be reused by producer. If set to "-1" it creates a new connection every time.

-1

Service Namespace

String

x

Storage Account Name

String

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

Storage Access Key

String

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

Container Name

String

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

Shared Access Signature

String

SAS tokens provider

SharedAccessSignatureProvider

SAS tokens list

Array of String

Reconnection

Reconnection

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

Username Password Connection Type

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 in order to be reused by producer. If set to "-1" it creates a new connection everytime.

-1

Service Namespace

String

x

Storage Account Name

String

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

Storage Access Key

String

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

Container Name

String

(Optional) The container name in the Blob Storage that is used 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

Reconnection

Reconnection

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

Windows Connection Type

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 in order to be reused by producer. If set to "-1", it creates a new connection every time.

-1

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

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

Operations

  • Acknowledge Message

  • Associated Sources

  • Queue Create

  • Queue Delete

  • Queue Get

  • Queue Send

  • Queue Update

  • Queues List

  • Rule Create

  • Rule Delete

  • Rule Get

  • Rule Update

  • Rules List

  • Subscription Create

  • Subscription Delete

  • Subscription Get

  • Subscription Update

  • Subscriptions List

  • Topic Create

  • Topic Delete

  • Topic Get

  • Topic Send

  • Topic Update

  • Topics List

Associated Sources

  • Queue Receive

  • Topic Receive

Acknowledge Message

<servicebus:acknowledge-message>

Acknowledges an AQMP message.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Amqp Message

AmqpMessage

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

ServiceBusQueueDescription

A ServiceBusQueueDescription object containing the desired values of the queue’s properties to create.

#[payload]

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusQueue

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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.

x

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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.

x

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusQueue

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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 destination of the message.

x

Body

Any

The content of the message.

#[payload]

Header

AmqpHeader

The supported Header fields defined in the AMQP 1.0 standard.

Properties

AmqpProperties

The supported AMQP properties defined in the AMQP 1.0 Standard.

Application Properties

Object

The Map of application properties

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

ServiceBusQueueDescription

A ServiceBusQueueDescription object containing the desired values of the queue’s properties to update.

#[payload]

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusQueue

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

Queues List

<servicebus:queues-list>

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

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of ServiceBusQueue

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

ServiceBusRuleDescription

A ServiceBusRuleDescription object containing the desired values of the rule’s properties to create.

#[payload]

Topic Path

String

x

Subscription Path

String

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusRule

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusRule

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

ServiceBusRuleDescription

A ServiceBusRuleDescription object containing the desired values of the rule’s properties to update.

#[payload]

Topic Path

String

x

Subscription Path

String

x

Rule Path

String

x

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusRule

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

Rules List

<servicebus:rules-list>

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

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of ServiceBusRule

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

ServiceBusSubscriptionDescription

A ServiceBusSubscriptionDescription object containing the desired values of the subscription’s properties to create.

#[payload]

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusSubscription

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusSubscription

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

ServiceBusSubscriptionDescription

A ServiceBusSubscriptionDescription object containing the desired values of the subscription’s properties to update.

#[payload]

Topic Path

String

x

Subscription Path

String

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusSubscription

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

Subscriptions List

<servicebus:subscriptions-list>

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

x

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of ServiceBusSubscription

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

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

ServiceBusTopicDescription

A ServiceBusTopicDescription object containing the desired values of the topic’s properties that is created.

#[payload]

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusTopic

For Configurations

  • config

Throws

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:UNSUPPORTED_UTF_8

  • 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

x

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:UNSUPPORTED_UTF_8

  • 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

x

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusTopic

For Configurations

  • config

Throws

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:UNSUPPORTED_UTF_8

  • 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 destination of the message.

x

Body

Any

The content of the message.

#[payload]

Header

AmqpHeader

The supported Header fields defined in the AMQP 1.0 standard

Properties

AmqpProperties

The supported AMQP properties defined in the AMQP 1.0 Standard.

Application Properties

Object

The Map of application properties

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:UNSUPPORTED_UTF_8

  • 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

ServiceBusTopicDescription

A ServiceBusTopicDescription object containing the desired values of the topic’s properties to update.

#[payload]

Target Variable

String

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type ServiceBusTopic

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

Topics List

<servicebus:topics-list>

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

A variable that stores the output of the operation.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of ServiceBusTopic

For Configurations

  • config

Throws

  • SERVICEBUS:AMQP_ERROR

  • SERVICEBUS:CONNECTIVITY

  • SERVICEBUS:INVALID_PROPERTY

  • SERVICEBUS:INVALID_TOKEN

  • SERVICEBUS:REST_ERROR

  • SERVICEBUS:RETRY_EXHAUSTED

  • SERVICEBUS:UNKNOWN

  • SERVICEBUS:UNSUPPORTED_UTF_8

Sources

Queue Receive

<servicebus:queue-receive>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Source Queue

String

x

Disable auto-acknowledge

Boolean

If you do not auto-acknowledge messages, you can do so manually with the acknowledgeMessage operation.

false

Primary Node Only

Boolean

Whether to execute this source in the primary cluster node.

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type AmqpMessage

Attributes Type

Object

For Configurations

  • config

Topic Receive

<servicebus:topic-receive>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Disable auto-acknowledge

Boolean

If you do not auto-acknowledge messages, you can do so manually with the acknowledgeMessage operation.

false

Primary Node Only

Boolean

Whether to execute this source in the primary cluster node.

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Topic Path

String

x

Subscription Path

String

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type AmqpMessage

Attributes Type

Object

For Configurations

  • config

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

  • reconnect

  • reconnect-forever

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.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum duration to allow a dynamic configuration instance 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.

AMQP Message

Field Type Description Default Value Required

Application Properties

Object

Body

Any

Header

AmqpHeader

Jms Message

Any

Properties

AmqpProperties

AMQP Header

Field Type Description Default Value Required

Delivery Count

Number

Durable

Boolean

Priority

Number

Ttl

Number

AMQP Properties

Field Type Description Default Value Required

Content Type

String

Correlation Id

String

Message Id

String

Reply To

String

Subject

String

To

String

User Id

String

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.

Service Bus Queue

Field Type Description Default Value Required

Author

String

Id

String

Link

String

Published

Date

Queue Description

ServiceBusQueueDescription

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 is session-aware and only SessionReceiver is 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 and 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 Dead Lettering 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 to 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 sent to the dead letter queue or discarded.

10

Service Bus Rule

Field Type Description Default Value Required

Id

String

Link

String

Published

Date

Rule Description

ServiceBusRuleDescription

Title

String

Updated

Date

Service Bus Rule Description

Field Type Description Default Value Required

Action

ServiceBusRuleAction

Filter

ServiceBusRuleFilter

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

ServiceBusSubscriptionDescription

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 to 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 is session-aware and only SessionReceiver is 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. The exception 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 or 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 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

ServiceBusTopicDescription

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 causes 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 or 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 DeadLtterQueue or is 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 to 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