az servicebus topic subscription

Manage Azure Service Bus Subscription.

Commands

az servicebus topic subscription create

Create the ServiceBus Subscription.

az servicebus topic subscription delete

Deletes the Service Bus Subscription.

az servicebus topic subscription list

List the Subscription by Service Bus Topic.

az servicebus topic subscription rule

Manage Azure Service Bus Rule.

az servicebus topic subscription rule create

Create the ServiceBus Rule for Subscription.

az servicebus topic subscription rule delete

Deletes the ServiceBus Rule.

az servicebus topic subscription rule list

List the ServiceBus Rule by Subscription.

az servicebus topic subscription rule show

Shows ServiceBus Rule Details.

az servicebus topic subscription rule update

Updates the ServiceBus Rule for Subscription.

az servicebus topic subscription show

Shows Service Bus Subscription Details.

az servicebus topic subscription update

Updates the ServiceBus Subscription.

az servicebus topic subscription create

Create the ServiceBus Subscription.

az servicebus topic subscription create --name
                                        --namespace-name
                                        --resource-group
                                        --topic-name
                                        [--auto-delete-on-idle]
                                        [--dead-letter-on-filter-exceptions {false, true}]
                                        [--default-message-time-to-live]
                                        [--enable-batched-operations {false, true}]
                                        [--enable-dead-lettering-on-message-expiration {false, true}]
                                        [--enable-session {false, true}]
                                        [--forward-dead-lettered-messages-to]
                                        [--forward-to]
                                        [--lock-duration]
                                        [--max-delivery-count]
                                        [--status {Active, Disabled, ReceiveDisabled, SendDisabled}]
                                        [--subscription]

Examples

Create a new Subscription.

az servicebus topic subscription create --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --name mysubscription

Required Parameters

--name -n

Name of Subscription.

--namespace-name

Name of Namespace.

--resource-group -g

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

--topic-name

Name of Topic.

Optional Parameters

--auto-delete-on-idle

ISO 8601 timeSpan or duration time format for idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

--dead-letter-on-filter-exceptions

Allow dead lettering when filter evaluation exceptions occur.

accepted values: false, true
--default-message-time-to-live

ISO 8601 or duration time format for 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.

--enable-batched-operations

Allow server-side batched operations.

accepted values: false, true
--enable-dead-lettering-on-message-expiration

A boolean Value that indicates whether a subscription has dead letter support when a message expires.

accepted values: false, true
--enable-session

A boolean value indicating if a subscription supports the concept of sessions.

accepted values: false, true
--forward-dead-lettered-messages-to

Queue/Topic name to forward the Dead Letter message.

--forward-to

Queue/Topic name to forward the messages.

--lock-duration

ISO 8601 or duration format (day:minute:seconds) for 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, Disabled, ReceiveDisabled, SendDisabled
--subscription

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

az servicebus topic subscription delete

Deletes the Service Bus Subscription.

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

Examples

Deletes the Subscription

az servicebus topic subscription delete --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --name mysubscription

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 -n

Name of Subscription.

--namespace-name

Name of Namespace.

--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

Name of Topic.

az servicebus topic subscription list

List the Subscription by Service Bus Topic.

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

Examples

Shows the Subscription by Service Bus Topic.

az servicebus topic subscription list --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic

Required Parameters

--namespace-name

Name of Namespace.

--resource-group -g

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

--topic-name

Name of Topic.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--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.

--subscription

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

--top

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

az servicebus topic subscription show

Shows Service Bus Subscription Details.

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

Examples

Shows the Subscription details.

az servicebus topic subscription show --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --name mysubscription

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 -n

Name of Subscription.

--namespace-name

Name of Namespace.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--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

Name of Topic.

az servicebus topic subscription update

Updates the ServiceBus Subscription.

az servicebus topic subscription update [--add]
                                        [--auto-delete-on-idle]
                                        [--dead-letter-on-filter-exceptions {false, true}]
                                        [--default-message-time-to-live]
                                        [--enable-batched-operations {false, true}]
                                        [--enable-dead-lettering-on-message-expiration {false, true}]
                                        [--enable-session {false, true}]
                                        [--force-string]
                                        [--forward-dead-lettered-messages-to]
                                        [--forward-to]
                                        [--ids]
                                        [--lock-duration]
                                        [--max-delivery-count]
                                        [--name]
                                        [--namespace-name]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--status {Active, Disabled, ReceiveDisabled, SendDisabled}]
                                        [--subscription]
                                        [--topic-name]

Examples

Update a new Subscription.

az servicebus topic subscription update --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --name mysubscription --lock-duration PT3M

Updates the ServiceBus Subscription (autogenerated)

az servicebus topic subscription update --name mysubscription --namespace-name mynamespace --resource-group myresourcegroup --status Active --subscription MySubscription --topic-name mytopic

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 8601 timeSpan or duration time format for idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

--dead-letter-on-filter-exceptions

Allow dead lettering when filter evaluation exceptions occur.

accepted values: false, true
--default-message-time-to-live

ISO 8601 or duration time format for 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.

--enable-batched-operations

Allow server-side batched operations.

accepted values: false, true
--enable-dead-lettering-on-message-expiration

A boolean Value that indicates whether a subscription has dead letter support when a message expires.

accepted values: false, true
--enable-session

A boolean value indicating if a subscription supports the concept of sessions.

accepted values: false, true
--force-string

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

--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.

--lock-duration

ISO 8601 or duration format (day:minute:seconds) for lock duration timespan for the subscription. The default value is 1 minute.

--max-delivery-count

Number of maximum deliveries.

--name -n

Name of Subscription.

--namespace-name

Name of Namespace.

--remove

Remove a property or an element from a list. Example: --remove property.list 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=.

--status

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

accepted values: Active, Disabled, ReceiveDisabled, SendDisabled
--subscription

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

--topic-name

Name of Topic.