Contact Us 1-800-596-4880
  1. Homepage
  2. Azure Service Bus Management Connector (1.0)

  3. Azure Service Bus Management Connector Reference

All Connectors

Azure Service Bus Management Connector 1.0 Reference - Mule 4

Support Version: Select

Configurations

Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Shared Access Signature

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

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
Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Array of Default Query Param

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

Proxy

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

Tls

Reconnection

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

<azure-service-bus-management:delete-by-entity>

Deletes the specified entity in the service bus instance. This operation makes an HTTP DELETE request to the /{entity} endpoint.

Parameters

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:delete-subscriptions-by-topic-subscription>

Deletes a subscription over a specified topic. This operation makes an HTTP DELETE request to the /{topic}/Subscriptions/{subscription} endpoint.

Parameters

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:delete-subscriptions-rules-by-topic-subscription-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

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:get-by-entity>

Retrieves the specified queue or topic from the service bus instance. This operation makes an HTTP GET request to the /{entity} endpoint.

Parameters

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:get-resources-queues>

Retrieves all existing queues from the service bus instance. This operation makes an HTTP GET request to the /$Resources/Queues endpoint.

Parameters

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:get-resources-topics>

Retrieves all existing topics from the service bus instance. This operation makes an HTTP GET request to the /$Resources/Topics endpoint

Parameters

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:get-subscriptions-by-topic>

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

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:get-subscriptions-by-topic-subscription>

Retrieves the specified subscription. This operation makes an HTTP GET request to the /{topic}/Subscriptions/{subscription} endpoint.

Parameters

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:get-subscriptions-rules-by-topic-subscription>

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

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:get-subscriptions-rules-by-topic-subscription-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

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:update-by-entity>

Creates a queue or topic in the service bus instance. This operation makes an HTTP PUT request to the /{entity} endpoint.

Parameters

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:update-subscriptions-by-topic-subscription>

Creates or updates a subscription over a specified topic. This operation makes an HTTP PUT request to the /{topic}/Subscriptions/{subscription} endpoint.

Parameters

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

<azure-service-bus-management:update-subscriptions-rules-by-topic-subscription-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

Name Type Description Default Value Required

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

Http Response Attributes

For Configurations

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

Field Type Description Default Value Required

Key

String

x

Value

String

x

Default Query Param

Field Type Description Default Value Required

Key

String

x

Value

String

x

Proxy

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

Tls

Field Type Description Default Value Required

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

Trust Store

Key Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

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

Field Type Description Default Value Required

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

Field Type Description Default Value Required

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

Field Type Description Default Value Required

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

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

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

Field Type Description Default Value Required

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

Field Type Description Default Value Required

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

Field Type Description Default Value Required

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

Field Type Description Default Value Required

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

Field Type Description Default Value Required

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

Field Type Description Default Value Required

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
Back to top
View on GitHub