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.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions and Integration Service Environments (ISEs)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC High)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC High)
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://azure.microsoft.com/services/service-bus/

Connector in-depth

For more information about the connector, see the in-dept section.

Creating a connection

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

Name Type Description
Connection String securestring

Azure Service Bus Connection String

Throttling Limits

Name Calls Renewal Period
API calls per connection600060 seconds

Actions

Abandon the message in a queue

The operation abandons a message in a queue.

Abandon the message in a topic subscription

The operation abandons a message in a topic subscription.

Close a session in a queue

The operation closes a session in a queue.

Close a session in the topic

The operation closes a session in the topic.

Complete the message in a queue

The operation completes a message in a queue.

Complete the message in a topic subscription

The operation completes a message in a topic subscription.

Create a topic subscription

The operation creates a topic subscription.

Dead-letter the message in a queue

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

Dead-letter the message in a topic subscription

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

Defer the message in a queue

The operation defers a message in a queue.

Defer the message in a topic subscription

The operation defers a message in a topic subscription.

Delete a topic subscription

The operation deletes a topic subscription.

Get deferred message from a queue

The operation gets a deferred message from a queue.

Get deferred message from a topic subscription

The operation gets a deferred message from a topic subscription.

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.

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.

Renew lock on the message in a queue

The operation renews lock on a message in a queue.

Renew lock on the message in a topic subscription

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

Renew lock on the session in a queue

The operation renews a session in a queue.

Renew lock on the session in a topic subscription

The operation renews a session in a topic subscription.

Send message

This operation sends a message to a queue or topic.

Send one or more messages

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

Abandon the message in a queue

The operation abandons a message in a queue.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Lock token of the message
lockToken True string

Lock token of the message to abandon

Queue type
queueType string

Queue type - Main or DeadLetter

Session id
sessionId string

Session id

Abandon the message in a topic subscription

The operation abandons a message in a topic subscription.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Lock token of the message
lockToken True string

Lock token of the message to abandon

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Session id
sessionId string

Session id

Close a session in a queue

The operation closes a session in a queue.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of a queue

Session id
sessionId True string

Session id

Close a session in the topic

The operation closes a session in the topic.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Session id
sessionId True string

Session id

Complete the message in a queue

The operation completes a message in a queue.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Lock token of the message
lockToken True string

Lock token of the message to complete

Queue type
queueType string

Queue type - Main or DeadLetter

Session id
sessionId string

Session id

Complete the message in a topic subscription

The operation completes a message in a topic subscription.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Lock token of the message
lockToken True string

Lock token of the message to complete

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Session id
sessionId string

Session id

Create a topic subscription

The operation creates a topic subscription.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Filter
subscriptionFilter True dynamic

Subscription filter

Filter type
subscriptionFilterType string

Filter type

Returns

The topic subscription.

Dead-letter the message in a queue

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

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Lock token of the message
lockToken True string

Lock token of the message to dead-letter

Session id
sessionId string

Session id

Dead letter reason
deadLetterReason string

Dead letter reason

Dead letter error description
deadLetterErrorDescription string

Dead letter error description

Dead-letter the message in a topic subscription

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

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Lock token of the message
lockToken True string

Lock token of the message to dead-letter

Session id
sessionId string

Session id

Dead letter reason
deadLetterReason string

Dead letter reason

Dead letter error description
deadLetterErrorDescription string

Dead letter error description

Defer the message in a queue

The operation defers a message in a queue.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Lock token of the message
lockToken True string

Lock token of the message to defer

Queue type
queueType string

Queue type - Main or DeadLetter

Session id
sessionId string

Session id

Defer the message in a topic subscription

The operation defers a message in a topic subscription.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Lock token of the message
lockToken True string

Lock token of the message to defer

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Session id
sessionId string

Session id

Delete a topic subscription

The operation deletes a topic subscription.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Get deferred message from a queue

The operation gets a deferred message from a queue.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Sequence number of message
sequenceNumber True integer

Sequence number of message

Queue type
queueType string

Queue type - Main or DeadLetter

Session id
sessionId string

Session id

Returns

Service Bus Message

Get deferred message from a topic subscription

The operation gets a deferred message from a topic subscription.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Sequence number of message
sequenceNumber True integer

Sequence number of message

Subscription type
subscriptionType string

Queue type - Main or DeadLetter

Session id
sessionId string

Session id

Returns

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.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Maximum message count
maxMessageCount integer

The maximum number of messages to return in the batch

Queue type
queueType string

Queue type - Main or DeadLetter

Session id
sessionId 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.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Maximum message count
maxMessageCount integer

The maximum number of messages to return in the batch

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Session id
sessionId string

