Azure Service Bus Component

Interact with message queues and publish-subscribe topics (in a namespace)

Component key: azureServiceBus

Description

Azure Service Bus is a fully managed enterprise message broker with message queues and publish-subscribe topics (in a namespace).

Connections

Connection String

The Connection String authentication method is required for any integrations using the following actions:

Send Messages from Queue
Receive Messages from Queue

Additionally, in an integration, ensure when using these actions, the connection is configured to the Connection String authentication type.

Creating a new namespace automatically generates an initial Shared Access Signature (SAS) policy with primary and secondary keys, and primary and secondary connection strings that each grant full control over all aspects of the namespace. See Service Bus authentication and authorization for information about how to create rules with more constrained rights for regular senders and receivers.

A client can use the connection string to connect to the Service Bus namespace. To copy the primary connection string for your namespace, follow these steps:

On the Service Bus Namespace page, select Shared access policies on the left menu.
On the Shared access policies page, select RootManageSharedAccessKey.

In the Policy: RootManageSharedAccessKey window, select the copy button next to Primary Connection String, to copy the connection string to your clipboard for later use. Paste this value into the connection configuration of your Prismatic integration.

Input	Notes
Connection String password / Required connectionString	The connection string for your Azure Service Bus namespace. You can find this in the Azure Portal under the 'Shared access policies' tab.

OAuth 2.0

Azure Service Bus uses OAuth 2.0 Authentication to authenticate the security principal (a user, a group, or service principal) running the application. Create and Register your Microsoft application with an Azure AD tenant. For more information refer to https://learn.microsoft.com/en-us/azure/service-bus-messaging/authenticate-application

The first step in using Azure AD to authorize Service Bus entities is registering your client application with an Azure AD tenant from the Azure portal

Menu > All Services > Azure Active Directory

Select Add > App registration
Name the App and set the Supported Account types to 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)'.
In Redirect URI set the first field to “Web”. In the second field enter https://oauth2.prismatic.io/callback and select Register.

Create a client Secret

Navigate to your app registration in the Azure portal if you aren't already on the page.
Select Certificates & secrets on the left menu.
Under Client secrets, select New client secret to create a new secret.

Set the Permissions to the Service Bus API

If your application is a console application, you must register a native application and add API permissions for Microsoft.ServiceBus to the required permissions set. Native applications also need a redirect-uri in Azure AD, which serves as an identifier; the URI doesn't need to be a network destination. Use https://servicebus.microsoft.com for this example, because the sample code already uses that URI.

Assign Azure roles using the Azure portal

Assign one of the Service Bus roles to the application's service principal at the desired scope (Service
Bus namespace, resource group, subscription). For detailed steps, see Assign Azure roles using the Azure portal.

Now, configure the OAuth 2.0 connection in Prismatic. Add an Azure Service Bus OAuth 2.0 Connection config variable:

Use the Application (client) ID value for the Client ID field.
Use the Client Secret for the same named field.
If you didn't select Multitenant when creating the Azure application, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.

Save your integration and you should be able to authenticate a user through Azure Service Bus with OAuth 2.0.

Input	Default	Notes
Authorize URL string / Required authorizeUrl	https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize	The OAuth 2.0 Authorization URL for Azure Service Bus
Client ID string / Required clientId		Generate this value when you create your Active Directory App
Client Secret password / Required clientSecret		Generate this value when you create your Active Directory App
Scopes string / Required scopes	https://management.azure.com/.default
Tenant ID string / Required tenantId		Generate this value when you create your Active Directory App
Token URL string / Required tokenUrl	https://login.microsoftonline.com/organizations/oauth2/v2.0/token	The OAuth 2.0 Token URL for Azure Service Bus

Triggers

Webhook

Receive and validate webhook requests from Azure Service Bus for webhooks you configure. | key: subscriptionMessageWebhook

To trigger webhook calls within Service Bus, you need to make use of Azure Event Grid and Logic Apps. Follow these steps to build the webhook integration:

Register Microsoft.EventGrid resource provider to the subscription:
- Navigate to Azure account subscriptions.
- Open the subscription settings.
- Go to Resource Providers.
- Register Microsoft.EventGrid resource.
Create a Service Bus namespace: Create a Service Bus Namespace
Receive messages by using Logic Apps: Receive Messages by Using Logic Apps
Add a step to receive messages from Service Bus via Event Grid: Add a Step to Receive Messages from Service Bus via Event Grid
Add a foreach loop: Add a Foreach Loop
Add an HTTP action to post to Prismatic integration trigger:

