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

az servicebus topic

Servicebus 主题。

命令

名称	说明	类型	状态
az servicebus topic authorization-rule	Servicebus 主题授权规则。	核心	GA
az servicebus topic authorization-rule create	为指定主题创建授权规则。	核心	GA
az servicebus topic authorization-rule delete	删除主题授权规则。	核心	GA
az servicebus topic authorization-rule keys	Servicebus 主题授权规则密钥。	核心	GA
az servicebus topic authorization-rule keys list	获取主题的主要和辅助连接字符串。	核心	GA
az servicebus topic authorization-rule keys renew	重新生成主题的主或辅助连接字符串。	核心	GA
az servicebus topic authorization-rule list	列出主题的授权规则。	核心	GA
az servicebus topic authorization-rule show	获取指定的授权规则。	核心	GA
az servicebus topic authorization-rule update	更新指定主题的授权规则。	核心	GA
az servicebus topic create	在指定的命名空间中创建主题。	核心	GA
az servicebus topic delete	从指定的命名空间和资源组中删除主题。	核心	GA
az servicebus topic list	列出命名空间中的所有主题。	核心	GA
az servicebus topic show	获取指定主题的说明。	核心	GA
az servicebus topic subscription	Servicebus 主题订阅。	核心	GA
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 update	更新指定命名空间中的主题。	核心	GA

az servicebus topic create

在指定的命名空间中创建主题。

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

必需参数

--name --topic-name -n

主题名称。

--namespace-name

命名空间名称。

--resource-group -g

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

可选参数

--auto-delete-on-idle

ISO 8601 时间跨度空闲间隔后，主题会自动删除。 最短持续时间为 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-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-message-size-in-kilobytes

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

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

主题的最大大小（以兆字节为单位），即为主题分配的内存大小。 默认值为 1024。

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

从指定的命名空间和资源组中删除主题。

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

可选参数

--ids

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

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

列出命名空间中的所有主题。

az servicebus topic 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 topic show

获取指定主题的说明。

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

可选参数

--ids

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

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

更新指定命名空间中的主题。

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]

可选参数

--add

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

--auto-delete-on-idle

ISO 8601 时间跨度空闲间隔后，主题会自动删除。 最短持续时间为 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-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

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

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

--ids

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

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

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

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

主题的最大大小（以兆字节为单位），即为主题分配的内存大小。 默认值为 1024。

--name --topic-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 获取完整的调试日志。