Service Bus

Service Bus

Connect to Azure Service Bus to send and receive messages. You can perform actions such as send to queue, send to topic, receive from queue, receive from subscription, etc.

Creating a connection

To connect your account, you will need the following information:

Connection String
securestring
Azure Service Bus Connection String
Actions

Abandon the message in a queue

The operation abandons a message in a queue.

Required Parameters

Queue name
string
Name of the queue
Lock token of the message
string
Lock token of the message to abandon

Optional Parameters

Queue type
string
Queue type - Main or DeadLetter
Session id
string
Session id

Abandon the message in a topic subscription

The operation abandons a message in a topic subscription.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Lock token of the message
string
Lock token of the message to abandon

Optional Parameters

Subscription type
string
Subscription type - Main or DeadLetter
Session id
string
Session id

Close a session in a queue

The operation closes a session in a queue.

Required Parameters

Queue name
string
Name of a queue
Session id
string
Session id

Close a session in the topic

The operation closes a session in the topic.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Session id
string
Session id

Complete the message in a queue

The operation completes a message in a queue.

Required Parameters

Queue name
string
Name of the queue
Lock token of the message
string
Lock token of the message to complete

Optional Parameters

Queue type
string
Queue type - Main or DeadLetter
Session id
string
Session id

Complete the message in a topic subscription

The operation completes a message in a topic subscription.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Lock token of the message
string
Lock token of the message to complete

Optional Parameters

Subscription type
string
Subscription type - Main or DeadLetter
Session id
string
Session id

Create a topic subscription

The operation creates a topic subscription.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Filter
dynamic
Subscription filter

Optional Parameters

Filter type
string
Filter type

Returns

Body
Subscription

The topic subscription.

Dead-letter the message in a queue

The operation moves the message to the Dead-Letter Queue.

Required Parameters

Queue name
string
Name of the queue
Lock token of the message
string
Lock token of the message to dead-letter

Optional Parameters

Session id
string
Session id

Dead-letter the message in a topic subscription

The operation moves the message to the topic Dead-Letter Queue.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Lock token of the message
string
Lock token of the message to dead-letter

Optional Parameters

Session id
string
Session id

Defer the message in a queue

The operation defers a message in a queue.

Required Parameters

Queue name
string
Name of the queue
Lock token of the message
string
Lock token of the message to defer

Optional Parameters

Queue type
string
Queue type - Main or DeadLetter
Session id
string
Session id

Defer the message in a topic subscription

The operation defers a message in a topic subscription.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Lock token of the message
string
Lock token of the message to defer

Optional Parameters

Subscription type
string
Subscription type - Main or DeadLetter
Session id
string
Session id

Delete a topic subscription

The operation deletes a topic subscription.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription

Get deferred message from a queue

The operation gets a deferred message from a queue.

Required Parameters

Queue name
string
Name of the queue
Sequence number of message
integer
Sequence number of message

Optional Parameters

Queue type
string
Queue type - Main or DeadLetter
Session id
string
Session id

Returns

Body
ServiceBusMessage

Service Bus Message

Get deferred message from a topic subscription

The operation gets a deferred message from a topic subscription.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Sequence number of message
integer
Sequence number of message

Optional Parameters

Subscription type
string
Queue type - Main or DeadLetter
Session id
string
Session id

Returns

Body
ServiceBusMessage

Service Bus Message

Get messages from a queue (peek-lock)

The operation receives messages from a queue with peek-lock. If maximum message count is not provided, it reads 20 messages.

Required Parameters

Queue name
string
Name of the queue

Optional Parameters

Maximum message count
integer
The maximum number of messages to return in the batch
Queue type
string
Queue type - Main or DeadLetter
Session id
string
Session id

Returns

Get messages from a topic subscription (peek-lock)

The operation receives messages from a topic subscription with peek-lock. If maximum message count is not provided, it reads 20 messages.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription

Optional Parameters

Maximum message count
integer
The maximum number of messages to return in the batch
Subscription type
string
Subscription type - Main or DeadLetter
Session id
string
Session id

Returns

Renew lock on the message in a queue

The operation renews lock on a message in a queue.

Required Parameters

Queue name
string
Name of the queue
Lock token of the message
string
Lock token of the message to renew lock

Optional Parameters

Queue type
string
Queue type - Main or DeadLetter

Renew lock on the message in a topic subscription

The operation renews lock on a message in a topic subscription.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Lock token of the message
string
Lock token of the message to renew lock

Optional Parameters

Subscription type
string
Subscription type - Main or DeadLetter

Renew lock on the session in a queue

The operation renews a session in a queue.

Required Parameters

Queue name
string
Name of the queue
Session id
string
Session id

Renew lock on the session in a topic subscription

The operation renews a session in a topic subscription.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription
Session id
string
Session id

Send message

This operation sends a message to a queue or topic.

Required Parameters

Queue/Topic name
string
Name of the queue or topic

Optional Parameters

