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

az servicebus topic subscription rule

Servicebus 主题订阅规则。

命令

名称	说明	类型	Status
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 rule create

为订阅创建 ServiceBus 规则。

az servicebus topic subscription rule create --name
                                             --namespace-name
                                             --resource-group
                                             --subscription-name
                                             --topic-name
                                             [--action-compatibility-level]
                                             [--action-sql-expression]
                                             [--content-type]
                                             [--correlation-filter]
                                             [--correlation-id]
                                             [--enable-action-preprocessing {false, true}]
                                             [--enable-correlation-preprocessing {false, true}]
                                             [--enable-sql-preprocessing {false, true}]
                                             [--filter-sql-expression]
                                             [--filter-type {CorrelationFilter, SqlFilter}]
                                             [--label]
                                             [--message-id]
                                             [--no-wait]
                                             [--reply-to]
                                             [--reply-to-session-id]
                                             [--session-id]
                                             [--to]

示例

创建规则。

az servicebus topic subscription rule create --resource-group myresourcegroup --namespace-name mynamespace --topic-name mytopic --subscription-name mysubscription --name myrule --filter-sql-expression myproperty=myvalue

必需参数

--name -n

规则的名称。

--namespace-name

命名空间的名称。

--resource-group -g

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

--subscription-name

订阅的名称。

--topic-name

主题的名称。

可选参数

--action-compatibility-level

此属性保留供将来使用。 显示兼容级别的整数值，当前硬编码为 20。

--action-sql-expression

操作 SQL 表达式。

--content-type

消息的内容类型。

--correlation-filter --correlation-filter-property

自定义筛选器的字典对象。

--correlation-id

关联标识符。

--enable-action-preprocessing

一个布尔值，该值指示规则操作是否需要预处理。

接受的值: false, true

--enable-correlation-preprocessing

一个布尔值，该值指示规则操作是否需要预处理。

接受的值: false, true

--enable-sql-preprocessing

一个布尔值，该值指示规则操作是否需要预处理。

接受的值: false, true

--filter-sql-expression

SQL 表达式。 例如 myproperty=test。

--filter-type

规则筛选器类型。

接受的值: CorrelationFilter, SqlFilter

--label

应用程序特定的标签。

--message-id

消息的标识符。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--reply-to

要回复的队列地址。

--reply-to-session-id

要答复的会话标识符。

--session-id

会话标识符。

--to

要发送到的地址。

全局参数

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

删除现有规则。

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

可选参数

--ids

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

--name --rule-name -n

规则名称。

--namespace-name

命名空间名称。

--resource-group -g

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

--subscription

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

--subscription-name

订阅名称。

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

列出给定主题订阅中的所有规则。

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

必需参数

--namespace-name

命名空间名称。

--resource-group -g

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

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

获取指定规则的说明。

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

可选参数

--ids

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

--name --rule-name -n

规则名称。

--namespace-name

命名空间名称。

--resource-group -g

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

--subscription

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

--subscription-name

订阅名称。

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

更新新规则并更新现有规则。

az servicebus topic subscription rule update [--action-compatibility-level]
                                             [--action-preprocessing {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--action-sql-expression]
                                             [--add]
                                             [--compatibility-level]
                                             [--content-type]
                                             [--correlation-id]
                                             [--enable-correlation-preprocessing {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--enable-sql-preprocessing {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--filter-sql-expression]
                                             [--filter-type {CorrelationFilter, SqlFilter}]
                                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--ids]
                                             [--label]
                                             [--message-id]
                                             [--name]
                                             [--namespace-name]
                                             [--properties]
                                             [--remove]
                                             [--reply-to]
                                             [--reply-to-session-id]
                                             [--resource-group]
                                             [--session-id]
                                             [--set]
                                             [--subscription]
                                             [--subscription-name]
                                             [--to]
                                             [--topic-name]

可选参数

--action-compatibility-level

此属性保留供将来使用。 显示兼容级别的整数值，当前硬编码为 20。

--action-preprocessing --enable-action-preprocessing

指示规则操作是否需要预处理的值。

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

--action-sql-expression

SQL 表达式。 例如 MyProperty='ABC'。

--add

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

--compatibility-level

此属性保留供将来使用。 显示兼容级别的整数值，当前硬编码为 20。

--content-type

消息的内容类型。

--correlation-id

相关性标识符。

--enable-correlation-preprocessing --requires-preprocessing

指示规则操作是否需要预处理的值。

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

--enable-sql-preprocessing -f

指示规则操作是否需要预处理的值。

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

--filter-sql-expression --sql-expression

SQL 表达式。 例如 MyProperty='ABC'。

--filter-type

根据 BrokeredMessage 计算的筛选器类型。

接受的值: CorrelationFilter, SqlFilter

--force-string

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

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

--ids

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

--label

应用程序特定的标签。

--message-id

消息的标识符。

--name --rule-name -n

规则名称。

--namespace-name

命名空间名称。

--properties

自定义筛选器的字典对象支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--remove

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

--reply-to

要回复的队列地址。

--reply-to-session-id

要答复的会话标识符。

--resource-group -g

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

--session-id

会话标识符。

--set

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

--subscription

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

--subscription-name

订阅名称。

--to

要发送到的地址。

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