# mulesoft Azure Service Bus Management Connector - Full Documentation --- product: Azure Service Bus Management Connector version: 1.0 is-latest-version: true --- # Azure Service Bus Management 1.0 Additional Configuration Information > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Azure Service Bus Management (Azure Service Bus Management Connector) cannot perform a connectivity test at startup using the **Test Connection** button in the global element of the connector configuration when you restrict access to your resources and you have a security policy with permissions at the resource level only. This scenario occurs because the security policy targets the root level of the namespace, which might be forbidden due to the customized policy applied to the shared access key. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Azure Service Bus Management Connector version: 1.0 is-latest-version: true --- # Azure Service Bus Management 1.0 Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The examples in this section show how to get information about Azure Service Bus queues and how to create an Azure Service Bus topic. These examples use variables for some field values. You can either: - Replace the variables with their values in the code - Provide the values for each variable in a properties file and then refer to that file from the connector configuration If you don’t know how to use a properties file, see [Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure) ## Get Queue Information Example This example shows how to get information about a particular queue in the Azure service bus instance. The following screenshot shows the Anypoint Studio app flow for this example: ![App flow that shows the components used in the get Get Queue Information example](/mulesoft/current/en-us/azure-service-bus-management-connector/latest/_images/azure-sb-mgmt-flow-get-queue.png) Figure 1. App flow for the Get Queue Information example 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation: 3. Drag the **Listener** operation onto the Studio canvas. 4. In the **Listener** configuration, click **+** next to the **Connector configuration** field to add a global element. 5. Accept the defaults. 6. Set the **Path** field to `/queue`. ### Add and Configure the Get Entity Operation Example Add the **Get Entity** operation to see information about the specified queue, including configuration information and information about the metadata: 1. In the **Mule Palette** view, search for `azure` and select the Azure Service Bus Management Connector **Get Entity** operation. 2. Drag the **Get Entity** operation onto the Studio canvas, to the right of **Listener**. 3. In the **Get Entity** configuration, click **+** next to the **Connector configuration** field to add a global element. 4. Enter values for the **SMS Namespace**, **Shared Access Key Name**, and **Shared Access Key** fields. 5. Click **Test Connection** to confirm that Mule can connect with the Azure Service Bus instance: - If the connection is successful, click **OK** to save the configuration. - Otherwise, review to correct any incorrect parameters, and test again. 6. In the **Entity(Queue or Topic)** field, enter the name of the queue for which you want information. ### Add a Transform Message Component Add a **Transform Message** component to format the data and show how the metadata is rendered for the output of the **Get Entity** operation: 1. In the **Mule Palette** view, search for `transform`: 2. Drag the **Transform Message** component onto the canvas, to the right of the **Get Entity** component. 3. In the **Transform Message** configuration, change the display name to `Getting Data`. 4. Overlay the brackets in the **Output** section with this XML: ```xml %dw 2.0 output application/json ns ns0 http://www.w3.org/2005/Atom ns ns01 http://schemas.microsoft.com/netservices/2010/10/servicebus/connect --- { "title": payload.ns0#entry.ns0#title, "publishedAt": payload.ns0#entry.ns0#published, "lockDuration": payload.ns0#entry.ns0#content.ns01#QueueDescription.ns01#LockDuration, "maxSize": payload.ns0#entry.ns0#content.ns01#QueueDescription.ns01#MaxSizeInMegabytes, "requiresDuplicate": payload.ns0#entry.ns0#content.ns01#QueueDescription.ns01#RequiresDuplicateDetection, "requiresSession": payload.ns0#entry.ns0#content.ns01#QueueDescription.ns01#RequiresSession, "deadLettering": payload.ns0#entry.ns0#content.ns01#QueueDescription.ns01#DeadLetteringOnMessageExpiration, "enabledBatched": payload.ns0#entry.ns0#content.ns01#QueueDescription.ns01#EnableBatchedOperations, "defaultMTTL": payload.ns0#entry.ns0#content.ns01#QueueDescription.ns01#DefaultMessageTimeToLive, "duplicateDetection": payload.ns0#entry.ns0#content.ns01#QueueDescription.ns01#DuplicateDetectionHistoryTimeWindow, } ``` ### Add a Logger Component Add a Logger component to show the response in the **Mule Console**: 1. In the **Mule Palette** view, search for `logger` and select the **Logger (Core)** component. 2. Drag the **Logger (Core)** component onto the Studio canvas, to the right of the **Transform Message** component. 3. In the **Message** field of the Logger configuration, enter `#[payload]`. 4. Save the project. 5. Test the app by sending a GET request to `http://127.0.0.1:8081/queue`. ### XML Code for the Get Queue Example ```xml ``` ## Create Topic Example This example shows how to create a new topic for the Azure Service Bus instance. The following screenshot shows the Anypoint Studio flow for this example: ![App flow that shows the components used in the Create Topic example](/mulesoft/current/en-us/azure-service-bus-management-connector/latest/_images/azure-sb-mgmt-flow-create-topic.png) Figure 2. App flow for the Create Topic example 1. Create a new Mule project in Studio. 2. In the **Mule Palette** view, search for `http` and select the **Listener** operation: 3. Drag the **Listener** operation onto the canvas. 4. In the **Listener** configuration, click **+** next to the **Connector configuration** field to add a global element. 5. Set the **Host** field to 0.0.0.0, the **Port** field to `808`, and click **Save**. 6. Set the **Path** field to `/topic`. ### Add and Configure the Create or Update Entity Operation The **Create or Update Entity** operation enables you to create the topic: 1. In the **Mule Palette** view, search for `azure service bus management` and select the **Create or Update Entity** operation. 2. Drag the **Create or Update Entity** operation onto the canvas, to the right of **Listener**. 3. In the **Create or Update Entity** configuration, click **+** next to the **Connector configuration** field to add a global element. 4. Enter values for the **SMS Namespace**, **Shared Access Key Name**, and **Shared Access Key** fields. 5. Click **Test Connection** to confirm that Mule can connect with the Azure Service Bus instance: - If the connection is successful, click **OK** to save the configuration. - Otherwise, review or correct any incorrect parameters, and test again. 6. In the **Entity(Queue or Topic)** field, enter the name of the queue for which you want information. ### Add a Transform Message Component Add a **Transform Message** component to format the data and show how the metadata is rendered for the output of the **Create or Update Entity** operation: 1. In the **Mule Palette** view, search for `transform`: 2. Drag the **Transform Message** component onto the canvas, to the right of the **Create or Update Entity** component. 3. In the **Transform Message** configuration, change the display name to `Getting Data`. 4. Overlay the brackets in the **Output** section with this XML: ```xml %dw 2.0 output application/json ns ns0 http://www.w3.org/2005/Atom ns ns01 http://schemas.microsoft.com/netservices/2010/10/servicebus/connect --- { title: payload.ns0#entry.ns0#title, publishedAt: payload.ns0#entry.ns0#published, maxSize: payload.ns0#entry.ns0#content.ns01#TopicDescription.ns01#MaxSizeInMegabytes, requiresDuplicate: payload.ns0#entry.ns0#content.ns01#TopicDescription.ns01#RequiresDuplicateDetection, enableBatched: payload.ns0#entry.ns0#content.ns01#TopicDescription.ns01#EnableBatchedOperations, defaultMTTL: payload.ns0#entry.ns0#content.ns01#TopicDescription.ns01#DefaultMessageTimeToLive, duplicateDetection: payload.ns0#entry.ns0#content.ns01#TopicDescription.ns01#DuplicateDetectionHistoryTimeWindow, } ``` ### Add a Logger Component The Logger component displays the new topic in the **Mule Console**: 1. In the **Mule Palette** view, search for `logger` and select the **Logger (Core)** component. 2. Drag the **Logger (Core)** component onto the Studio canvas, to the right of the **Transform Message** component. 3. In the **Message** field of the Logger configuration, enter `#[payload]`. 4. Save the project. 5. Test the app by sending a GET request to `http://127.0.0.1:8081/topic`. ### XML for the Create Topic Example ```xml 1024 false false PT256204778H48M5S PT10M ']]]> ``` ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Azure Service Bus Management Connector version: 1.0 is-latest-version: true --- # Azure Service Bus Management 1.0 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio. If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can get access to the connector in your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. When you install the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/azure-service-bus-management http://www.mulesoft.org/schema/mule/azure-service-bus-management/current/mule-aure-service-bus-management.xsd ``` This example shows how the namespace statements are placed in the `` XML block: ```xml ="http://www.mulesoft.org/schema/mule/" xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:file="http://www.mulesoft.org/schema/mule/file" xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd http://www.mulesoft.org/schema/mule/azure-service-bus-management http://www.mulesoft.org/schema/mule/azure-service-bus-management/current/mule-aure-service-bus-management.xsd ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors azure-service-bus-management x.x.x mule-plugin ``` Replace `x.x.x` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `azure service bus management`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After completing your namespace and `pom.xml` file, you can try the examples. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Azure Service Bus Management Connector version: 1.0 is-latest-version: true --- # Azure Service Bus Management Connector 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Microsoft Azure Service Bus Management (Azure Service Bus Management Connector) enables management integration with Azure Service Bus on the cloud. This connector connects to the Azure REST API and supports management operations for queues, topics, and subscriptions. In addition, you can use the built-in management API to discover Azure Service Bus objects automatically and provision them. > [!NOTE] This connector supports integrations with Azure Service Bus (cloud). It does not work with > Microsoft Windows Service Bus (on-premise). To connect with Microsoft Windows Service Bus > on-premise, use > [Anypoint Connector for Microsoft Windows Service Bus](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-microsoft-service-bus-connector/). To use the Azure management API for message integration with Azure Service Bus on the cloud, use the Anypoint Connector for Azure Service Bus. For compatibility information, see the Azure Service Bus Management Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Microsoft Azure REST API - Anypoint connectors - Mule runtime engine (Mule) - Elements in a Mule flow - Global elements - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - The Microsoft Azure target resource - Anypoint Studio or Anypoint Code Builder ## Common Use Cases For the Connector Common use cases for this connector include: - Creating, modifying, and deleting a queue, topic, and subscription - Retrieving all queues, topics, and subscriptions from the Azure Service Bus instance For examples, see [Examples](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-examples). ## Audience - New user To create your Mule app, see: - [Using Anypoint Studio to Configure Microsoft Azure Connector](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-studio) - [Additional Configuration Information](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-config-topics) to help extend your understanding of Azure Service Bus Management connector - [Examples](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-examples), which provide one or more use cases for the connector - Advanced user Read the following: - [XML and Maven Support](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-xml-maven) - [Additional Configuration Information](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-config-topics) - [Examples](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-examples) ## Next Step After you complete the prerequisites and experiment with the examples, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Salesforce Help](https://help.salesforce.com) --- product: Azure Service Bus Management Connector version: 1.0 is-latest-version: true --- # Azure Service Bus Management Connector 1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Support Version: Select ## Configurations --- ### Config #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name of this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Response Timeout