Content
byte
Content of the message
Content Type
string
Content type of the message content
Message Id
string
This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled.
To
string
Send to address
Reply To
string
Address of the queue to reply to
Reply To Session Id
string
Identifier of the session to reply to
Label
string
Application specific label
ScheduledEnqueueTimeUtc
date-time
Date and time, in UTC, when the message will be added to the queue
Session Id
string
Identifier of the session
Correlation Id
string
Identifier of the correlation
Sequence Number
integer
Identifier of the sequence number
Lock Token
string
The lock token of the message as a string.
Time To Live
integer
This is the duration, in ticks, that a message is valid. The duration starts from when the message is sent to the Service Bus.
System properties
string
System properties - None or Run Details. Run Details will add run metadata property details as custom properties in the message.

Send one or more messages

This operation sends one or more messages to a queue or topic.

Required Parameters

Queue/Topic name
string
Name of the queue or topic

Optional Parameters

Content
byte
Content of the message
Content Type
string
Content type of the message content
Message Id
string
This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled.
To
string
Send to address
Reply To
string
Address of the queue to reply to
Reply To Session Id
string
Identifier of the session to reply to
Label
string
Application specific label
ScheduledEnqueueTimeUtc
date-time
Date and time, in UTC, when the message will be added to the queue
Session Id
string
Identifier of the session
Correlation Id
string
Identifier of the correlation
Sequence Number
integer
Identifier of the sequence number
Lock Token
string
The lock token of the message as a string.
Time To Live
integer
This is the duration, in ticks, that a message is valid. The duration starts from when the message is sent to the Service Bus.
System properties
string
System properties - None or Run Details. Run Details will add run metadata property details as custom properties in the message.
Triggers

When a message is received in a queue (auto-complete)

This operation triggers a flow when a message is received in a queue and auto completes the message.

Required Parameters

Queue name
string
Name of the queue

Optional Parameters

Queue type
string
Queue type - Main or DeadLetter

Returns

Body
ServiceBusMessage

Service Bus Message

When a message is received in a queue (peek-lock)

The operation triggers a flow when a message received in a queue with peek-lock mode.

Required Parameters

Queue name
string
Name of the queue

Optional Parameters

Queue type
string
Queue type - Main or DeadLetter
Session id
string
Session id - None or Next Available or provide session id

Returns

Body
ServiceBusMessage

Service Bus Message

When a message is received in a topic subscription (auto-complete)

This operation triggers a flow when a message is received in a topic subscription and auto completes the message.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription

Optional Parameters

Subscription type
string
Subscription type - Main or DeadLetter

Returns

Body
ServiceBusMessage

Service Bus Message

When a message is received in a topic subscription (peek-lock)

The operation triggers a flow when a message received in a topic subscription with peek-lock mode.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription

Optional Parameters

Subscription type
string
Subscription type - Main or DeadLetter
Session id
string
Session id - None or Next Available or provide session id

Returns

Body
ServiceBusMessage

Service Bus Message

When one or more messages arrive in a queue (auto-complete)

The operation receives one or more messages from a queue. If maximum message count is not provided, it reads 20 messages.

Required Parameters

Queue name
string
Name of the queue

Optional Parameters

Maximum message count
integer
The maximum number of messages to return in the batch
Queue type
string
Queue type - Main or DeadLetter

Returns

Body
ServiceBusMessage

Service Bus Message

When one or more messages arrive in a queue (peek-lock)

The operation receives one or more messages from a queue with peek-lock. If maximum message count is not provided, it reads 20 messages.

Required Parameters

Queue name
string
Name of the queue

Optional Parameters

Maximum message count
integer
The maximum number of messages to return in the batch
Queue type
string
Queue type - Main or DeadLetter
Session id
string
Session id - None or Next Available or provide session id

Returns

Body
ServiceBusMessage

Service Bus Message

When one or more messages arrive in a topic (auto-complete)

The operation receives one or more messages from a topic. If maximum message count is not provided, it reads 20 messages.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription

Optional Parameters

Maximum message count
integer
The maximum number of messages to return in the batch
Subscription type
string
Subscription type - Main or DeadLetter

Returns

Body
ServiceBusMessage

Service Bus Message

When one or more messages arrive in a topic (peek-lock)

The operation receives one or more messages from a topic with peek-lock. If maximum message count is not provided, it reads 20 messages.

Required Parameters

Topic name
string
Name of the topic
Topic subscription name
string
Name of the topic subscription

Optional Parameters

Maximum message count
integer
The maximum number of messages to return in the batch
Subscription type
string
Subscription type - Main or DeadLetter
Session id
string
Session id - None or Next Available or provide session id

Returns

Body
ServiceBusMessage

Service Bus Message

Definitions

ServiceBusMessage

Service Bus Message

Content
byte
Content of the message
Content Type
string
Content type of the message content
Correlation Id
string
Identifier of the correlation
Label
string
Application specific label
Lock Token
string
The lock token of the message as a string.
Message Id
string
This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled.
Properties
object
Key-value pairs for each brokered property
Reply To
string
Address of the queue to reply to
Reply To Session Id
string
Identifier of the session to reply to
ScheduledEnqueueTimeUtc
date-time
Date and time, in UTC, when the message will be added to the queue
Sequence Number
integer
Identifier of the sequence number
Session Id
string
Identifier of the session
Time To Live
integer
This is the duration, in ticks, that a message is valid. The duration starts from when the message is sent to the Service Bus.
To
string
Send to address

Subscription

The topic subscription.

Subscription name
string
Subscription name.

Limits

NameCallsRenewal Period
API calls per connection600060 seconds