az servicebus topic

Manage Azure Service Bus Topic and Authorization Rule.

Commands

az servicebus topic authorization-rule

Manage Azure Service Bus Topic Authorization Rule.

az servicebus topic authorization-rule create

Create Authorization Rule for given Service Bus Topic.

az servicebus topic authorization-rule delete

Deletes the Authorization Rule of the given Service Bus Topic.

az servicebus topic authorization-rule keys

Manage Azure Authorization Rule keys for Service Bus Topic.

az servicebus topic authorization-rule keys list

List the keys and connection strings of Authorization Rule for Service Bus Topic.

az servicebus topic authorization-rule keys renew

Regenerate keys of Authorization Rule for Service Bus Topic.

az servicebus topic authorization-rule list

Shows list of Authorization Rule by Service Bus Topic.

az servicebus topic authorization-rule show

Shows the details of Authorization Rule for given Service Bus Topic.

az servicebus topic authorization-rule update

Create Authorization Rule for given Service Bus Topic.

az servicebus topic create

Create the Service Bus Topic.

az servicebus topic delete

Deletes the Service Bus Topic.

az servicebus topic list

List the Topic by Service Bus Namepsace.

az servicebus topic show

Shows the Service Bus Topic Details.

az servicebus topic subscription

Manage Azure Service Bus Subscription.

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 update

Updates the Service Bus Topic.

az servicebus topic create

Create the Service Bus Topic.

az servicebus topic create --name
                           --namespace-name
                           --resource-group
                           [--auto-delete-on-idle]
                           [--default-message-time-to-live]
                           [--duplicate-detection-history-time-window]
                           [--enable-batched-operations {false, true}]
                           [--enable-duplicate-detection {false, true}]
                           [--enable-express {false, true}]
                           [--enable-ordering {false, true}]
                           [--enable-partitioning {false, true}]
                           [--max-size {1024, 10240, 2048, 20480, 3072, 4096, 40960, 5120, 81920}]
                           [--status {Active, Disabled, SendDisabled}]
                           [--subscription]

Examples

Create a new Service Bus Topic

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

Required Parameters

--name -n

Name of Topic.

--namespace-name

Name of Namespace.

--resource-group -g

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

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.

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

--duplicate-detection-history-time-window

ISO 8601 timespan or duration time format for structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

--enable-batched-operations

Allow server-side batched operations.

accepted values: false, true
--enable-duplicate-detection

A boolean value indicating if this topic requires duplicate detection.

accepted values: false, true
--enable-express

A boolean value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

accepted values: false, true
--enable-ordering

A boolean value that indicates whether the topic supports ordering.

accepted values: false, true
--enable-partitioning

A boolean value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

accepted values: false, true
--max-size

Maximum size of topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. Max for Standard SKU is 5120 and for Premium SKU is 81920.

accepted values: 1024, 10240, 2048, 20480, 3072, 4096, 40960, 5120, 81920
--status

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

accepted values: Active, Disabled, SendDisabled
--subscription

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

az servicebus topic delete

Deletes the Service Bus Topic.

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

Examples

Deletes the Service Bus Topic

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

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

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

az servicebus topic list

List the Topic by Service Bus Namepsace.

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

Examples

Get the Topics by Namespace.

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

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

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 show

Shows the Service Bus Topic Details.

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

Examples

Shows the Topic details.

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

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

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

az servicebus topic update

Updates the Service Bus Topic.

az servicebus topic update [--add]
                           [--auto-delete-on-idle]
                           [--default-message-time-to-live]
                           [--duplicate-detection-history-time-window]
                           [--enable-batched-operations {false, true}]
                           [--enable-duplicate-detection {false, true}]
                           [--enable-express {false, true}]
                           [--enable-ordering {false, true}]
                           [--enable-partitioning {false, true}]
                           [--force-string]
                           [--ids]
                           [--max-size {1024, 10240, 2048, 20480, 3072, 4096, 40960, 5120, 81920}]
                           [--name]
                           [--namespace-name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--status {Active, Disabled, SendDisabled}]
                           [--subscription]

Examples

Updates existing Service Bus Topic.

az servicebus topic update --resource-group myresourcegroup --namespace-name mynamespace --name mytopic --enable-ordering True

Updates the Service Bus Topic (autogenerated)

az servicebus topic update --auto-delete-on-idle PT3M --name mytopic --namespace-name mynamespace --resource-group myresourcegroup

Updates the Service Bus Topic (autogenerated)

az servicebus topic update --enable-batched-operations true --name mytopic --namespace-name mynamespace --resource-group myresourcegroup

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.

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

--duplicate-detection-history-time-window

ISO 8601 timespan or duration time format for structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

--enable-batched-operations

Allow server-side batched operations.

accepted values: false, true
--enable-duplicate-detection

A boolean value indicating if this topic requires duplicate detection.

accepted values: false, true
--enable-express

A boolean value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

accepted values: false, true
--enable-ordering

A boolean value that indicates whether the topic supports ordering.

accepted values: false, true
--enable-partitioning

A boolean value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

accepted values: false, true
--force-string

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

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

--max-size

Maximum size of topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024. Max for Standard SKU is 5120 and for Premium SKU is 81920.

accepted values: 1024, 10240, 2048, 20480, 3072, 4096, 40960, 5120, 81920
--name -n

Name of Topic.

--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, SendDisabled
--subscription

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