Within the For Each loop, select "Add an action."
In the "Search connectors and actions" text box, enter "HTTP."
Select the HTTP action.
Select POST for Method.
Add the Prismatic Integration flow URL to the URI Input.
For the Body, add this expression: base64ToString(items('For_each')?['ContentData']).

Add another action in the foreach loop to complete the message: Add Another Action in the Foreach Loop to Complete the Message

To test the webhook, send a message to the Topic Subscription using Service Bus Explorer. This should trigger the integration with Prismatic.

Example Payload for Webhook

{
  "payload": {
    "headers": {
      "Accept-Encoding": "gzip, deflate",
      "Accept-Language": "en-US",
      "Content-Type": "text/plain; charset=utf-8",
      "Host": "hooks.prismatic.io",
      "User-Agent": "azure-logic-apps/1.0 (workflow 58fce0896a114cceb9c92a4d07611234; version 08585128901970019172)",
      "X-Amz-Cf-Id": "iOiPjKC55qKUNE5Jid-emKKQRPH3TFz7d3O50UcFk-IkV7RuJk1234==",
      "X-Amzn-Trace-Id": "Root=1-64a7c5c8-7af54c4a6b77f32e14401234",
      "x-ms-action-tracking-id": "ecbd964b-ca88-40dd-977c-5db5129951234",
      "x-ms-activity-vector": "IN.0J",
      "x-ms-client-request-id": "97110424-b3ec-453a-9e5c-81807df91234",
      "x-ms-client-tracking-id": "085851289014160877189743753061234",
      "x-ms-correlation-id": "97110424-b3ec-453a-9e5c-81807df91234",
      "x-ms-execution-location": "eastus",
      "x-ms-tracking-id": "97110424-b3ec-453a-9e5c-81807df91234",
      "x-ms-workflow-id": "58fce0896a114cceb9c92a4d07611234",
      "x-ms-workflow-name": "subscriptionLogicApp",
      "x-ms-workflow-operation-name": "HTTP",
      "x-ms-workflow-repeatitem-batch-index": "0",
      "x-ms-workflow-repeatitem-index": "0",
      "x-ms-workflow-repeatitem-scope-name": "For_each",
      "x-ms-workflow-resourcegroup-name": "Prismatic",
      "x-ms-workflow-run-id": "085851289014160877179743753061234",
      "x-ms-workflow-run-tracking-id": "878c50fd-9ec7-417e-bb06-0eb3e5d21234",
      "x-ms-workflow-subscription-id": "782a9e34-9e60-4037-b32e-40b85e601234",
      "x-ms-workflow-system-id": "/locations/eastus/scaleunits/prod-55/workflows/58fce0896a114cceb9c92a4d07611234",
      "x-ms-workflow-version": "08585128901970011234"
    },
    "queryParameters": null,
    "rawBody": "<data (4 bytes)>",
    "body": {
      "data": "test",
      "contentType": "text/plain; charset=utf-8"
    },
    "pathFragment": "",
    "webhookUrls": {
      "Flow 1": "https://hooks.prismatic.io/trigger/WEBHOOK_ID"
    },
    "webhookApiKeys": {
      "Flow 1": [
        "sample-api-key"
      ]
    },
    "invokeUrl": "https://hooks.prismatic.io/trigger/WEBHOOK_ID",
    "executionId": "SW5zdGFuY2VFeGVjdXRpb25SZXN1bHQ6ZGNhYTAxOTUtOTcwMi00NzAzLWJkZTctMmEwMDIwMWIz1234",
    "customer": {
      "id": "testCustomerId",
      "name": "Test Customer",
      "externalId": "testCustomerExternalId"
    },
    "instance": {
      "id": "testInstanceId",
      "name": "Test Instance"
    },
    "user": {
      "id": "testUserId",
      "email": "testUserEmail@example.com",
      "name": "Test User",
      "externalId": "testUserExternalId"
    }
  }
}

Actions

Create or Update Namespaces

Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent. | key: createOrUpdateNamespaces

