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

az servicebus topic subscription

参考

Servicebus 主题订阅。

命令

名称	说明	类型	状态
az servicebus topic subscription create	创建主题订阅。	核心	GA
az servicebus topic subscription delete	从指定主题中删除订阅。	核心	GA
az servicebus topic subscription list	列出指定主题下的所有订阅。	核心	GA
az servicebus topic subscription rule	Servicebus 主题订阅规则。	核心	GA
az servicebus topic subscription rule create	为订阅创建 ServiceBus 规则。	核心	GA
az servicebus topic subscription rule delete	删除现有规则。	核心	GA
az servicebus topic subscription rule list	列出给定主题订阅中的所有规则。	核心	GA
az servicebus topic subscription rule show	获取指定规则的说明。	核心	GA
az servicebus topic subscription rule update	更新新规则并更新现有规则。	核心	GA
az servicebus topic subscription show	获取指定主题的订阅说明。	核心	GA
az servicebus topic subscription update	更新主题订阅。	核心	GA

az servicebus topic subscription create

编辑

创建主题订阅。

az servicebus topic subscription create --name
                                        --namespace-name
                                        --resource-group
                                        --topic-name
                                        [--auto-delete-on-idle]
                                        [--client-id]
                                        [--dead-letter-on-filter-exceptions {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--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-session {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--forward-dead-lettered-messages-to]
                                        [--forward-to]
                                        [--is-client-affine {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--is-durable {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--is-shared {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--lock-duration]
                                        [--max-delivery-count]
                                        [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]

必需参数

--name --subscription-name -n

订阅名称。

--namespace-name

命名空间名称。

--resource-group -g

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

--topic-name

主题名称。

可选参数

--auto-delete-on-idle

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

--client-id

指示创建客户端-affine 订阅的应用程序的客户端 ID。

--dead-letter-on-filter-exceptions -f

指示订阅是否对筛选器评估异常具有死信支持的值。

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

--default-message-time-to-live

ISO 8061 默认消息时间跨度为实时值。这是消息过期的持续时间，从消息发送到服务总线时开始。这是未在消息本身上设置 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-session

一个值，该值指示队列是否支持会话的概念。

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

--forward-dead-lettered-messages-to

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

--forward-to

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

--is-client-affine

指示订阅是否具有客户端 ID 的相关性的值。

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

--is-durable

对于客户端-affine 订阅，此值指示订阅是否持久。

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

--is-shared

对于客户端-affine 订阅，此值指示是否共享订阅。

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

--lock-duration

订阅的 ISO 8061 锁定持续时间时间跨度。默认值为 1 分钟。

--max-delivery-count

最大交付次数。

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

编辑

从指定主题中删除订阅。

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

可选参数

--ids

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

--name --subscription-name -n

订阅名称。

--namespace-name

命名空间名称。

--resource-group -g

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

--subscription

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

--topic-name

主题名称。

全局参数

--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 topic subscription list

编辑

列出指定主题下的所有订阅。

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

必需参数

--namespace-name

命名空间名称。

--resource-group -g

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

--topic-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 topic subscription show

编辑

获取指定主题的订阅说明。

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

可选参数

--ids

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

--name --subscription-name -n

订阅名称。

--namespace-name

命名空间名称。

--resource-group -g

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

--subscription

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

--topic-name

主题名称。

全局参数

--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 topic subscription update

编辑

更新主题订阅。

az servicebus topic subscription update [--add]
                                        [--auto-delete-on-idle]
                                        [--client-id]
                                        [--dead-letter-on-filter-exceptions {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--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-session {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]
                                        [--is-client-affine {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--is-durable {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--is-shared {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--lock-duration]
                                        [--max-delivery-count]
                                        [--name]
                                        [--namespace-name]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--status {Active, Creating, Deleting, Disabled, ReceiveDisabled, Renaming, Restoring, SendDisabled, Unknown}]
                                        [--subscription]
                                        [--topic-name]

可选参数

--add

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

--auto-delete-on-idle

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

--client-id

指示创建客户端-affine 订阅的应用程序的客户端 ID。

--dead-letter-on-filter-exceptions -f

指示订阅是否对筛选器评估异常具有死信支持的值。

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

--default-message-time-to-live

ISO 8061 默认消息时间跨度为实时值。这是消息过期的持续时间，从消息发送到服务总线时开始。这是未在消息本身上设置 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-session

一个值，该值指示队列是否支持会话的概念。

接受的值: 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”参数。

--is-client-affine

指示订阅是否具有客户端 ID 的相关性的值。

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

--is-durable

对于客户端-affine 订阅，此值指示订阅是否持久。

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

--is-shared

对于客户端-affine 订阅，此值指示是否共享订阅。

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

--lock-duration

订阅的 ISO 8061 锁定持续时间时间跨度。默认值为 1 分钟。

--max-delivery-count

最大交付次数。

--name --subscription-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 配置默认订阅。

--topic-name

主题名称。

全局参数

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

命令

az servicebus topic subscription create

必需参数

可选参数

az servicebus topic subscription delete

可选参数

az servicebus topic subscription list

必需参数

可选参数

az servicebus topic subscription show

可选参数

az servicebus topic subscription update

可选参数

反馈

其他资源