Connectors Reference

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.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

GetQueues ()

Get all queues

GetTopics ()

Get all topics

GetSubscriptions (string topicName)

Get the subscriptions for a topic

GetEntities ()

Get all entities

GetSystemProperties ()

Get the list of system properties

GetSessionOptions ()

Get session options

SendMessage (string entityName, ServiceBusMessage message, [advanced][Optional]string systemProperties)

Send message

SendMessages (string entityName, array messages, [advanced][Optional]string systemProperties)

Send one or more messages

CompleteMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)

Complete the message in a queue

AbandonMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)

Abandon the message in a queue

GetDeferredMessageFromQueue (string queueName, integer sequenceNumber, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)

Get deferred message from a queue

DeferMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)

Defer the message in a queue

DeadLetterMessageInQueue (string queueName, string lockToken, [advanced][Optional]string sessionId)

Dead-letter the message in a queue

RenewLockOnMessageInQueue (string queueName, string lockToken, [advanced][Optional]string queueType)

Renew lock on the message in a queue

GetMessagesFromQueueWithPeekLock (string queueName, [Optional]integer maxMessageCount, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)

Get messages from a queue (peek-lock)

CloseSessionInQueue (string queueName, string sessionId)

Close a session in a queue

RenewLockOnSessionInQueue (string queueName, string sessionId)

Renew lock on the session in a queue

CompleteMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)

Complete the message in a topic subscription

AbandonMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)

Abandon the message in a topic subscription

GetDeferredMessageFromTopic (string topicName, string subscriptionName, integer sequenceNumber, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)

Get deferred message from a topic subscription

DeferMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)

Defer the message in a topic subscription

DeadLetterMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string sessionId)

Dead-letter the message in a topic subscription

RenewLockOnMessageInTopic (string topicName, string subscriptionName, string lockToken, [advanced][Optional]string subscriptionType)

Renew lock on the message in a topic subscription

CreateTopicSubscription (string topicName, string subscriptionName, CreateTopicSubscriptionParameterSubscriptionFilter subscriptionFilter, [advanced][Optional]string subscriptionFilterType)

Create a topic subscription

DeleteTopicSubscription (string topicName, string subscriptionName)

Delete a topic subscription

GetMessagesFromTopicWithPeekLock (string topicName, string subscriptionName, [Optional]integer maxMessageCount, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)

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

GetSubscriptionFilter (string subscriptionFilterType)

Get metadata of a filter

 

Triggers:

Name

Summary

GetMessageFromQueue (string queueName, [advanced][Optional]string queueType)

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

GetNewMessageFromQueueWithPeekLock (string queueName, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)

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

GetMessagesFromQueue (string queueName, [Optional]integer maxMessageCount, [advanced][Optional]string queueType)

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

GetNewMessagesFromQueueWithPeekLock (string queueName, [Optional]integer maxMessageCount, [advanced][Optional]string queueType, [advanced][Optional]string sessionId)

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

GetMessageFromTopic (string topicName, string subscriptionName, [advanced][Optional]string subscriptionType)

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

GetNewMessageFromTopicWithPeekLock (string topicName, string subscriptionName, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)

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

GetMessagesFromTopic (string topicName, string subscriptionName, [Optional]integer maxMessageCount, [advanced][Optional]string subscriptionType)

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

GetNewMessagesFromTopicWithPeekLock (string topicName, string subscriptionName, [Optional]integer maxMessageCount, [advanced][Optional]string subscriptionType, [advanced][Optional]string sessionId)

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

 

Objects:

Name

Summary

CreateTopicSubscriptionParameterSubscriptionFilter

 

ServiceBusEntity

 

ServiceBusMessage

 

Subscription

 

SubscriptionCorrelationFilter

 

SubscriptionFilter

 

 

Actions:

GetQueues

Summary: Get all queues

Description: This operation gets all queues in the Service Bus namespace.

 

Syntax:

ServiceBus.GetQueues ()

 

Returns:

          Type:array of (string)

 

GetTopics

Summary: Get all topics

Description: This operation gets all topics in the Service Bus namespace.

 

Syntax:

ServiceBus.GetTopics ()

 

Returns:

          Type:array of (string)

 

GetSubscriptions

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)

 

GetEntities

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)

 

GetSystemProperties

Summary: Get the list of system properties

Description: This operation gets list of properties.

 

Syntax:

ServiceBus.GetSystemProperties ()

 

Returns:

          Type:array of (string)

 

GetSessionOptions

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)

 

SendMessage

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

GetEntities

message

ServiceBusMessage

 

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