Input	Notes	Example
Alternate Name string alternateName	Alternate name for the namespace.
Connection connection / Required connection
Disable Local Auth boolean disableLocalAuth	This property disables SAS authentication for the Service Bus namespace.
Identity Type string / Required identityType	Type of managed service identity.
Key Source string keySource	Enumerates the possible value of keySource for Encryption	Microsoft.KeyVault
Key Vault Properties code keyVaultProperties	Properties of the Key Vault
Location string / Required location	The geo-location where the resource lives
Namespace Name string / Required namespaceName	The namespace name
Private Endpoint Connections code privateEndpointConnections	List of private endpoint connections.
Require Infrastructure Encryption boolean requireInfrastructureEncryption	Enable Infrastructure Encryption (Double Encryption)
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
SKU code sku	SKU of the namespace.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Tags code tags	Resource tags.
Identity User Assigned Identities code userAssignedIdentities	Properties for User Assigned Identities
Zone Redundant boolean zoneRedundant	Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.

Create or Update Queue

Creates or updates a Service Bus queue. This operation is idempotent. | key: createOrUpdateQueue

Input	Notes	Example
Auto Delete On Idle string autoDeleteOnIdle	ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
Connection connection / Required connection
Dead Lettering On Message Expiration boolean deadLetteringOnMessageExpiration	Value that indicates whether a subscription has dead letter support when a message expires.
Default Message Time To Live string defaultMessageTimeToLive	ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
Duplicate Detection History Time Window string duplicateDetectionHistoryTimeWindow	ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
Enable Batched Operations boolean enableBatchedOperations	Value that indicates whether server-side batched operations are enabled.
Enable Express boolean enableExpress	Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
Enable Partitioning boolean enablePartitioning	Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
Forward Dead Lettered Messages To string forwardDeadLetteredMessagesTo	Queue/Topic name to forward the Dead Letter message.
Forward To string forwardTo	Queue/Topic name to forward the messages.
Lock Duration string lockDuration	ISO 8601 lock duration timespan for the subscription. The default value is 1 minute.
Max Delivery Count string maxDeliveryCount	Number of maximum deliveries.
Max Message Size in Kilobytes string maxMessageSizeInKilobytes	Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today, and the default is 1024.
Max Size in Megabytes string maxSizeInMegabytes	Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
Namespace Name string / Required namespaceName	The namespace name
Queue Name string / Required queueName	The queue name.
Requires Duplicate Detection boolean requiresDuplicateDetection	Value indicating if this topic requires duplicate detection.
Requires Session boolean requiresSession	Value indicating if a subscription supports the concept of sessions.
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Status string status	Status of the messaging entity.	Use one: Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming ,Unknown
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Create or Update Rules

Creates a new rule and updates an existing rule | key: createOrUpdateRules

Input	Notes	Example
Action code actionInput	Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression.
Connection connection / Required connection
Correlation Filter code correlationFilter	Represents the correlation filter expression.
Filter Type string filterType	Filter type that is evaluated against a BrokeredMessage.	SqlFilter, CorrelationFilter
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Rule Name string / Required ruleName	The rule name.
SQL Filter code sqlFilter	Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Subscription Name string / Required subscriptionName	The subscription name.
Topic Name string / Required topicName	The topic name.

Create or Update Subscription

Creates a topic subscription. | key: createOrUpdateSubscription

Input	Notes	Example
Auto Delete On Idle string autoDeleteOnIdle	ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
Client ID string clientId	Indicates the Client ID of the application that created the client-affine subscription.
Connection connection / Required connection
Dead Lettering On Filter Evaluation Exceptions boolean deadLetteringOnFilterEvaluationExceptions	Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
Dead Lettering On Message Expiration boolean deadLetteringOnMessageExpiration	Value that indicates whether a subscription has dead letter support when a message expires.
Default Message Time To Live string defaultMessageTimeToLive	ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
Duplicate Detection History Time Window string duplicateDetectionHistoryTimeWindow	ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
Enable Batched Operations boolean enableBatchedOperations	Value that indicates whether server-side batched operations are enabled.
Forward Dead Lettered Messages To string forwardDeadLetteredMessagesTo	Queue/Topic name to forward the Dead Letter message.
Forward To string forwardTo	Queue/Topic name to forward the messages.
Is Client Affine boolean isClientAffine	Value that indicates whether the subscription has an affinity to the client id.
Is Durable boolean isDurable	For client-affine subscriptions, this value indicates whether the subscription is durable or not.
Is Shared boolean isShared	For client-affine subscriptions, this value indicates whether the subscription is shared or not.
Lock Duration string lockDuration	ISO 8601 lock duration timespan for the subscription. The default value is 1 minute.
Max Delivery Count string maxDeliveryCount	Number of maximum deliveries.
Namespace Name string / Required namespaceName	The namespace name
Requires Session boolean requiresSession	Value indicating if a subscription supports the concept of sessions.
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Status string status	Status of the messaging entity.	Use one: Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming ,Unknown
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Subscription Name string / Required subscriptionName	The subscription name.
Topic Name string / Required topicName	The topic name.

