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.
Status: Production |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
Get all queues |
|
Get all topics |
|
Get the subscriptions for a topic |
|
Get all entities |
|
Get the list of system properties |
|
Get session options |
|
Send message |
|
SendMessages (string entityName, array messages, [advanced][Optional]string systemProperties) |
Send one or more messages |
Complete the message in a queue |
|
Abandon the message in a queue |
|
Get deferred message from a queue |
|
Defer the message in a queue |
|
Dead-letter the message in a queue |
|
RenewLockOnMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType) |
Renew lock on the message in a queue |
Get messages from a queue (peek-lock) |
|
Close a session in a queue |
|
RenewLockOnSessionInQueue (string queueName, string sessionId) |
Renew lock on the session in a queue |
Complete the message in a topic subscription |
|
Abandon the message in a topic subscription |
|
Get deferred message from a topic subscription |
|
Defer the message in a topic subscription |
|
Dead-letter the message in a topic subscription |
|
Renew lock on the message in a topic subscription |
|
Create a topic subscription |
|
DeleteTopicSubscription (string topicName, string subscriptionName) |
Delete a topic subscription |
Get messages from a topic subscription (peek-lock) |
|
CloseSessionInTopic (string topicName, string subscriptionName, string sessionId) |
Close a session in the topic |
RenewLockOnSessionInTopic (string topicName, string subscriptionName, string sessionId) |
Renew lock on the session in a topic subscription |
Get metadata of a filter |
|
Get metadata of a filter |
Name |
Summary |
GetMessageFromQueue (string queueName, [advanced][Optional]string queueType) |
When a message is received in a queue (auto-complete) |
When a message is received in a queue (peek-lock) |
|
When one or more messages arrive in a queue (auto-complete) |
|
When one or more messages arrive in a queue (peek-lock) |
|
When a message is received in a topic subscription (auto-complete) |
|
When a message is received in a topic subscription (peek-lock) |
|
When one or more messages arrive in a topic (auto-complete) |
|
When one or more messages arrive in a topic (peek-lock) |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get all queues
Description: This operation gets all queues in the Service Bus namespace.
Syntax:
ServiceBus.GetQueues ()
Returns:
Type:array of (string)
Summary: Get all topics
Description: This operation gets all topics in the Service Bus namespace.
Syntax:
ServiceBus.GetTopics ()
Returns:
Type:array of (string)
Summary: Get the subscriptions for a topic
Description: This operation gets the list of subscriptions for a topic in the Service Bus namespace.
Syntax:
ServiceBus.GetSubscriptions (string topicName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Topic name |
True |
Returns:
Type:array of (string)
Summary: Get all entities
Description: This operation gets all queues and topics in the Service Bus namespace.
Syntax:
ServiceBus.GetEntities ()
Returns:
Type:array of (ServiceBusEntity)
Summary: Get the list of system properties
Description: This operation gets list of properties.
Syntax:
ServiceBus.GetSystemProperties ()
Returns:
Type:array of (string)
Summary: Get session options
Description: This operation gets the list of options for session handling - None, Next available.
Syntax:
ServiceBus.GetSessionOptions ()
Returns:
Type:array of (string)
Summary: Send message
Description: This operation sends a message to a queue or topic.
Syntax:
ServiceBus.SendMessage (string entityName, ServiceBusMessage message, [advanced][Optional]string systemProperties)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
entityName |
string (Queue/Topic name) |
Name of the queue or topic |
True |
|
message |
|
Service Bus Message |
True |
|
systemProperties |
string (System properties) |
System properties - None or Run Details. Run Details will add run metadata property details as custom properties in the message. |
False |
Returns:
Summary: Send one or more messages
Description: This operation sends one or more messages to a queue or topic.
Syntax:
ServiceBus.SendMessages (string entityName, array messages, [advanced][Optional]string systemProperties)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
entityName |
string (Queue/Topic name) |
Name of the queue or topic |
True |
|
messages |
array of (ServiceBusMessage)
|
|
True |
|
systemProperties |
string (System properties) |
System properties - None or Run Details. Run Details will add run metadata property details as custom properties in the message. |
False |
Returns:
Summary: Complete the message in a queue
Description: The operation completes a message in a queue.
Syntax:
ServiceBus.CompleteMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to complete |
True |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Summary: Abandon the message in a queue
Description: The operation abandons a message in a queue.
Syntax:
ServiceBus.AbandonMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to abandon |
True |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Summary: Get deferred message from a queue
Description: The operation gets a deferred message from a queue.
Syntax:
ServiceBus.GetDeferredMessageFromQueue (string queueName, integer sequenceNumber, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
sequenceNumber |
integer(int64) (Sequence number of message) |
Sequence number of message |
True |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Type:ServiceBusMessage
Description: Service Bus Message
Summary: Defer the message in a queue
Description: The operation defers a message in a queue.
Syntax:
ServiceBus.DeferMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to defer |
True |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Summary: Dead-letter the message in a queue
Description: The operation moves the message to the Dead-Letter Queue.
Syntax:
ServiceBus.DeadLetterMessageInQueue (string queueName, string lockToken, [advanced][Optional]string sessionId, [Optional]string deadLetterReason, [Optional]string deadLetterErrorDescription)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to dead-letter |
True |
|
sessionId |
string (Session id) |
Session id |
False |
|
deadLetterReason |
string (Dead letter reason) |
Dead letter reason |
False |
|
deadLetterErrorDescription |
string (Dead letter error description) |
Dead letter error description |
False |
Returns:
Summary: Renew lock on the message in a queue
Description: The operation renews lock on a message in a queue.
Syntax:
ServiceBus.RenewLockOnMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to renew lock |
True |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
Returns:
Summary: Get messages from a queue (peek-lock)
Description: The operation receives messages from a queue with peek-lock. If maximum message count is not provided, it reads 20 messages.
Syntax:
ServiceBus.GetMessagesFromQueueWithPeekLock (string queueName, [Optional]integer maxMessageCount, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
maxMessageCount |
integer(int32) (Maximum message count) |
The maximum number of messages to return in the batch |
False |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Type:array of (ServiceBusMessage)
Summary: Close a session in a queue
Description: The operation closes a session in a queue.
Syntax:
ServiceBus.CloseSessionInQueue (string queueName, string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of a queue |
True |
|
sessionId |
string (Session id) |
Session id |
True |
Returns:
Summary: Renew lock on the session in a queue
Description: The operation renews a session in a queue.
Syntax:
ServiceBus.RenewLockOnSessionInQueue (string queueName, string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
sessionId |
string (Session id) |
Session id |
True |
Returns:
Summary: Complete the message in a topic subscription
Description: The operation completes a message in a topic subscription.
Syntax:
ServiceBus.CompleteMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to complete |
True |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Summary: Abandon the message in a topic subscription
Description: The operation abandons a message in a topic subscription.
Syntax:
ServiceBus.AbandonMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to abandon |
True |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Summary: Get deferred message from a topic subscription
Description: The operation gets a deferred message from a topic subscription.
Syntax:
ServiceBus.GetDeferredMessageFromTopic (string topicName, string subscriptionName, integer sequenceNumber, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
sequenceNumber |
integer(int64) (Sequence number of message) |
Sequence number of message |
True |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Type:ServiceBusMessage
Description: Service Bus Message
Summary: Defer the message in a topic subscription
Description: The operation defers a message in a topic subscription.
Syntax:
ServiceBus.DeferMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to defer |
True |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Summary: Dead-letter the message in a topic subscription
Description: The operation moves the message to the topic Dead-Letter Queue.
Syntax:
ServiceBus.DeadLetterMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string sessionId, [Optional]string deadLetterReason, [Optional]string deadLetterErrorDescription)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to dead-letter |
True |
|
sessionId |
string (Session id) |
Session id |
False |
|
deadLetterReason |
string (Dead letter reason) |
Dead letter reason |
False |
|
deadLetterErrorDescription |
string (Dead letter error description) |
Dead letter error description |
False |
Returns:
Summary: Renew lock on the message in a topic subscription
Description: The operation renews lock on a message in a topic subscription.
Syntax:
ServiceBus.RenewLockOnMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string subscriptionType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
lockToken |
string (Lock token of the message) |
Lock token of the message to renew lock |
True |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
Returns:
Summary: Create a topic subscription
Description: The operation creates a topic subscription.
Syntax:
ServiceBus.CreateTopicSubscription (string topicName, string subscriptionName, CreateTopicSubscriptionParameterSubscriptionFilter subscriptionFilter, [advanced][Optional]string subscriptionFilterType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
subscriptionFilter |
CreateTopicSubscriptionParameterSubscriptionFilter
|
|
True |
|
subscriptionFilterType |
string (Filter type)Values: [None, Correlation] |
Filter type |
False |
Returns:
Type:Subscription
Description: The topic subscription.
Summary: Delete a topic subscription
Description: The operation deletes a topic subscription.
Syntax:
ServiceBus.DeleteTopicSubscription (string topicName, string subscriptionName)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
Returns:
Summary: Get messages from a topic subscription (peek-lock)
Description: The operation receives messages from a topic subscription with peek-lock. If maximum message count is not provided, it reads 20 messages.
Syntax:
ServiceBus.GetMessagesFromTopicWithPeekLock (string topicName, string subscriptionName, [Optional]integer maxMessageCount, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
maxMessageCount |
integer(int32) (Maximum message count) |
The maximum number of messages to return in the batch |
False |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id |
False |
Returns:
Type:array of (ServiceBusMessage)
Summary: Close a session in the topic
Description: The operation closes a session in the topic.
Syntax:
ServiceBus.CloseSessionInTopic (string topicName, string subscriptionName, string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
sessionId |
string (Session id) |
Session id |
True |
Returns:
Summary: Renew lock on the session in a topic subscription
Description: The operation renews a session in a topic subscription.
Syntax:
ServiceBus.RenewLockOnSessionInTopic (string topicName, string subscriptionName, string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
sessionId |
string (Session id) |
Session id |
True |
Returns:
Summary: Get metadata of a filter
Description: Get metadata of a filter
Syntax:
ServiceBus.GetSubscriptionFilter (string subscriptionFilterType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionFilterType |
string (Subscription filter type)Values: [None, Correlation] |
Subscription filter type |
True |
Returns:
Type:SubscriptionFilter
Description: The service bus filter for a topic subscription.
Summary: Get metadata of a filter
Description: Get metadata of a filter.
Syntax:
ServiceBus.GetSubscriptionFilterV2 (string subscriptionFilterType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
subscriptionFilterType |
string (Subscription filter type)Values: [None, Correlation] |
Subscription filter type. |
True |
Returns:
Type:Object
Summary: When a message is received in a queue (auto-complete)
Description: This operation triggers a flow when a message is received in a queue and auto completes the message.
Syntax:
ServiceBus.GetMessageFromQueue (string queueName, [advanced][Optional]string queueType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
Returns:
Type:ServiceBusMessage
Description: Service Bus Message
Summary: When a message is received in a queue (peek-lock)
Description: The operation triggers a flow when a message received in a queue with peek-lock mode.
Syntax:
ServiceBus.GetNewMessageFromQueueWithPeekLock (string queueName, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id - None or Next Available or provide session id |
False |
Returns:
Type:ServiceBusMessage
Description: Service Bus Message
Summary: When one or more messages arrive in a queue (auto-complete)
Description: The operation receives one or more messages from a queue. If maximum message count is not provided, it reads 20 messages.
Syntax:
ServiceBus.GetMessagesFromQueue (string queueName, [Optional]integer maxMessageCount, [advanced][Optional]string queueType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
maxMessageCount |
integer(int32) (Maximum message count) |
The maximum number of messages to return in the batch |
False |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
Returns:
Type:array of (ServiceBusMessage)
Summary: When one or more messages arrive in a queue (peek-lock)
Description: The operation receives one or more messages from a queue with peek-lock. If maximum message count is not provided, it reads 20 messages.
Syntax:
ServiceBus.GetNewMessagesFromQueueWithPeekLock (string queueName, [Optional]integer maxMessageCount, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
queueName |
string (Queue name) |
Name of the queue |
True |
|
maxMessageCount |
integer(int32) (Maximum message count) |
The maximum number of messages to return in the batch |
False |
|
queueType |
string (Queue type)Values: [Main, DeadLetter] |
Queue type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id - None or Next Available or provide session id |
False |
Returns:
Type:array of (ServiceBusMessage)
Summary: When a message is received in a topic subscription (auto-complete)
Description: This operation triggers a flow when a message is received in a topic subscription and auto completes the message.
Syntax:
ServiceBus.GetMessageFromTopic (string topicName, string subscriptionName, [advanced][Optional]string subscriptionType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
Returns:
Type:ServiceBusMessage
Description: Service Bus Message
Summary: When a message is received in a topic subscription (peek-lock)
Description: The operation triggers a flow when a message received in a topic subscription with peek-lock mode.
Syntax:
ServiceBus.GetNewMessageFromTopicWithPeekLock (string topicName, string subscriptionName, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id - None or Next Available or provide session id |
False |
Returns:
Type:ServiceBusMessage
Description: Service Bus Message
Summary: When one or more messages arrive in a topic (auto-complete)
Description: The operation receives one or more messages from a topic. If maximum message count is not provided, it reads 20 messages.
Syntax:
ServiceBus.GetMessagesFromTopic (string topicName, string subscriptionName, [Optional]integer maxMessageCount, [advanced][Optional]string subscriptionType)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
maxMessageCount |
integer(int32) (Maximum message count) |
The maximum number of messages to return in the batch |
False |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
Returns:
Type:array of (ServiceBusMessage)
Summary: When one or more messages arrive in a topic (peek-lock)
Description: The operation receives one or more messages from a topic with peek-lock. If maximum message count is not provided, it reads 20 messages.
Syntax:
ServiceBus.GetNewMessagesFromTopicWithPeekLock (string topicName, string subscriptionName, [Optional]integer maxMessageCount, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
topicName |
string (Topic name) |
Name of the topic |
True |
|
subscriptionName |
string (Topic subscription name) |
Name of the topic subscription |
True |
|
maxMessageCount |
integer(int32) (Maximum message count) |
The maximum number of messages to return in the batch |
False |
|
subscriptionType |
string (Subscription type)Values: [Main, DeadLetter] |
Subscription type - Main or DeadLetter |
False |
|
sessionId |
string (Session id) |
Session id - None or Next Available or provide session id |
False |
Returns:
Type:array of (ServiceBusMessage)
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: Entity with name and display name.
Properties:
Name |
Type |
Summary |
Name |
string
|
The entity name |
DisplayName |
string
|
The display name for the entity |
Summary:
Description: Service Bus Message
Properties:
Name |
Type |
Summary |
ContentData |
string(byte) Content |
Content of the message |
ContentType |
string Content Type |
Content type of the message content |
Properties |
Properties |
Key-value pairs for each brokered property |
MessageId |
string Message Id |
This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled. |
To |
string To |
Send to address |
ReplyTo |
string Reply To |
Address of the queue to reply to |
ReplyToSessionId |
string Reply To Session Id |
Identifier of the session to reply to |
Label |
string Label |
Application specific label |
ScheduledEnqueueTimeUtc |
string(date-time) ScheduledEnqueueTimeUtc |
Date and time, in UTC, when the message will be added to the queue |
SessionId |
string Session Id |
Identifier of the session |
CorrelationId |
string Correlation Id |
Identifier of the correlation |
SequenceNumber |
integer(int64) Sequence Number |
Identifier of the sequence number |
LockToken |
string Lock Token |
The lock token of the message as a string. |
TimeToLive |
string(int64) Time To Live |
This is the duration, in ticks, that a message is valid. The duration starts from when the message is sent to the Service Bus. |
Summary: Properties
Description: Key-value pairs for each brokered property
Properties:
Name |
Type |
Summary |
Summary:
Description: The topic subscription.
Properties:
Name |
Type |
Summary |
SubscriptionName |
string Subscription name |
Subscription name. |
Summary:
Description: This object has the basic properties of a message for the correlation filter.
Properties:
Name |
Type |
Summary |
CorrelationId |
string
|
Identifier of the correlation |
Label |
string
|
Application specific label |
MessageId |
string
|
This is a user-defined value that Service Bus can use to identify duplicate messages, if enabled. |
Properties |
|
Key-value pairs for each brokered property |
ReplyTo |
string
|
Address of the queue to reply to |
ReplyToSessionId |
string
|
Identifier of the session to reply to |
SessionId |
string
|
Identifier of the session |
To |
string
|
Send to address |
ContentType |
string
|
Content type of the message content |
Summary:
Description: Key-value pairs for each brokered property
Properties:
Name |
Type |
Summary |
Summary:
Description: The service bus filter for a topic subscription.
Properties:
Name |
Type |
Summary |
CorrelationFilter |
|
This object has the basic properties of a message for the correlation filter. |