az servicebus queue

Reference

Manage Azure Service Bus Queue and Authorization Rule.

Commands

az servicebus queue authorization-rule	Manage Azure Service Bus Queue Authorization Rule.
az servicebus queue authorization-rule create	Create Authorization Rule for the given Service Bus Queue.
az servicebus queue authorization-rule delete	Delete the Authorization Rule of Service Bus Queue.
az servicebus queue authorization-rule keys	Manage Azure Authorization Rule keys for Service Bus Queue.
az servicebus queue authorization-rule keys list	List the keys and connection strings of Authorization Rule for the given Service Bus Queue.
az servicebus queue authorization-rule keys renew	Regenerate keys of Authorization Rule for Service Bus Queue.
az servicebus queue authorization-rule list	List of Authorization Rule by Service Bus Queue.
az servicebus queue authorization-rule show	Show properties of Authorization Rule for the given Service Bus Queue.
az servicebus queue authorization-rule update	Update Authorization Rule for the given Service Bus Queue.
az servicebus queue create	Create the Service Bus Queue.
az servicebus queue delete	Deletes the Service Bus Queue.
az servicebus queue list	List the Queue by Service Bus Namespace.
az servicebus queue show	Shows the Service Bus Queue Details.
az servicebus queue update	Updates existing Service Bus Queue.

az servicebus queue create

Edit

Create the Service Bus Queue.

az servicebus queue 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-dead-lettering-on-message-expiration {false, true}]
                           [--enable-duplicate-detection {false, true}]
                           [--enable-express {false, true}]
                           [--enable-partitioning {false, true}]
                           [--enable-session {false, true}]
                           [--forward-dead-lettered-messages-to]
                           [--forward-to]
                           [--lock-duration]
                           [--max-delivery-count]
                           [--max-message-size]
                           [--max-size {1024, 10240, 2048, 20480, 3072, 4096, 40960, 5120, 81920}]
                           [--status {Active, Disabled, ReceiveDisabled, SendDisabled}]

Examples

Create Service Bus Queue.

az servicebus queue create --resource-group myresourcegroup --namespace-name mynamespace --name myqueue

Required Parameters

--name -n

Name of Queue.

--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 queue is automatically deleted. The minimum duration is 5 minutes.

--default-message-time-to-live

ISO 8601 timespan or duration time format for default message 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 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-dead-lettering-on-message-expiration

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

accepted values: false, true

--enable-duplicate-detection

A boolean value indicating if this queue requires duplicate detection.

accepted values: false, true

--enable-express

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

accepted values: false, true

--enable-partitioning

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

accepted values: false, true

--enable-session

A boolean value indicating whether the queue 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

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

--max-delivery-count

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

--max-message-size --max-message-size-in-kilobytes

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

--max-size

Maximum size of queue in megabytes, which is the size of the memory allocated for the queue. 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, ReceiveDisabled, SendDisabled

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.

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

Edit

Deletes the Service Bus Queue.

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

Examples

Deletes the queue

az servicebus queue delete --resource-group myresourcegroup --namespace-name mynamespace --name myqueue

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

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

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.

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

Edit

List the Queue by Service Bus Namespace.

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

Examples

Get the Queues by Service Bus Namespace.

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

--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. Default value is None.

--top

May be used to limit the number of results to the most recent N usageDetails. Default value is None.

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.

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

Edit

Shows the Service Bus Queue Details.

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

Examples

Shows the Service Bus Queue Details

az servicebus queue show --resource-group myresourcegroup --namespace-name mynamespace --name myqueue

Optional Parameters

--ids

--name -n

Name of Queue.

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

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.

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

Edit

Updates existing Service Bus Queue.

az servicebus queue update [--add]
                           [--auto-delete-on-idle]
                           [--default-message-time-to-live]
                           [--duplicate-detection-history-time-window]
                           [--enable-batched-operations {false, true}]
                           [--enable-dead-lettering-on-message-expiration {false, true}]
                           [--enable-express {false, true}]
                           [--force-string]
                           [--forward-dead-lettered-messages-to]
                           [--forward-to]
                           [--ids]
                           [--lock-duration]
                           [--max-delivery-count]
                           [--max-message-size]
                           [--max-size {1024, 10240, 2048, 20480, 3072, 4096, 40960, 5120, 81920}]
                           [--name]
                           [--namespace-name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--status {Active, Disabled, ReceiveDisabled, SendDisabled}]
                           [--subscription]

Examples

Updates Service Bus Queue.

az servicebus queue update --resource-group myresourcegroup --namespace-name mynamespace --name myqueue --auto-delete-on-idle PT3M

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

default value: []

--auto-delete-on-idle

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

--default-message-time-to-live

--duplicate-detection-history-time-window

ISO 8601 timeSpan 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-dead-lettering-on-message-expiration

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

accepted values: false, true

--enable-express

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

accepted values: false, true

--force-string

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

default value: False

--forward-dead-lettered-messages-to

Queue/Topic name to forward the Dead Letter message.

--forward-to

Queue/Topic name to forward the messages.

--ids

--lock-duration

--max-delivery-count

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

--max-message-size --max-message-size-in-kilobytes

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

--max-size

Maximum size of queue in megabytes, which is the size of the memory allocated for the queue. 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 Queue.

--namespace-name

Name of Namespace.

--remove

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

default value: []

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

default value: []

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

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.

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

Commands

az servicebus queue create

Examples

Required Parameters

Optional Parameters

az servicebus queue delete

Examples

Optional Parameters

az servicebus queue list

Examples

Required Parameters

Optional Parameters

az servicebus queue show

Examples

Optional Parameters

az servicebus queue update

Examples

Optional Parameters

Feedback

Additional resources