Number

The timeout for the request to the remote service.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

AUTO

Name

String

The identifier used to reference this element in other components

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

#### Connection Types ##### Shared Access Signature ###### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Query Parameters

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection is closed after the first request completes.

true

Max Connections

Number

The maximum number of outbound connections to keep open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Connection Idle Timeout

SECONDS

Proxy Config

A reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Indicates whether or not received responses should be streamed

false

Response Buffer Size

Number

The space, in bytes, for the buffer where the HTTP response is stored.

-1

Service Namespace

String

The Azure Service Bus namespace

x

Shared Access Key Name

String

The name of the access key configured on the namespace

x

Shared Access Key

String

The 256-bit primary key

x

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS

HTTP

TLS Configuration

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

## Operations - [Delete Entity](#DeleteByEntity) - [Delete Subscription](#DeleteSubscriptionsByTopicSubscription) - [Delete Rule](#DeleteSubscriptionsRulesByTopicSubscriptionRule) - [Get Entity](#GetByEntity) - [List Queues](#GetResourcesQueues) - [List Topics](#GetResourcesTopics) - [List Subscriptions](#GetSubscriptionsByTopic) - [Get Subscription](#GetSubscriptionsByTopicSubscription) - [List Rules](#GetSubscriptionsRulesByTopicSubscription) - [Get Rule](#GetSubscriptionsRulesByTopicSubscriptionRule) - [Create or Update Entity](#UpdateByEntity) - [Create or update Subscription](#UpdateSubscriptionsByTopicSubscription) - [Create or Update Rule](#UpdateSubscriptionsRulesByTopicSubscriptionRule) ## Delete Entity `` Deletes the specified entity in the service bus instance. This operation makes an `HTTP DELETE` request to the `/{entity}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Entity (Queue or Topic)