GetSystemProperties

 

Returns:

 

SendMessages

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

GetEntities

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

GetSystemProperties

 

Returns:

 

CompleteMessageInQueue

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

GetQueues

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:

 

AbandonMessageInQueue

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

GetQueues

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:

 

GetDeferredMessageFromQueue

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

GetQueues

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

 

DeferMessageInQueue

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

GetQueues

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:

 

DeadLetterMessageInQueue

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)

 

Parameters:

Name

Type

Summary

Required

Related Action

queueName

string

(Queue name)

Name of the queue

True

GetQueues

lockToken

string

(Lock token of the message)

Lock token of the message to dead-letter

True

sessionId

string

(Session id)

Session id

False

 

Returns:

 

RenewLockOnMessageInQueue

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

GetQueues

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:

 

GetMessagesFromQueueWithPeekLock

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

GetQueues

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)

 

CloseSessionInQueue

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

GetQueues

sessionId

string

(Session id)

Session id

True

 

Returns:

 

RenewLockOnSessionInQueue

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

GetQueues

sessionId

string

(Session id)

Session id

True

 

Returns:

 

CompleteMessageInTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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:

 

AbandonMessageInTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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:

 

GetDeferredMessageFromTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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

 

DeferMessageInTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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:

 

DeadLetterMessageInTopic

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)

 

Parameters:

Name

Type

Summary

Required

Related Action

topicName

string

(Topic name)

Name of the topic

True

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

lockToken

string

(Lock token of the message)

Lock token of the message to dead-letter

True

sessionId

string

(Session id)

Session id

False

 

Returns:

 

RenewLockOnMessageInTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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:

 

CreateTopicSubscription

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

GetTopics

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.

 

DeleteTopicSubscription

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

 

Returns:

 

GetMessagesFromTopicWithPeekLock

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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)

 

CloseSessionInTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

sessionId

string

(Session id)

Session id

True

 

Returns:

 

RenewLockOnSessionInTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

sessionId

string

(Session id)

Session id

True

 

Returns:

 

GetSubscriptionFilter

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.

 

Triggers:

Trigger GetMessageFromQueue

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

GetQueues

queueType

string

(Queue type)Values: [Main, DeadLetter]

Queue type - Main or DeadLetter

False

 

Returns:

          Type:ServiceBusMessage

          Description: Service Bus Message

 

Trigger GetNewMessageFromQueueWithPeekLock

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

GetQueues

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

GetSessionOptions

 

Returns:

          Type:ServiceBusMessage

          Description: Service Bus Message

 

Trigger GetMessagesFromQueue

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

GetQueues

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)

 

Trigger GetNewMessagesFromQueueWithPeekLock

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

GetQueues

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

GetSessionOptions

 

Returns:

          Type:array of (ServiceBusMessage)

 

Trigger GetMessageFromTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

subscriptionType

string

(Subscription type)Values: [Main, DeadLetter]

Subscription type - Main or DeadLetter

False

 

Returns:

          Type:ServiceBusMessage

          Description: Service Bus Message

 

Trigger GetNewMessageFromTopicWithPeekLock

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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

GetSessionOptions

 

Returns:

          Type:ServiceBusMessage

          Description: Service Bus Message

 

Trigger GetMessagesFromTopic

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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)

 

Trigger GetNewMessagesFromTopicWithPeekLock

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

GetTopics

subscriptionName

string

(Topic subscription name)

Name of the topic subscription

True

GetSubscriptions

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

GetSessionOptions

 

Returns:

          Type:array of (ServiceBusMessage)

 


 

CreateTopicSubscriptionParameterSubscriptionFilter

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ServiceBusEntity

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


 

ServiceBusMessage

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

ContentTransferEncoding

string

Content Transfer Encoding

Content transfer encoding of the message content ("none"|"base64")  Values: [None, Base64]

Properties

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.

 

Properties

Summary: Properties

Description: Key-value pairs for each brokered property

 

          Properties:

Name

Type

Summary

 


 

Subscription

Summary:

Description: The topic subscription.

 

          Properties:

Name

Type

Summary

SubscriptionName

string

Subscription name

Subscription name.


 

SubscriptionCorrelationFilter

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

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

 

Properties

Summary:

Description: Key-value pairs for each brokered property

 

          Properties:

Name

Type

Summary

 


 

SubscriptionFilter

Summary:

Description: The service bus filter for a topic subscription.

 

          Properties:

Name

Type

Summary

CorrelationFilter

SubscriptionCorrelationFilter

 

This object has the basic properties of a message for the correlation filter.