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

az eventgrid namespace topic event-subscription

  • 预览
  • 参考

注意

此参考是 Azure CLI（版本 2.51.0 或更高版本）的 eventgrid 扩展的一部分。 该扩展将在首次运行 az eventgrid namespace topic event-subscription 命令时自动安装。 详细了解扩展。

命令组“az eventgrid namespace topic”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

管理 eventgrid 命名空间主题事件订阅。

命令

名称 说明 类型 状态
az eventgrid namespace topic event-subscription create

创建命名空间主题的事件订阅。

 分机 预览
az eventgrid namespace topic event-subscription delete

删除命名空间主题的现有事件订阅。

 分机 预览
az eventgrid namespace topic event-subscription list

列出属于特定命名空间主题的事件订阅。

 分机 预览
az eventgrid namespace topic event-subscription show

显示命名空间主题的事件订阅。

 分机 预览
az eventgrid namespace topic event-subscription update

更新命名空间主题的事件订阅。

 扩展 预览版
az eventgrid namespace topic event-subscription wait

将 CLI 置于等待状态，直到满足条件。

 扩展 预览版

az eventgrid namespace topic event-subscription create

预览

命令组“az eventgrid namespace topic event-subscription”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

创建命名空间主题的事件订阅。

az eventgrid namespace topic event-subscription create --event-subscription-name
                                                       --namespace-name
                                                       --resource-group
                                                       --topic-name
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--filters-configuration]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

示例

创建事件订阅

az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --delivery-configuration "{deliveryMode:Queue,queue:{receiveLockDurationInSeconds:60,maxDeliveryCount:4,eventTimeToLive:P1D}}"

必需参数

--event-subscription-name --name -n

要创建的事件订阅的名称。 事件订阅名称长度必须介于 3 到 100 个字符之间，并且仅使用字母数字字母。

--namespace-name

命名空间的名称。

--resource-group -g

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

--topic-name

命名空间主题的名称。

可选参数

--delivery-configuration

有关事件订阅的传递配置的信息。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--event-delivery-schema

事件订阅的事件传送架构。

接受的值: CloudEventSchemaV1_0
--filters-configuration

有关事件订阅筛选器的信息。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--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 eventgrid namespace topic event-subscription delete

预览

命令组“az eventgrid namespace topic event-subscription”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

删除命名空间主题的现有事件订阅。

az eventgrid namespace topic event-subscription delete [--event-subscription-name]
                                                       [--ids]
                                                       [--namespace-name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--subscription]
                                                       [--topic-name]
                                                       [--yes]

示例

删除事件订阅

az eventgrid namespace topic event-subscription delete -g rg --topic-name topic -n event-subscription --namespace-name name

可选参数

--event-subscription-name --name -n

要创建的事件订阅的名称。 事件订阅名称长度必须介于 3 到 100 个字符之间，并且仅使用字母数字字母。

--ids

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

--namespace-name

命名空间的名称。

--no-wait

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

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

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

--subscription

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

--topic-name

命名空间主题的名称。

--yes -y

不提示确认。

默认值: False
全局参数
--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 eventgrid namespace topic event-subscription list

预览

命令组“az eventgrid namespace topic event-subscription”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

列出属于特定命名空间主题的事件订阅。

az eventgrid namespace topic event-subscription list --namespace-name
                                                     --resource-group
                                                     --topic-name
                                                     [--filter]
                                                     [--max-items]
                                                     [--next-token]
                                                     [--top]

示例

列出事件订阅

az eventgrid namespace topic event-subscription list -g rg --topic-name topic --namespace-name name

必需参数

--namespace-name

命名空间的名称。

--resource-group -g

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

--topic-name

命名空间主题的名称。

可选参数

--filter

用于使用 OData 语法筛选搜索结果的查询。 仅允许对“name”属性进行筛选，并且 OData 操作数量有限。 这些操作包括：“contains”函数以及以下逻辑操作：not、or， or， eq （for equal）和 ne （对于不相等）。 不支持算术运算。 下面是有效的筛选器示例：$filter=contains（namE、'PATTERN'）和名称 ne 'PATTERN-1'。 下面是无效的筛选器示例：$filter=location eq 'westus'。

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

--top

要为列表操作返回每页的结果数。 顶部参数的有效范围为 1 到 100。 如果未指定，则返回的默认结果数是每页 20 个项目。

全局参数
--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 eventgrid namespace topic event-subscription show

预览

命令组“az eventgrid namespace topic event-subscription”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

显示命名空间主题的事件订阅。

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

示例

显示事件订阅

az eventgrid namespace topic event-subscription show -g rg --topic-name topic -n event-subscription --namespace-name name

可选参数

--event-subscription-name --name -n

要创建的事件订阅的名称。 事件订阅名称长度必须介于 3 到 100 个字符之间，并且仅使用字母数字字母。

--ids

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

--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 eventgrid namespace topic event-subscription update

预览

命令组“az eventgrid namespace topic event-subscription”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

更新命名空间主题的事件订阅。

az eventgrid namespace topic event-subscription update [--add]
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--event-subscription-name]
                                                       [--filters-configuration]
                                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--ids]
                                                       [--namespace-name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--remove]
                                                       [--resource-group]
                                                       [--set]
                                                       [--subscription]
                                                       [--topic-name]

示例

更新事件订阅

az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --filters-configuration "{includedEventTypes:['All']}"

可选参数

--add

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

--delivery-configuration

有关事件订阅的传递配置的信息。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--event-delivery-schema

事件订阅的事件传送架构。

接受的值: CloudEventSchemaV1_0
--event-subscription-name --name -n

要创建的事件订阅的名称。 事件订阅名称长度必须介于 3 到 100 个字符之间，并且仅使用字母数字字母。

--filters-configuration

有关事件订阅筛选器的信息。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--force-string

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

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

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

--namespace-name

命名空间的名称。

--no-wait

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

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

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

--resource-group -g

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

--set

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

--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 eventgrid namespace topic event-subscription wait

预览

命令组“az eventgrid namespace topic event-subscription”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

将 CLI 置于等待状态，直到满足条件。

az eventgrid namespace topic event-subscription wait [--created]
                                                     [--custom]
                                                     [--deleted]
                                                     [--event-subscription-name]
                                                     [--exists]
                                                     [--ids]
                                                     [--interval]
                                                     [--namespace-name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--timeout]
                                                     [--topic-name]
                                                     [--updated]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--event-subscription-name --name -n

要创建的事件订阅的名称。 事件订阅名称长度必须介于 3 到 100 个字符之间，并且仅使用字母数字字母。

--exists

等待资源存在。

默认值: False
--ids

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

--interval

轮询间隔（以秒为单位）。

默认值: 30
--namespace-name

命名空间的名称。

--resource-group -g

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

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600
--topic-name

命名空间主题的名称。

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
全局参数
--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 获取完整的调试日志。