String

The queue or topic to delete

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Delete Subscription `` Deletes a subscription over a specified topic. This operation makes an `HTTP DELETE` request to the `/{topic}/Subscriptions/{subscription}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic

String

Topic for which to delete a subscription

x

Subscription

String

Topic subscription for which to delete a subscription

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Delete Rule `` Delete a rule from the service bus instance over a specified subscription and topic. This operation makes an `HTTP DELETE` request to the `/{topic}/Subscriptions/{subscription}/rules/{rule}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic

String

Topic

x

Subscription

String

The topic subscription

x

Rule

String

The subscription rule

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

String

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Get Entity `` Retrieves the specified queue or topic from the service bus instance. This operation makes an `HTTP GET` request to the `/{entity}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Entity (Queue or Topic)

String

The queue or topic to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for the request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether the request should be sent using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## List Queues `` Retrieves all existing queues from the service bus instance. This operation makes an `HTTP GET` request to the `/$Resources/Queues` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether the request should be sent using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## List Topics `` Retrieves all existing topics from the service bus instance. This operation makes an `HTTP GET` request to the `/$Resources/Topics` endpoint ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## List Subscriptions `` Retrieves all existing subscriptions of the specific topic from the service bus instance. This operation makes an `HTTP GET` request to the `/{topic}/Subscriptions` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic

String

The Topic to retrieve all subscriptions

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Get Subscription `` Retrieves the specified subscription. This operation makes an `HTTP GET` request to the `/{topic}/Subscriptions/{subscription}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic

String

The topic of the subscription

x

Subscription

String

The subscription to retrieve

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## List Rules `` Retrieves from the service bus instance all existing rules of the specified subscription and topic. This operation makes an `HTTP GET` request to the `/{topic}/Subscriptions/{subscription}/rules` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic

String

Topic for which to retrieve rules

x

Subscription

String

Topic subscription for which to retrieve rules

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Get Rule `` Retrieves a rule over an specific subscription from the service bus instance. This operation makes an `HTTP GET` request to the `/{topic}/Subscriptions/{subscription}/rules/{rule}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic

String

Topic

x

Subscription

String

The topic subscription

x

Rule

String

The rule to retrieve

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

#[null]

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Create or Update Entity `` Creates a queue or topic in the service bus instance. This operation makes an HTTP PUT request to the `/{entity}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Entity (Queue or Topic)

String

The queue or topic to update

x

String

Set this header to `*` to update the entity.

Content

Binary

The Topic or Queue description of the entity.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Create or update Subscription `` Creates or updates a subscription over a specified topic. This operation makes an `HTTP PUT` request to the `/{topic}/Subscriptions/{subscription}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic

String

Topic for which to create or update a subscription

x

Subscription

String

Topic subscription to create or update

x

If Match

String

Set this header to * to update the entity.

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Create or Update Rule `` Create or update a rule over a specific subscription from the service bus instance. This operation makes an `HTTP PUT` request to the `/{topic}/Subscriptions/{subscription}/rules/{rule}` endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Topic

String

Topic

x

Subscription

String

The topic subscription

x

Rule

String

The rule to create or update

x

If Match

String

Set this header to *€ to update the rule.

Content

Binary

The content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Disables the repeatable stream functionality and uses non-repeatable streams, which can have less performance overhead, memory use, and cost

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit for the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Indicates whether to send the request using streaming. Set this value to AUTO to have the connector automatically use the best strategy based on the request content.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy if there are connectivity errors

### Output

Type

Any

Attributes Type

### For Configurations - [Config](#Config) ### Throws - AZURE-SERVICE-BUS-MANAGEMENT:BAD\_REQUEST - AZURE-SERVICE-BUS-MANAGEMENT:CLIENT\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:CONNECTIVITY - AZURE-SERVICE-BUS-MANAGEMENT:INTERNAL\_SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_ACCEPTABLE - AZURE-SERVICE-BUS-MANAGEMENT:NOT\_FOUND - AZURE-SERVICE-BUS-MANAGEMENT:RETRY\_EXHAUSTED - AZURE-SERVICE-BUS-MANAGEMENT:SERVER\_ERROR - AZURE-SERVICE-BUS-MANAGEMENT:SERVICE\_UNAVAILABLE - AZURE-SERVICE-BUS-MANAGEMENT:TIMEOUT - AZURE-SERVICE-BUS-MANAGEMENT:TOO\_MANY\_REQUESTS - AZURE-SERVICE-BUS-MANAGEMENT:UNAUTHORIZED - AZURE-SERVICE-BUS-MANAGEMENT:UNSUPPORTED\_MEDIA\_TYPE ## Types ### Default Header
FieldTypeDescriptionDefault ValueRequired

Key

String

x

Value

String

x

### Default Query Param
FieldTypeDescriptionDefault ValueRequired

Key

String

x

Value

String

x

### Proxy
FieldTypeDescriptionDefault ValueRequired

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

### Tls
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.

Type

String

The type of store used.

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected previously).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom Ocsp Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### Crl File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

### Reconnect
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often, in milliseconds, to reconnect

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make.

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often, in milliseconds, to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Http Response Attributes
FieldTypeDescriptionDefault ValueRequired

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

The amount of memory allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more memory is used than the Max Buffer Size, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more memory is used than the In Memory Size, the consumed content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit for In Memory Size

--- product: Azure Service Bus Management Connector version: 1.0 is-latest-version: true --- # Using Anypoint Studio to Configure Azure Service Bus Management 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Azure Service Bus Management Reference](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Anypoint Connector for Azure Service Bus Management (Azure Service Bus Management Connector) to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `azure` in the search field. 3. Click **Azure Service Bus Management** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with Azure Service Bus Management Connector: - `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port - `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure `HTTP Listener`, follow these steps: 1. In the **Mule Palette** view, select **HTTP** > **Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information. 7. On the **TLS** tab, optionally specify TLS information. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specific server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Azure Service Bus Management Connector, follow these steps: 1. In the **Mule Palette** view, select **Azure Service Bus Management** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target Azure Service Bus instance. Azure Service Bus Management Connector supports shared access signature (SAS) authentication. To configure the global element for Azure Service Bus Management Connector, follow these steps: 1. Select the name of the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, configure shared access signature (SAS) authentication by entering values for these fields:
FieldUser Action

Service Namespace

Namespace for the Azure Service Bus Service within your subscription

Shared Access Key Name

Name of your SAS token

Shared Access Key

SAS token

The following screenshot shows an example of configuring shared access signature (SAS) authentication. This screenshot uses property placeholders for field values. For information about using property placeholders, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). ![SAS authentication config fields on the General tab](/mulesoft/current/en-us/azure-service-bus-management-connector/latest/_images/azure-sb-mgmt-authentication.png) Figure 1. SAS authentication fields 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ## Configure the Other Connector Fields After you configure a global element for Azure Service Bus Management Connector, configure the other required fields for the connector operation. For example, to create or update a queue or topic, use the `Create or Update Entity` operation and complete these fields:
FieldDescription

Entity (Queue or Topic)

Enter the name of the entity to create or update.

If Match

To update an existing entity, set this header to *. Otherwise, leave this field blank.

Content

Enter the queue description or topic.

## View the App Log You can view the app log as follows: - If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log is visible in your OS console. Unless the log file path was customized in the app’s log file (`log4j2.xml`), you can also view the app log in this default location: `MULE_HOME/logs/.log` For more information about the app log, see [Configuring Logging](https://docs.mulesoft.com/mule-runtime/latest/logging-in-mule). ## Next Step See [Additional Configuration Information](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-config-topics) for more configuration information. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Azure Service Bus Management Reference](https://docs.mulesoft.com/azure-service-bus-management-connector/latest/azure-service-bus-management-connector-reference) - [Salesforce Help](https://help.salesforce.com)