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/ |
Infinite loops
Use caution when you select both a trigger and action that have the same connector type and use them to work with the same entity, such as a queue or topic subscription. This combination can create an infinite loop, which results in a workflow that never ends.
For example, suppose your workflow uses a Service Bus trigger that returns a newly received message in a queue and follows that trigger with a Service Bus action that sends a message back to the same queue. This pattern can create an infinite loop, causing an unending workflow.
Limit on saved sessions in connector cache
Per Service Bus messaging entity, such as a subscription or topic, the Service Bus connector can save up to 1,500 unique sessions at a time to the connector cache. If the session count exceeds this limit, old sessions are removed from the cache. For more information, see Message sessions.
Long-polling triggers
For the Azure Service Bus managed connector, all triggers are long-polling. This trigger type processes all the messages and then waits 30 seconds for more messages to appear in the queue or topic subscription. If no messages appear in 30 seconds, the trigger run is skipped. Otherwise, the trigger continues reading messages until the queue or topic subscription is empty. The next trigger poll is based on the recurrence interval specified in the trigger's properties.
To use Microsoft Entra ID authentication, the user account requires a specific role assignment. For more information, see Assign an Azure role for access rights - Azure Service Bus.
Currently, managed identity authentication is supported only for Azure Logic Apps.
To use a managed identity that authenticates access from your logic app workflow to your Service Bus namespace and messaging entity, make sure that you assign role permissions at the corresponding levels. For example, to access a queue, the managed identity requires a role that has the necessary permissions for that queue.
Each managed identity that accesses a different messaging entity should have a separate connection to that entity. If you use different Azure Service Bus actions to send and receive messages, and those actions require different permissions, make sure to use different connections.
To enable a managed identity for use with Azure Service Bus, follow these high-level steps:
Enable or create the managed identity for your logic app resource. For more information, see Authenticate access to Azure resources with managed identities in Azure Logic Apps.
Give the identity access to Azure Service Bus resources. For more information, see Assign an Azure role for access rights - Azure Service Bus
For a user-assigned identity, add the identity to the logic app resource. For more information about managed identities in Azure Logic Apps, see Authenticate access to Azure resources using managed identities in Azure Logic Apps
This article describes the operations for the Azure Service Bus managed connector, which is available for Azure Logic Apps, Power Automate, and Power Apps. The Azure Service Bus built-in connector is available only for Standard logic app workflows in Azure Logic Apps.
For more information about the Azure Service Bus built-in connector and managed connector in Azure Logic Apps, see Connect to Azure Service Bus from workflows in Azure Logic Apps.
The connector supports the following authentication types:
Access Key | Provide connection string to access your Azure Service Bus. | All regions except Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) and US Government (GCC-High) | Not shareable |
Access Key (Azure Government) | Provide connection string to access your Azure Service Bus. | Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) and US Government (GCC-High) only | Not shareable |
Azure AD Integrated | Use Azure Active Directory to access your Azure Service Bus. | MOONCAKE only | Not shareable |
Azure AD Integrated (Azure Government) | Use Azure Active Directory to access your Azure Service Bus. | Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) and US Government (GCC-High) only | Not shareable |
Logic Apps Managed Identity | Create a connection using a LogicApps Managed Identity | LOGICAPPS only | Shareable |
Microsoft Entra ID Integrated | Use Microsoft Entra ID to access your Azure Service Bus. | All regions except Azure Government and Department of Defense (DoD) in Azure Government and MOONCAKE and US Government (GCC) and US Government (GCC-High) | Not shareable |
Default [DEPRECATED] | This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. | All regions | Not shareable |
Auth ID: connectionstringauth
Applicable: All regions except Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) and US Government (GCC-High)
Provide connection string to access your Azure Service Bus.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Connection String | securestring | Azure Service Bus Connection String | True |
Auth ID: connectionstringauth
Applicable: Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) and US Government (GCC-High) only
Provide connection string to access your Azure Service Bus.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Connection String | securestring | Azure Service Bus Connection String | True |
Auth ID: aadAuth
Applicable: MOONCAKE only
Use Azure Active Directory to access your Azure Service Bus.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Namespace Endpoint | string | Provide Service Bus Namespace Endpoint (e.g: sb://testsb.servicebus.windows.net/) | True |
Auth ID: aadAuth
Applicable: Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) and US Government (GCC-High) only
Use Azure Active Directory to access your Azure Service Bus.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Namespace Endpoint | string | Provide Service Bus Namespace Endpoint (e.g: sb://testsb.servicebus.windows.net/) | True |
Auth ID: managedIdentityAuth
Applicable: LOGICAPPS only
Create a connection using a LogicApps Managed Identity
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
Name | Type | Description | Required |
---|---|---|---|
LogicApps Managed Identity | managedIdentity | Sign in with a Logic Apps Managed Identity | True |
Namespace Endpoint | string | Provide Service Bus Namespace Endpoint (e.g: sb://testsb.servicebus.windows.net/) | True |
Auth ID: aadAuth
Applicable: All regions except Azure Government and Department of Defense (DoD) in Azure Government and MOONCAKE and US Government (GCC) and US Government (GCC-High)
Use Microsoft Entra ID to access your Azure Service Bus.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Namespace Endpoint | string | Provide Service Bus Namespace Endpoint (e.g: sb://testsb.servicebus.windows.net/) | True |
Applicable: All regions
This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Connection String | securestring | Azure Service Bus Connection String | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 6000 | 60 seconds |
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. |
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 |
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 |
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 |
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 |
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 |
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 |
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.
- Body
- Subscription
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 |
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 |
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 |
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 |
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 |
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
- Body
- ServiceBusMessage
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
- Body
- ServiceBusMessage
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
- response
- array of ServiceBusMessage
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
- response
- array of ServiceBusMessage
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 |
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 |
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 |
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 |
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 |
|
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. |
|
System properties
|
systemProperties | string |
System properties - None or Run Details. Run Details will add run metadata property details as custom properties in the message. |
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 |
|
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. |
|
System properties
|
systemProperties | string |
System properties - None or Run Details. Run Details will add run metadata property details as custom properties in the message. |
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. |
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
- Body
- ServiceBusMessage
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
- Body
- ServiceBusMessage
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
- Body
- ServiceBusMessage
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
- Body
- ServiceBusMessage
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
- Body
- ServiceBusMessage
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
- Body
- ServiceBusMessage
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
- Body
- ServiceBusMessage
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
- Body
- 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. |
The topic subscription.
Name | Path | Type | Description |
---|---|---|---|
Subscription name
|
SubscriptionName | string |
Subscription name. |