Share via

az servicebus topic subscription

  • Reference

Servicebus topic subscription.

Commands

Name Description Type Status
az servicebus topic subscription create

Create a topic subscription.

 Core GA
az servicebus topic subscription delete

Delete a subscription from the specified topic.

 Core GA
az servicebus topic subscription list

List all the subscriptions under a specified topic.

 Core GA
az servicebus topic subscription rule

Servicebus topic subscription rule.

 Core GA
az servicebus topic subscription rule create

Create the ServiceBus Rule for Subscription.

 Core GA
az servicebus topic subscription rule delete

Delete an existing rule.

 Core GA
az servicebus topic subscription rule list

List all the rules within given topic-subscription.

 Core GA
az servicebus topic subscription rule show

Get the description for the specified rule.

 Core GA
az servicebus topic subscription rule update

Update a new rule and updates an existing rule.

 Core GA
az servicebus topic subscription show

Get a subscription description for the specified topic.

 Core GA
az servicebus topic subscription update

Update a topic subscription.

 Core GA

az servicebus topic subscription create

Edit

Create a topic subscription.

az servicebus topic subscription create --name
                                        --namespace-name
                                        --resource-group
                                        --topic-name
                                        [--auto-delete-on-idle]
                                        [--client-id]
                                        [--dead-letter-on-filter-exceptions {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--default-message-time-to-live]
                                        [--duplicate-detection-history-time-window]
                                        [--enable-batched-operations {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--enable-dead-lettering-on-message-expiration {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--enable-session {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--forward-dead-lettered-messages-to]
                                        [--forward-to]
                                        [--is-client-affine {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--is-durable {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--is-shared {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--lock-duration]
                                        [--max-delivery-count]
                                        [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]

Required Parameters

--name --subscription-name -n

The subscription name.

--namespace-name

The namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--topic-name

The topic name.

Optional Parameters

--auto-delete-on-idle

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

--client-id

Indicates the Client ID of the application that created the client-affine subscription.

--dead-letter-on-filter-exceptions -f

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--default-message-time-to-live

ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

--duplicate-detection-history-time-window -d

ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

--enable-batched-operations

Value that indicates whether server-side batched operations are enabled.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-dead-lettering-on-message-expiration --message-expiration

A value that indicates whether this queue has dead letter support when a message expires.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-session

A value that indicates whether the queue supports the concept of sessions.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--forward-dead-lettered-messages-to

Queue/Topic name to forward the Dead Letter message.

--forward-to

Queue/Topic name to forward the messages.

--is-client-affine

Value that indicates whether the subscription has an affinity to the client id.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-durable

For client-affine subscriptions, this value indicates whether the subscription is durable or not.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-shared

For client-affine subscriptions, this value indicates whether the subscription is shared or not.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--lock-duration

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

--max-delivery-count

Number of maximum deliveries.

--status

Enumerates the possible values for the status of a messaging entity.

Accepted values: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az servicebus topic subscription delete

Edit

Delete a subscription from the specified topic.

az servicebus topic subscription delete [--ids]
                                        [--name]
                                        [--namespace-name]
                                        [--resource-group]
                                        [--subscription]
                                        [--topic-name]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --subscription-name -n

The subscription name.

--namespace-name

The namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--topic-name

The topic name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az servicebus topic subscription list

Edit

List all the subscriptions under a specified topic.

az servicebus topic subscription list --namespace-name
                                      --resource-group
                                      --topic-name
                                      [--skip]
                                      [--top]

Required Parameters

--namespace-name

The namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--topic-name

The topic name.

Optional Parameters

--skip

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

--top

May be used to limit the number of results to the most recent N usageDetails.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az servicebus topic subscription show

Edit

Get a subscription description for the specified topic.

az servicebus topic subscription show [--ids]
                                      [--name]
                                      [--namespace-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--topic-name]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --subscription-name -n

The subscription name.

--namespace-name

The namespace name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--topic-name

The topic name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az servicebus topic subscription update

Edit

Update a topic subscription.

az servicebus topic subscription update [--add]
                                        [--auto-delete-on-idle]
                                        [--client-id]
                                        [--dead-letter-on-filter-exceptions {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--default-message-time-to-live]
                                        [--duplicate-detection-history-time-window]
                                        [--enable-batched-operations {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--enable-dead-lettering-on-message-expiration {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--enable-session {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--forward-dead-lettered-messages-to]
                                        [--forward-to]
                                        [--ids]
                                        [--is-client-affine {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--is-durable {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--is-shared {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--lock-duration]
                                        [--max-delivery-count]
                                        [--name]
                                        [--namespace-name]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                                        [--subscription]
                                        [--topic-name]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--auto-delete-on-idle

ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

--client-id

Indicates the Client ID of the application that created the client-affine subscription.

--dead-letter-on-filter-exceptions -f

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--default-message-time-to-live

ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

--duplicate-detection-history-time-window -d

ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

--enable-batched-operations

Value that indicates whether server-side batched operations are enabled.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-dead-lettering-on-message-expiration --message-expiration

A value that indicates whether this queue has dead letter support when a message expires.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-session

A value that indicates whether the queue supports the concept of sessions.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--forward-dead-lettered-messages-to

Queue/Topic name to forward the Dead Letter message.

--forward-to

Queue/Topic name to forward the messages.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--is-client-affine

Value that indicates whether the subscription has an affinity to the client id.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-durable

For client-affine subscriptions, this value indicates whether the subscription is durable or not.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-shared

For client-affine subscriptions, this value indicates whether the subscription is shared or not.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--lock-duration

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

--max-delivery-count

Number of maximum deliveries.

--name --subscription-name -n

The subscription name.

--namespace-name

The namespace name.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--status

Enumerates the possible values for the status of a messaging entity.

Accepted values: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--topic-name

The topic name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.