Create or Update Topic

Creates or updates a topic in the specified namespace. | key: createOrUpdateTopic

Input	Notes	Example
Auto Delete On Idle string autoDeleteOnIdle	ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
Connection connection / Required connection
Default Message Time To Live string defaultMessageTimeToLive	ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
Duplicate Detection History Time Window string duplicateDetectionHistoryTimeWindow	ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
Enable Batched Operations boolean enableBatchedOperations	Value that indicates whether server-side batched operations are enabled.
Enable Express boolean enableExpress	Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
Enable Partitioning boolean enablePartitioning	Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
Max Message Size in Kilobytes string maxMessageSizeInKilobytes	Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today, and the default is 1024.
Max Size in Megabytes string maxSizeInMegabytes	Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
Namespace Name string / Required namespaceName	The namespace name
Requires Duplicate Detection boolean requiresDuplicateDetection	Value indicating if this topic requires duplicate detection.
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Status string status	Status of the messaging entity.	Use one: Active, Disabled, Restoring, SendDisabled, ReceiveDisabled, Creating, Deleting, Renaming ,Unknown
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Support Ordering boolean supportOrdering	Value that indicates whether the topic supports ordering.
Topic Name string / Required topicName	The topic name.

Delete Namespace

Deletes an existing namespace. This operation also removes all associated resources under the namespace. | key: deleteNamespace

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Delete Queue

Deletes a queue from the specified namespace in a resource group. | key: deleteQueue

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Queue Name string / Required queueName	The queue name.
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Delete Rule

Deletes an existing rule. | key: deleteRule

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Rule Name string / Required ruleName	The rule name.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Subscription Name string / Required subscriptionName	The subscription name.
Topic Name string / Required topicName	The topic name.

Delete Subscriptions

Deletes a subscription from the specified topic. | key: deleteSubscriptions

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Subscription Name string / Required subscriptionName	The subscription name.
Topic Name string / Required topicName	The topic name.

Delete Topic

Deletes a topic from the specified namespace and resource group. | key: deleteTopic

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Topic Name string / Required topicName	The topic name.

Get Namespaces

Gets a description for the specified namespace. | key: getNamespaces

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Get Queue

Returns a description for the specified queue. | key: getQueue

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Queue Name string / Required queueName	The queue name.
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Get Rule

Retrieves the description for the specified rule. | key: getRule

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Rule Name string / Required ruleName	The rule name.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Subscription Name string / Required subscriptionName	The subscription name.
Topic Name string / Required topicName	The topic name.

Get Subscriptions

Returns a subscription description for the specified topic. | key: getSubscriptions

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Subscription Name string / Required subscriptionName	The subscription name.
Topic Name string / Required topicName	The topic name.

Get Topic

Gets all the topics in a namespace | key: getTopic

Input	Notes
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Topic Name string / Required topicName	The topic name.

List Namespaces

Gets all the available namespaces within the subscription, irrespective of the resource groups. | key: listNamespaces

Input	Notes
Connection connection / Required connection
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

List Namespaces By Resource Group

Gets the available namespaces within a resource group. | key: listNamespacesByResourceGroup

Input	Notes
Connection connection / Required connection
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

List Queues

Gets the queues within a namespace. | key: listQueues

Input	Notes
Skip string $skip	Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
Top string $top	May be used to limit the number of results to the most recent N usageDetails.
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

List Rules

List all the rules within given topic-subscription | key: listRules

Input	Notes
Skip string $skip	Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
Top string $top	May be used to limit the number of results to the most recent N usageDetails.
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Subscription Name string / Required subscriptionName	The subscription name.
Topic Name string / Required topicName	The topic name.

List Subscriptions

List all the subscriptions | key: listSubscriptions

Input	Default	Notes	Example
Connection connection / Required connection
Version string version	2016-06-01	Version of the API.	2016-06-01

List Subscriptions By Topic

