你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az servicebus queue

参考

Servicebus 队列。

命令

名称	说明	类型	Status
az servicebus queue authorization-rule	Servicebus 队列授权规则。	核心	GA
az servicebus queue authorization-rule create	为队列创建授权规则。	核心	GA
az servicebus queue authorization-rule delete	删除队列授权规则。	核心	GA
az servicebus queue authorization-rule keys	Servicebus 队列授权规则密钥。	核心	GA
az servicebus queue authorization-rule keys list	队列的主要和辅助连接字符串。	核心	GA
az servicebus queue authorization-rule keys renew	将主要或辅助连接字符串重新生成队列。	核心	GA
az servicebus queue authorization-rule list	列出队列的所有授权规则。	核心	GA
az servicebus queue authorization-rule show	按规则名称获取队列的授权规则。	核心	GA
az servicebus queue authorization-rule update	更新队列的授权规则。	核心	GA
az servicebus queue create	创建一个服务总线队列。此操作是幂等的。	核心	GA
az servicebus queue delete	从资源组中的指定命名空间中删除队列。	核心	GA
az servicebus queue list	列出命名空间中的队列。	核心	GA
az servicebus queue show	获取指定队列的说明。	核心	GA
az servicebus queue update	更新服务总线队列。此操作是幂等的。	核心	GA

az servicebus queue create

编辑

创建一个服务总线队列。此操作是幂等的。

az servicebus queue 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-dead-lettering-on-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-size]
                           [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]

必需参数

--name --queue-name -n

队列名称。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--auto-delete-on-idle

ISO 8061 timeSpan 空闲间隔后，队列会自动删除。最短持续时间为 5 分钟。

--default-message-time-to-live

ISO 8601 默认消息时间跨度为实时值。这是消息过期的持续时间，从消息发送到服务总线时开始。这是未在消息本身上设置 TimeToLive 时使用的默认值。

--duplicate-detection --enable-duplicate-detection

一个值，该值指示此队列是否需要重复检测。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--duplicate-detection-history-time-window -d

定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。默认值为 10 分钟。

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

一个值，该值指示是否启用 Express Entities。快速队列将消息暂时保存在内存中，然后再将其写入永久性存储。

接受的值: 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

扫视锁的 ISO 8601 时间跨度持续时间;也就是说，为其他接收方锁定消息的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。

--max-delivery-count

最大传递计数。在传递数之后，消息会自动死机。默认值为 10。

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

主题可以接受的消息有效负载的最大大小（以知识库(KB) 为单位）。此属性仅在今天高级版中使用，默认值为 1024。

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

队列的最大容量（以 MB 为单位）表示，表示分配给队列的内存量。此参数的允许值为 1024、2048、3072、4096 和 5120 兆字节。默认情况下，系统分配的容量为 1024 MB。如果“enable-partition”设置设置为 true，则指定的队列大小将加倍 16。

--status

枚举消息实体状态的可能值。

接受的值: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az servicebus queue delete

编辑

从资源组中的指定命名空间中删除队列。

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

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name --queue-name -n

队列名称。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az servicebus queue list

编辑

列出命名空间中的队列。

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

必需参数

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--skip

仅当上一个操作返回了部分结果时，才使用 Skip。如果以前的响应包含 nextLink 元素，则 nextLink 元素的值将包含一个 skip 参数，该参数指定用于后续调用的起点。

--top

可用于将结果数限制为最新的 N usageDetails。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az servicebus queue show

编辑

获取指定队列的说明。

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

可选参数

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--name --queue-name -n

队列名称。

--namespace-name

命名空间名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az servicebus queue update

编辑

更新服务总线队列。此操作是幂等的。

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 {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-size]
                           [--name]
                           [--namespace-name]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                           [--subscription]

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value、string 或 JSON 字符串>。

--auto-delete-on-idle

ISO 8061 timeSpan 空闲间隔后，队列会自动删除。最短持续时间为 5 分钟。

--default-message-time-to-live

ISO 8601 默认消息时间跨度为实时值。这是消息过期的持续时间，从消息发送到服务总线时开始。这是未在消息本身上设置 TimeToLive 时使用的默认值。

--duplicate-detection-history-time-window -d

定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。默认值为 10 分钟。

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

一个值，该值指示是否启用 Express Entities。快速队列将消息暂时保存在内存中，然后再将其写入永久性存储。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--forward-dead-lettered-messages-to

用于转发死信消息的队列/主题名称。

--forward-to

要转发消息的队列/主题名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“资源 ID”参数的所有信息的完整资源 ID。应提供 --id 或其他“资源 ID”参数。

--lock-duration

扫视锁的 ISO 8601 时间跨度持续时间;也就是说，为其他接收方锁定消息的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。

--max-delivery-count

最大传递计数。在传递数之后，消息会自动死机。默认值为 10。

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

主题可以接受的消息有效负载的最大大小（以知识库(KB) 为单位）。此属性仅在今天高级版中使用，默认值为 1024。

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

--name --queue-name -n

队列名称。

--namespace-name

命名空间名称。

--remove

从列表中删除属性或元素。示例：--remove property.list OR --remove propertyToRemove。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name> 配置默认组。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=。

--status

枚举消息实体状态的可能值。

接受的值: Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az servicebus queue

命令

az servicebus queue create

必需参数

可选参数

az servicebus queue delete

可选参数

az servicebus queue list

必需参数

可选参数

az servicebus queue show

可选参数

az servicebus queue update

可选参数

其他资源