Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.7.0 or higher

Configs

Connection string

<microsoft-azure-service-bus:connectionStringConfig>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

namespace

String

x 

connectionString

String

x 

skipConnectivityTest

boolean

false

 

Username password

<microsoft-azure-service-bus:usernamePasswordConfig>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

namespace

String

x 

userName

String

x 

password

String

x 

skipConnectivityTest

boolean

false

 

Shared access signature

<microsoft-azure-service-bus:sharedAccessSignatureConfig>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

namespace

String

x 

tokens

List<String>

x 

skipConnectivityTest

boolean

false

 

Processors

Queue send

<microsoft-azure-service-bus:queue-send>

  DataSense enabled

Sends a message to a Queue

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queue

String

Queue name to send message.

x 

async

boolean

True if the message will be send in Asynchronous mode. Default value False.

false

 

message

Message

Object that represent message (properties and content).

#[payload]

 

Queue send batch

<microsoft-azure-service-bus:queue-send-batch>

  DataSense enabled

Sends a list of messages to a Queue

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queue

String

Queue name to send message.

x 

messages

List

List of Objects that represents messages (properties and contents).

#[payload]

 

async

boolean

True if the message will be send in Asynchronous mode. Default value False.

false

 

Returns

Return Java Type Description

BulkOperationResult

Topic send

<microsoft-azure-service-bus:topic-send>

  DataSense enabled

Sends a message to a Topic

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topic

String

Topic name to send message.

x 

async

boolean

True if the message will be send in Asynchronous mode. Default value False.

false

 

message

Message

Object that represent message (properties and content).

#[payload]

 

Topic send batch

<microsoft-azure-service-bus:topic-send-batch>

  DataSense enabled

Sends a list of messages to a Topic

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topic

String

Topic name to send message.

x 

messages

List

List of Objects that represents messages (properties and contents).

#[payload]

 

async

boolean

True if the message will be send in Asynchronous mode. Default value False.

false

 

Returns

Return Java Type Description

BulkOperationResult

Ack message

<microsoft-azure-service-bus:ack-message>

ACK message stored in a particular receiver

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

lockToken

String

Message lock token to ACK

x 

async

boolean

True if the message will be ACK in Asynchronous mode. Default value False.

false

 

Abandon message

<microsoft-azure-service-bus:abandon-message>

Abandon message Async stored in a particular receiver

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

lockToken

String

Message lock token to Abandon

x 

async

boolean

True if the message will be Abandon in Asynchronous mode. Default value False.

false

 

List queues

<microsoft-azure-service-bus:list-queues>

Retrieves all existing listQueues from the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List

A List of ServiceBusQueue Object containing every existing queue

Queue get

<microsoft-azure-service-bus:queue-get>

  DataSense enabled

Retrieves the specified queue from the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queuePath

String

The name of the queue

x 

Returns

Return Java Type Description

ServiceBusQueue

A ServiceBusQueue Object containing the representation of the queue retrieved

Queue create

<microsoft-azure-service-bus:queue-create>

Creates a queue in the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queuePath

String

The name of the queue

x 

queueDescription

ServiceBusQueueDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusQueue

A ServiceBusQueue Object containing the representation of the queue created

Queue update

<microsoft-azure-service-bus:queue-update>

  DataSense enabled

Updates the specified queue in the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queuePath

String

The name of the queue

x 

queueDescription

ServiceBusQueueDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusQueue

ServiceBusQueue

Queue delete

<microsoft-azure-service-bus:queue-delete>

  DataSense enabled

Deletes the specified queue in the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queuePath

String

The name of the queue

x 

List topics

<microsoft-azure-service-bus:list-topics>

Retrieves all existing listTopics from the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List

A List of ServiceBusTopic Object containing every existing topic

Topic get

<microsoft-azure-service-bus:topic-get>

  DataSense enabled

Retrieves the specified topic from the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

Returns

Return Java Type Description

ServiceBusTopic

A ServiceBusTopic Object containing the representation of the retrieved topic

Topic create

<microsoft-azure-service-bus:topic-create>

Creates a topic in the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

topicDescription

ServiceBusTopicDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusTopic

A ServiceBusTopic Object containing the representation of the created topic

Topic update

<microsoft-azure-service-bus:topic-update>

  DataSense enabled

Updates the specified topic from the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

topicDescription

ServiceBusTopicDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusTopic

A ServiceBusTopic Object containing the representation of the retrieved topic

Topic delete

<microsoft-azure-service-bus:topic-delete>

  DataSense enabled

Deletes the specified topic from the service bus instance

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

List subscriptions

<microsoft-azure-service-bus:list-subscriptions>

  DataSense enabled

Retrieves all listSubscriptions from the specified topic

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicPath

String

The name of the topic

x 

Returns

Return Java Type Description

List

A List of ServiceBusSubscription Object containing every existing subscription in the topic

Subscription get

<microsoft-azure-service-bus:subscription-get>

  DataSense enabled

Retrieves the specified subscription from the specified topic

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