Session id

Returns

Renew lock on the message in a queue

The operation renews lock on a message in a queue.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Lock token of the message
lockToken True string

Lock token of the message to renew lock

Queue type
queueType 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.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Lock token of the message
lockToken True string

Lock token of the message to renew lock

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Renew lock on the session in a queue

The operation renews a session in a queue.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Session id
sessionId True string

Session id

Renew lock on the session in a topic subscription

The operation renews a session in a topic subscription.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Session id
sessionId True string

Session id

Send message

This operation sends a message to a queue or topic.

Parameters

Name Key Required Type Description
Queue/Topic name
entityName True string

Name of the queue or topic

Content
ContentData byte

Content of the message

Content Type
ContentType string

Content type of the message content

Message Id
MessageId string

This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled.

To
To string

Send to address

Reply To
ReplyTo string

Address of the queue to reply to

Reply To Session Id
ReplyToSessionId string

Identifier of the session to reply to

Label
Label string

Application specific label

ScheduledEnqueueTimeUtc
ScheduledEnqueueTimeUtc date-time

Date and time, in UTC, when the message will be added to the queue

Session Id
SessionId string

Identifier of the session

Correlation Id
CorrelationId string

Identifier of the correlation

Sequence Number
SequenceNumber integer

Identifier of the sequence number

Lock Token
LockToken string

The lock token of the message as a string.

Time To Live
TimeToLive 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
systemProperties 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.

Parameters

Name Key Required Type Description
Queue/Topic name
entityName True string

Name of the queue or topic

Content
ContentData byte

Content of the message

Content Type
ContentType string

Content type of the message content

Message Id
MessageId string

This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled.

To
To string

Send to address

Reply To
ReplyTo string

Address of the queue to reply to

Reply To Session Id
ReplyToSessionId string

Identifier of the session to reply to

Label
Label string

Application specific label

ScheduledEnqueueTimeUtc
ScheduledEnqueueTimeUtc date-time

Date and time, in UTC, when the message will be added to the queue

Session Id
SessionId string

Identifier of the session

Correlation Id
CorrelationId string

Identifier of the correlation

Sequence Number
SequenceNumber integer

Identifier of the sequence number

Lock Token
LockToken string

The lock token of the message as a string.

Time To Live
TimeToLive 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
systemProperties 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.

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.

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.

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.

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.

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.

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.

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.

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.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Queue type
queueType string

Queue type - Main or DeadLetter

Returns

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.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Queue type
queueType string

Queue type - Main or DeadLetter

Session id
sessionId string

Session id - None or Next Available or provide session id

Returns

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.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Returns

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.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Session id
sessionId string

Session id - None or Next Available or provide session id

Returns

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.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Maximum message count
maxMessageCount integer

The maximum number of messages to return in the batch

Queue type
queueType string

Queue type - Main or DeadLetter

Returns

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.

Parameters

Name Key Required Type Description
Queue name
queueName True string

Name of the queue

Maximum message count
maxMessageCount integer

The maximum number of messages to return in the batch

Queue type
queueType string

Queue type - Main or DeadLetter

Session id
sessionId string

Session id - None or Next Available or provide session id

Returns

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.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Maximum message count
maxMessageCount integer

The maximum number of messages to return in the batch

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Returns

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.

Parameters

Name Key Required Type Description
Topic name
topicName True string

Name of the topic

Topic subscription name
subscriptionName True string

Name of the topic subscription

Maximum message count
maxMessageCount integer

The maximum number of messages to return in the batch

Subscription type
subscriptionType string

Subscription type - Main or DeadLetter

Session id
sessionId string

Session id - None or Next Available or provide session id

Returns

Service Bus Message

Definitions

ServiceBusMessage

Service Bus Message

Name Path Type Description
Content
ContentData byte

Content of the message

Content Type
ContentType string

Content type of the message content

Properties
Properties object

Key-value pairs for each brokered property

Message Id
MessageId string

This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled.

To
To string

Send to address

Reply To
ReplyTo string

Address of the queue to reply to

Reply To Session Id
ReplyToSessionId string

Identifier of the session to reply to

Label
Label string

Application specific label

ScheduledEnqueueTimeUtc
ScheduledEnqueueTimeUtc date-time

Date and time, in UTC, when the message will be added to the queue

Session Id
SessionId string

Identifier of the session

Correlation Id
CorrelationId string

Identifier of the correlation

Sequence Number
SequenceNumber integer

Identifier of the sequence number

Lock Token
LockToken string

The lock token of the message as a string.

Time To Live
TimeToLive 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.

Subscription

The topic subscription.

Name Path Type Description
Subscription name
SubscriptionName string

Subscription name.