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

az eventhubs eventhub consumer-group

参考

管理Azure 事件中心使用者组。

命令

名称	说明	类型	状态
az eventhubs eventhub consumer-group create	将事件中心使用者组创建为命名空间中的嵌套资源。	核心	GA
az eventhubs eventhub consumer-group delete	从指定的事件中心和资源组中删除使用者组。	核心	GA
az eventhubs eventhub consumer-group list	列出命名空间中的所有使用者组。如果命名空间中不存在使用者组，则返回空源。	核心	GA
az eventhubs eventhub consumer-group show	获取指定使用者组的说明。	核心	GA
az eventhubs eventhub consumer-group update	将事件中心使用者组更新为命名空间中的嵌套资源。	核心	GA

az eventhubs eventhub consumer-group create

编辑

将事件中心使用者组创建为命名空间中的嵌套资源。

az eventhubs eventhub consumer-group create --consumer-group-name
                                            --eventhub-name
                                            --namespace-name
                                            --resource-group
                                            [--user-metadata]

必需参数

--consumer-group-name --name -n

使用者组名称。

--eventhub-name

事件中心名称。

--namespace-name

命名空间名称。

--resource-group -g

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

可选参数

--user-metadata

用户元数据是一个占位符，用于存储最大长度为 1024 的用户定义字符串数据。例如，它可用于存储描述性数据，例如团队列表及其联系信息，还可以存储用户定义的配置设置。

全局参数

--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 eventhubs eventhub consumer-group delete

编辑

从指定的事件中心和资源组中删除使用者组。

az eventhubs eventhub consumer-group delete [--consumer-group-name]
                                            [--eventhub-name]
                                            [--ids]
                                            [--namespace-name]
                                            [--resource-group]
                                            [--subscription]

可选参数

--consumer-group-name --name -n

使用者组名称。

--eventhub-name

事件中心名称。

--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 eventhubs eventhub consumer-group list

编辑

列出命名空间中的所有使用者组。如果命名空间中不存在使用者组，则返回空源。

az eventhubs eventhub consumer-group list --eventhub-name
                                          --namespace-name
                                          --resource-group
                                          [--max-items]
                                          [--next-token]
                                          [--skip]
                                          [--top]

必需参数

--eventhub-name

事件中心名称。

--namespace-name

命名空间名称。

--resource-group -g

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

可选参数

--max-items

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

--next-token

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

--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 eventhubs eventhub consumer-group show

编辑

获取指定使用者组的说明。

az eventhubs eventhub consumer-group show [--consumer-group-name]
                                          [--eventhub-name]
                                          [--ids]
                                          [--namespace-name]
                                          [--resource-group]
                                          [--subscription]

可选参数

--consumer-group-name --name -n

使用者组名称。

--eventhub-name

事件中心名称。

--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 eventhubs eventhub consumer-group update

编辑

将事件中心使用者组更新为命名空间中的嵌套资源。

az eventhubs eventhub consumer-group update [--add]
                                            [--consumer-group-name]
                                            [--eventhub-name]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--ids]
                                            [--namespace-name]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--subscription]
                                            [--user-metadata]

可选参数

--add

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

--consumer-group-name --name -n

使用者组名称。

--eventhub-name

事件中心名称。

--force-string

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

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

--ids

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

--namespace-name

命名空间名称。

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

--user-metadata

全局参数

--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 eventhubs eventhub consumer-group

命令

az eventhubs eventhub consumer-group create

必需参数

可选参数

az eventhubs eventhub consumer-group delete

可选参数

az eventhubs eventhub consumer-group list

必需参数

可选参数

az eventhubs eventhub consumer-group show

可选参数

az eventhubs eventhub consumer-group update

可选参数

反馈

其他资源