Share via

az servicebus queue

Servicebus queue.

Commands

Name Description Type Status
az servicebus queue authorization-rule

Servicebus queue authorization-rule.

 Core GA
az servicebus queue authorization-rule create

Create an authorization rule for a queue.

 Core GA
az servicebus queue authorization-rule delete

Delete a queue authorization rule.

 Core GA
az servicebus queue authorization-rule keys

Servicebus queue authorization-rule keys.

 Core GA
az servicebus queue authorization-rule keys list

Primary and secondary connection strings to the queue.

 Core GA
az servicebus queue authorization-rule keys renew

Regenerates the primary or secondary connection strings to the queue.

 Core GA
az servicebus queue authorization-rule list

List all authorization rules for a queue.

 Core GA
az servicebus queue authorization-rule show

Get an authorization rule for a queue by rule name.

 Core GA
az servicebus queue authorization-rule update

Update an authorization rule for a queue.

 Core GA
az servicebus queue create

Create a Service Bus queue. This operation is idempotent.

 Core GA
az servicebus queue delete

Delete a queue from the specified namespace in a resource group.

 Core GA
az servicebus queue list

List the queues within a namespace.

 Core GA
az servicebus queue show

Get a description for the specified queue.

 Core GA
az servicebus queue update

Update a Service Bus queue. This operation is idempotent.

 Core GA

az servicebus queue create

Edit

Create a Service Bus queue. This operation is idempotent.

az servicebus queue create --name --queue-name
                           --namespace-name
                           --resource-group
                           [--auto-delete-on-idle]
                           [--default-message-time-to-live]
                           [--duplicate-detection --enable-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-dead-lettering-on-message-expiration --message-expiration {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-express {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-partitioning {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]
                           [--lock-duration]
                           [--max-delivery-count]
                           [--max-message-size --max-message-size-in-kilobytes]
                           [--max-size --max-size-in-megabytes]
                           [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]

Required Parameters

--name --queue-name -n

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--auto-delete-on-idle

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--duplicate-detection --enable-duplicate-detection

A value indicating if this queue requires duplicate detection.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--enable-batched-operations

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

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-express

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

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-partitioning

A value that indicates whether the queue is to be partitioned across multiple message brokers.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--forward-to

Queue/Topic name to forward the messages.

Property Value
Parameter group: Properties Arguments
--lock-duration

ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

Property Value
Parameter group: Properties Arguments
--max-delivery-count

The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

Property Value
Parameter group: Properties 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.

Property Value
Parameter group: Properties Arguments
--max-size --max-size-in-megabytes

The maximum capacity of the queue, denoted in megabytes, signifies the volume of memory assigned to the queue. The permissible values for this parameter are 1024, 2048, 3072, 4096, and 5120 megabytes. By default, the system assigns a capacity of 1024 megabytes. If the ‘enable-partition’ setting is set to true, the specified queue size will be amplified by a factor of 16.

Property Value
Parameter group: Properties Arguments
--status

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

Property Value
Parameter group: Properties Arguments
Accepted values: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az servicebus queue delete

Edit

Delete a queue from the specified namespace in a resource group.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --queue-name -n

The queue name.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az servicebus queue list

Edit

List the queues within a namespace.

az servicebus queue 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az servicebus queue show

Edit

Get a description for the specified queue.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--name --queue-name -n

The queue name.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az servicebus queue update

Edit

Update a Service Bus queue. This operation is idempotent.

az servicebus queue update [--add]
                           [--auto-delete-on-idle]
                           [--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 --message-expiration {0, 1, f, false, n, no, t, true, y, yes}]
                           [--enable-express {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]
                           [--lock-duration]
                           [--max-delivery-count]
                           [--max-message-size --max-message-size-in-kilobytes]
                           [--max-size --max-size-in-megabytes]
                           [--name --queue-name]
                           [--namespace-name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                           [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--auto-delete-on-idle

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--enable-batched-operations

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

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-express

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

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Properties Arguments
--forward-to

Queue/Topic name to forward the messages.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--lock-duration

ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

Property Value
Parameter group: Properties Arguments
--max-delivery-count

The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

Property Value
Parameter group: Properties 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.

Property Value
Parameter group: Properties Arguments
--max-size --max-size-in-megabytes

The maximum capacity of the queue, denoted in megabytes, signifies the volume of memory assigned to the queue. The permissible values for this parameter are 1024, 2048, 3072, 4096, and 5120 megabytes. By default, the system assigns a capacity of 1024 megabytes. If the ‘enable-partition’ setting is set to true, the specified queue size will be amplified by a factor of 16.

Property Value
Parameter group: Properties Arguments
--name --queue-name -n

The queue name.

Property Value
Parameter group: Resource Id Arguments
--namespace-name

The namespace name.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--status

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

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False