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

az eventgrid namespace client

预览
参考

注意

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

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

管理 eventgrid 命名空间客户端。

命令

名称	说明	类型	Status
az eventgrid namespace client create	创建客户端。	分机	预览
az eventgrid namespace client delete	删除现有客户端。	扩展	预览版
az eventgrid namespace client list	列出命名空间下的所有客户端。	分机	预览版
az eventgrid namespace client show	显示客户端。	分机	预览版
az eventgrid namespace client update	更新客户端。	分机	预览版
az eventgrid namespace client wait	将 CLI 置于等待状态，直到满足条件。	扩展	预览

az eventgrid namespace client create

预览

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

创建客户端。

az eventgrid namespace client create --client-name
                                     --namespace-name
                                     --resource-group
                                     [--attributes]
                                     [--authentication]
                                     [--authentication-name]
                                     [--client-certificate-authentication]
                                     [--description]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--state {Disabled, Enabled}]

示例

创建客户端

az eventgrid namespace client create -g rg --namespace-name name -n client-name  --attributes "{'room':'345','floor':5}" --client-certificate-authentication "{validationScheme:SubjectMatchesAuthenticationName}"

必需参数

--client-name --name -n

客户端名称。

--namespace-name

命名空间的名称。

--resource-group -g

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

可选参数

--attributes

客户端的属性。支持 json-file 和 yaml-file。

--authentication

客户端的身份验证信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--authentication-name

客户端提供用于身份验证的名称。默认值为资源的名称。

--client-certificate-authentication

客户端证书身份验证信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--description

客户端资源的说明。

--no-wait

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

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

--state

指示客户端是否处于启用状态。默认值为“已启用”。

接受的值: Disabled, Enabled

默认值: Enabled

全局参数

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

预览

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

删除现有客户端。

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

示例

删除客户端

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

可选参数

--client-name --name -n

客户端的名称。

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

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

预览

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

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

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

示例

列出客户端

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

必需参数

--namespace-name

命名空间的名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<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 client show

预览

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

显示客户端。

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

示例

显示客户端

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

可选参数

--client-name --name -n

客户端的名称。

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

全局参数

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

预览

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

更新客户端。

az eventgrid namespace client update [--add]
                                     [--attributes]
                                     [--authentication]
                                     [--client-certificate-authentication]
                                     [--client-name]
                                     [--description]
                                     [--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]
                                     [--state {Disabled, Enabled}]
                                     [--subscription]

示例

更新客户端

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

可选参数

--add

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

--attributes

客户端的属性。支持 json-file 和 yaml-file。

--authentication

客户端的身份验证信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--client-certificate-authentication

客户端证书身份验证信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--client-name --name -n

客户端的名称。

--description

客户端资源的说明。

--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=。

--state

指示客户端是否处于启用状态。默认值为“已启用”。

接受的值: Disabled, Enabled

--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 eventgrid namespace client wait

预览

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

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

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

可选参数

--client-name --name -n

客户端的名称。

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

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

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

通过

az eventgrid namespace client

命令

az eventgrid namespace client create

示例

必需参数

可选参数

az eventgrid namespace client delete

示例

可选参数

az eventgrid namespace client list

示例

必需参数

可选参数

az eventgrid namespace client show

示例

可选参数

az eventgrid namespace client update

示例

可选参数

az eventgrid namespace client wait

可选参数

其他资源