path

String

The name of the topic

x 

Returns

Return Java Type Description

ServiceBusSubscription

A ServiceBusSubscription Object containing the representation of the retrieved subscription

Subscription create

<microsoft-azure-service-bus:subscription-create>

  DataSense enabled

Creates a subscription in the specified topic

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topic

String

The name of the topic

x 

subscription

String

The name of the subscription

x 

subscriptionDescription

ServiceBusSubscriptionDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusSubscription

A ServiceBusSubscription Object containing the representation of the created subscription

Subscription update

<microsoft-azure-service-bus:subscription-update>

  DataSense enabled

Updates the specified subscription from the specified topic

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

path

String

The name of the topic and subscription

x 

subscriptionDescription

ServiceBusSubscriptionDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusSubscription

A ServiceBusSubscription Object containing the representation of the updated subscription

Subscription delete

<microsoft-azure-service-bus:subscription-delete>

  DataSense enabled

Deletes the specified subscription from the specified topic

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

path

String

The name of the topic and subscription

x 

List rules

<microsoft-azure-service-bus:list-rules>

  DataSense enabled

Retrieves all listRules from the specified topic and subscription

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

path

String

The name of the topic

x 

Returns

Return Java Type Description

List

A List of ServiceBusRule Object containing every existing rule in the specified subscription and topic

Rule get

<microsoft-azure-service-bus:rule-get>

  DataSense enabled

Retrieves the specified rule from the specified topic and subscription

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

path

String

The name of the topic/subscription/rule

x 

Returns

Return Java Type Description

ServiceBusRule

A ServiceBusRule Object containing the representation of the retrieved rule

Rule create

<microsoft-azure-service-bus:rule-create>

  DataSense enabled

Creates a rule in the specified topic and subscription

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

path

String

The name of the topic

x 

ruleName

String

The name of the rule to create

x 

ruleDescription

ServiceBusRuleDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusRule

A ServiceBusRule Object containing the representation of the created rule

Rule update

<microsoft-azure-service-bus:rule-update>

  DataSense enabled

Updates the specified rule from the specified topic and subscription

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

path

String

The name of the topic/subscription/path

x 

ruleDescription

ServiceBusRuleDescription

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

#[payload]

 

Returns

Return Java Type Description

ServiceBusRule

A ServiceBusRule Object containing the representation of the updated rule

Rule delete

<microsoft-azure-service-bus:rule-delete>

  DataSense enabled

Deletes the specified rule from the specified topic and subscription

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

path

String

The name of the topic/subscription/rule

x 

Sources

Queue receive

<microsoft-azure-service-bus:queue-receive>

Receive messages from specific queue, returns Message received in callback

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

callback

SourceCallback

mule object to retrieve message received.

x 

queue

String

queue name to listen.

x 

receiveOnlyFromDeadLetterQueue

boolean

if true, listen only from dead letter queue of that entity.

false

 

ackMode

ReceiveMode

CLIENT: user has to Manual ACK messages or Abandon them. AUTOACK: message is ACK from queue and deleted from it when is received.

x 

serverTimeout

Integer

Specify a connection time in seconds to the server (it will wait until a message is available or returns null other case). Default time 60 seconds.

60

 

prefetchCount

Integer

When Prefetch is enabled in any of the official Service Bus clients, the receiver quietly acquires more messages, up to the PrefetchCount limit, beyond what the application initially asked for. Setting this to 0 will disable prefetching.

100

 

unixCronExpression

String

UNIX cron expression that represent the time to trigger the receiver action. For example '0 0 * * *' (whitout quotes) will receive message at 00:00 every day.

 

maxMessagesToReceive

Integer

Maximum number of messages to receive during the scheduled task. Default 100.

100

 

Returns

Return Java Type Description

void

Topic receive

<microsoft-azure-service-bus:topic-receive>

Receive messages from specific subscription, returns Message received in callback

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

callback

SourceCallback

mule object to retrieve message received

x 

topic

String

topic name to listen

x 

subscription

String

subscription name to listen

x 

receiveOnlyFromDeadLetterQueue

boolean

if true, listen only from dead letter queue of that entity.

false

 

ackMode

ReceiveMode

CLIENT: user has to Manual ACK messages or Abandon AUTOACK: message is ACK from queue and deleted from it when is received

x 

serverTimeout

Integer

Specify a connection time in seconds to the server (it will wait until a message is available or returns null other case). Default time 60 seconds

60

 

prefetchCount

Integer

When Prefetch is enabled in any of the official Service Bus clients, the receiver quietly acquires more messages, up to the PrefetchCount limit, beyond what the application initially asked for. Setting this to 0 will disable prefetching.

100

 

unixCronExpression

String

UNIX cron expression that represent the time to trigger the receiver action. For example '0 0 * * *' (whitout quotes) will receive message at 00:00 every day.

 

maxMessagesToReceive

Integer

Maximum number of messages to receive during the scheduled task. Default 100.

100

 

Returns

Return Java Type Description

void