List all the subscriptions under a specified topic. | key: listSubscriptionsByTopic

Input	Notes
Skip string $skip	Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
Top string $top	May be used to limit the number of results to the most recent N usageDetails.
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Queue Name string / Required queueName	The queue name.
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Topic Name string / Required topicName	The topic name.

List Topics By Namespace

Gets all the topics in a namespace | key: listTopicsByNamespace

Input	Notes
Skip string $skip	Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.
Top string $top	May be used to limit the number of results to the most recent N usageDetails.
Connection connection / Required connection
Namespace Name string / Required namespaceName	The namespace name
Queue Name string / Required queueName	The queue name.
Resource Group Name string / Required resourceGroupName	Name of the Resource group within the Azure subscription.
Subscription ID string / Required subscriptionId	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Raw Request

Send raw HTTP request to Azure Service Bus | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		Input the path only (/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces?api-version=2021-11-01), The base URL is already included (https://management.azure.com/subscriptions). For example, to connect to https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces?api-version=2021-11-01, only /{subscriptionId}/providers/Microsoft.ServiceBus/namespaces?api-version=2021-11-01 is entered in this field.	/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces?api-version=2021-11-01
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Receive Messages from Queue

Receive messages from a queue. Receive messages from a queue will remove the message from the queue. | key: receiveMessagesFromQueue

Input	Default	Notes
Amount of Messages string / Required amountOfMessages		Amount of messages to receive from the queue.
Connection connection / Required connection
Max Time To Wait string / Required maxTimeToWait	60	Max time to wait (in seconds) for messages to receive from the queue. Default is 60 seconds.
Namespace Name string / Required namespaceName		The namespace name
Peek boolean peek	false	If true, the messages will be peeked from the queue, which doesn't alter the visibility of the message. If false, the messages will be received from the queue. https://learn.microsoft.com/en-us/rest/api/storageservices/peek-messages
Queue Name string / Required queueName		The queue name.
Return Full Messages boolean returnFullMessages	false	If true, the full message objects will be returned including message ID, sequence number, delivery metadata, etc. If false, only the messages bodies will be returned.

Send Message to Queue

Send a single message to a queue. | key: sendMessageToQueue

Input	Notes	Example
Body string / Required body	The body of the message.
Connection connection / Required connection
Content Type string contentType	The content type of the message.	application/json
Message ID string messageId	An optional unique ID of the message to be used for deduplication. If omitted, a unique ID will be generated by Microsoft.
Namespace Name string / Required namespaceName	The namespace name
Partition Key string partitionKey	An optional partition key https://learn.microsoft.com/en-us/dotnet/api/azure.messaging.servicebus.servicebusmessage.partitionkey
Queue Name string / Required queueName	The queue name.
Reply To string replyTo	An optional address that the receiver can use to reply to the message. https://learn.microsoft.com/en-us/dotnet/api/azure.messaging.servicebus.servicebusmessage.replyto
Scheduled Enqueue Time UTC string scheduledEnqueueTimeUtc	An optional time at which the message should be enqueued. If omitted, the message will be enqueued immediately.
Subject string subject	An optional subject for the message.
To string to	An optional address that specifies the intended recipient of the message. https://learn.microsoft.com/en-us/dotnet/api/azure.messaging.servicebus.servicebusmessage.to

Send Multiple Messages to Queue

Send multiple plain text messages to a queue. | key: sendMessagesToQueue

Input	Notes
Connection connection / Required connection
Messages string / Required Value List messages	List of messages to send to the queue.
Namespace Name string / Required namespaceName	The namespace name
Queue Name string / Required queueName	The queue name.

Interact with message queues and publish-subscribe topics (in a namespace)

Description​

Connections​

Connection String​

OAuth 2.0​

Triggers​

Webhook​

Actions​

Create or Update Namespaces​

Create or Update Queue​

Create or Update Rules​

Create or Update Subscription​

Create or Update Topic​

Delete Namespace​

Delete Queue​

Delete Rule​

Delete Subscriptions​

Delete Topic​

Get Namespaces​

Get Queue​

Get Rule​

Get Subscriptions​

Get Topic​

List Namespaces​

List Namespaces By Resource Group​

List Queues​

List Rules​

List Subscriptions​

List Subscriptions By Topic​

List Topics By Namespace​

Raw Request​

Receive Messages from Queue​

Send Message to Queue​

Send Multiple Messages to Queue​