通过

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

az eventgrid namespace client-group

  • 预览

Note

此参考是 Azure CLI（版本 2.51.0 或更高版本） 的 eventgrid 扩展的一部分。 该扩展会在首次运行 az eventgrid namespace client-group 命令时自动安装。 了解更多关于扩展的信息。

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

管理 eventgrid 命名空间客户端组。

命令

名称 说明 类型 Status
az eventgrid namespace client-group create

创建客户端组。

 Extension Preview
az eventgrid namespace client-group delete

删除现有客户端组。

 Extension Preview
az eventgrid namespace client-group list

列出命名空间下的所有客户端组。

 Extension Preview
az eventgrid namespace client-group show

显示客户端组。

 Extension Preview
az eventgrid namespace client-group update

更新客户端组。

 Extension Preview
az eventgrid namespace client-group wait

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

 Extension Preview

az eventgrid namespace client-group create

预览

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

创建客户端组。

az eventgrid namespace client-group create --client-group-name --name
                                           --namespace-name
                                           --resource-group
                                           [--description]
                                           [--group-query]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

示例

创建客户端组

az eventgrid namespace client-group create -g rg --namespace-name name -n client-group --group-query "attributes.floor=6"

必需参数

--client-group-name --name -n

客户端组名称。

--namespace-name

命名空间的名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--description

客户端组资源的说明。

属性 值
Parameter group: Properties Arguments
--group-query

客户端的分组查询。

属性 值
Parameter group: Properties Arguments
--no-wait

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

属性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az eventgrid namespace client-group delete

预览

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

删除现有客户端组。

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

示例

删除客户端组

az eventgrid namespace client-group delete -g rg --namespace-name name -n client-group

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-group-name --name -n

客户端组的名称。

属性 值
Parameter group: Resource Id Arguments
--ids

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

属性 值
Parameter group: Resource Id Arguments
--namespace-name

命名空间的名称。

属性 值
Parameter group: Resource Id Arguments
--no-wait

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

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

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

属性 值
默认值: False

az eventgrid namespace client-group list

预览

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

列出命名空间下的所有客户端组。

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

示例

列出客户端组

az eventgrid namespace client-group list -g rg --namespace-name name

必需参数

--namespace-name

命名空间的名称。

--resource-group -g

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 参数中提供令牌值。

属性 值
Parameter group: Pagination Arguments
--next-token

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

属性 值
Parameter group: Pagination Arguments
--top

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

全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

属性 值
默认值: False

az eventgrid namespace client-group show

预览

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

显示客户端组。

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

示例

显示客户端组

az eventgrid namespace client-group show -g rg --namespace-name name -n client-group

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-group-name --name -n

客户端组的名称。

属性 值
Parameter group: Resource Id Arguments
--ids

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

属性 值
Parameter group: Resource Id Arguments
--namespace-name

命名空间的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

属性 值
默认值: False

az eventgrid namespace client-group update

预览

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

更新客户端组。

az eventgrid namespace client-group update [--add]
                                           [--client-group-name --name]
                                           [--description]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--group-query]
                                           [--ids]
                                           [--namespace-name]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]

示例

更新客户端组

az eventgrid namespace client-group update -g rg --namespace-name name -n client-group --description test

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

属性 值
Parameter group: Generic Update Arguments
--client-group-name --name -n

客户端组的名称。

属性 值
Parameter group: Resource Id Arguments
--description

客户端组资源的说明。

属性 值
Parameter group: Properties Arguments
--force-string

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

属性 值
Parameter group: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--group-query

客户端的分组查询。

属性 值
Parameter group: Properties Arguments
--ids

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

属性 值
Parameter group: Resource Id Arguments
--namespace-name

命名空间的名称。

属性 值
Parameter group: Resource Id Arguments
--no-wait

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

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

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

属性 值
Parameter group: Generic Update Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--set

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

属性 值
Parameter group: Generic Update Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

属性 值
默认值: False

az eventgrid namespace client-group wait

预览

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

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

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--client-group-name --name -n

客户端组的名称。

属性 值
Parameter group: Resource Id Arguments
--created

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

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--custom

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

属性 值
Parameter group: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--ids

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

属性 值
Parameter group: Resource Id Arguments
--interval

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

属性 值
Parameter group: Wait Condition Arguments
默认值: 30
--namespace-name

命名空间的名称。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

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

属性 值
Parameter group: Resource Id Arguments
--subscription

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

属性 值
Parameter group: Resource Id Arguments
--timeout

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

属性 值
Parameter group: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
全局参数
--debug

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

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

输出格式。

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

属性 值
默认值: False