az servicebus topic

  • Reference

Servicebus topic.

Commands

Name Description Type Status
az servicebus topic authorization-rule

Servicebus topic authorization-rule.

 Core GA
az servicebus topic authorization-rule create

Create an authorization rule for the specified topic.

 Core GA
az servicebus topic authorization-rule delete

Delete a topic authorization rule.

 Core GA
az servicebus topic authorization-rule keys

Servicebus topic authorization-rule keys.

 Core GA
az servicebus topic authorization-rule keys list

Gets the primary and secondary connection strings for the topic.

 Core GA
az servicebus topic authorization-rule keys renew

Regenerates primary or secondary connection strings for the topic.

 Core GA
az servicebus topic authorization-rule list

List authorization rules for a topic.

 Core GA
az servicebus topic authorization-rule show

Get the specified authorization rule.

 Core GA
az servicebus topic authorization-rule update

Update an authorization rule for the specified topic.

 Core GA
az servicebus topic create

Create a topic in the specified namespace.

 Core GA
az servicebus topic delete

Delete a topic from the specified namespace and resource group.

 Core GA
az servicebus topic list

List all the topics in a namespace.

 Core GA
az servicebus topic show

Get a description for the specified topic.

 Core GA
az servicebus topic subscription

Servicebus topic subscription.

 Core GA
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 update

Update a topic in the specified namespace.

 Core GA

az servicebus topic create

Edit

Create a topic in the specified namespace.

az servicebus topic create --name
                           --namespace-name
                           --resource-group
                           [--auto-delete-on-idle]
                           [--default-message-time-to-live]
                           [--duplicate-detection {0, 1, f, false, n, no, t, true, y, yes}]
                           [--duplicate-detection-history-time-window]
                           [--enable-batched-operations {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-express {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-ordering {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-partitioning {0, 1, f, false, n, no, t, true, y, yes}]
                           [--max-message-size]
                           [--max-size]
                           [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]

Required Parameters

--name --topic-name -n

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

Optional Parameters

--auto-delete-on-idle

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

--default-message-time-to-live

ISO 8601 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 --enable-duplicate-detection

A value indicating if this queue requires duplicate detection.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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-express

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: 0, 1, f, false, n, no, t, true, y, yes
--enable-ordering

Value that indicates whether the topic supports ordering.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-partitioning

Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--max-message-size --max-message-size-in-kilobytes

Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.

--max-size --max-size-in-megabytes

Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

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

Edit

Delete a topic from the specified namespace and resource group.

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

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

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

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 list

Edit

List all the topics in a namespace.

az servicebus topic list --namespace-name
                         --resource-group
                         [--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>.

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 show

Edit

Get a description for the specified topic.

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

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

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

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 update

Edit

Update a topic in the specified namespace.

az servicebus topic update [--add]
                           [--auto-delete-on-idle]
                           [--default-message-time-to-live]
                           [--duplicate-detection {0, 1, f, false, n, no, t, true, y, yes}]
                           [--duplicate-detection-history-time-window]
                           [--enable-batched-operations {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-express {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-ordering {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-partitioning {0, 1, f, false, n, no, t, true, y, yes}]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--max-message-size]
                           [--max-size]
                           [--name]
                           [--namespace-name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                           [--subscription]

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 idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

--default-message-time-to-live

ISO 8601 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 --enable-duplicate-detection

A value indicating if this queue requires duplicate detection.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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-express

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: 0, 1, f, false, n, no, t, true, y, yes
--enable-ordering

Value that indicates whether the topic supports ordering.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-partitioning

Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

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
--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-message-size --max-message-size-in-kilobytes

Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.

--max-size --max-size-in-megabytes

Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

--name --topic-name -n

The topic name.

--namespace-name

The namespace name.

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

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.