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

az confluent organization

注意

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

用于对串联组织执行操作的命令。

命令

名称	说明	类型	Status
az confluent organization api-key	管理群集 API 密钥。	扩展	GA
az confluent organization api-key delete	删除 kafka 或架构注册表群集的 API 密钥。	扩展	GA
az confluent organization create	创建组织资源。	扩展	GA
az confluent organization create-role-binding	组织角色绑定。	扩展	GA
az confluent organization create-user	邀请用户加入组织。	扩展	GA
az confluent organization delete	删除组织资源。	扩展	GA
az confluent organization environment	用于获取组织中的串联环境的命令。	扩展	GA
az confluent organization environment cluster	用于获取环境中的串联群集详细信息的命令。	扩展	GA
az confluent organization environment cluster create-api-key	为环境中的架构注册表群集 ID 或 Kafka 群集 ID 创建 API 密钥。	扩展	GA
az confluent organization environment cluster list	环境中所有群集的列表。	扩展	GA
az confluent organization environment cluster show	按 ID 获取群集。	扩展	GA
az confluent organization environment list	列出组织中的所有环境。	扩展	GA
az confluent organization environment schema-registry-cluster	用于获取环境中的架构注册表群集详细信息的命令。	扩展	GA
az confluent organization environment schema-registry-cluster list	列出架构注册表群集。	扩展	GA
az confluent organization environment schema-registry-cluster show	按 ID 获取架构注册表群集。	扩展	GA
az confluent organization list	列出指定资源组下的所有组织。 并列出指定订阅下的所有组织。	扩展	GA
az confluent organization list-role-binding	组织角色绑定。	扩展	GA
az confluent organization list-service-accounts	组织服务帐户详细信息。	扩展	GA
az confluent organization list-users	组织用户详细信息。	扩展	GA
az confluent organization role-binding	管理角色绑定。	扩展	GA
az confluent organization role-binding delete	删除角色绑定。	扩展	GA
az confluent organization show	获取特定组织资源的属性。	扩展	GA
az confluent organization update	更新组织资源。	扩展	GA
az confluent organization wait	将 CLI 置于等待状态，直到满足连接组织的条件。	扩展	GA

az confluent organization create

创建组织资源。

az confluent organization create --name
                                 --plan-id
                                 --plan-name
                                 --resource-group
                                 --term-unit
                                 [--location]
                                 [--no-wait]
                                 [--offer-id]
                                 [--publisher-id]
                                 [--tags]

示例

创建组织

az confluent organization create --location "West US" --tags Environment="Dev" --name "myOrganization" --resource-group "myResourceGroup" --offer-id "confluent-cloud-azure-prod" --plan-id "confluent-cloud-azure-payg-prod" --plan-name "Confluent Cloud - Pay as you Go" --publisher-id "confluentinc" --term-unit "P1M"

必需参数

--name --organization-name -n

组织资源名称。

--plan-id

套餐计划 ID。

--plan-name

产品/服务计划名称。

--resource-group -g

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

--term-unit

产品/服务计划期限单位。

可选参数

--location -l

位置。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--no-wait

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

默认值: False

--offer-id

产品/服务 ID。

默认值: confluent-cloud-azure-prod

--publisher-id

发布者 ID。

默认值: confluentinc

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--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 confluent organization create-role-binding

组织角色绑定。

az confluent organization create-role-binding [--crn-pattern]
                                              [--ids]
                                              [--organization-name]
                                              [--principal]
                                              [--resource-group]
                                              [--role-name]
                                              [--subscription]

可选参数

--crn-pattern

一个 CRN，指定角色绑定所需的范围和资源模式。

--ids

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

--organization-name

组织资源名称。

--principal

要将角色绑定到的主体用户或组。

--resource-group

资源组名称。

--role-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 confluent organization create-user

邀请用户加入组织。

az confluent organization create-user [--auth-type]
                                      [--email]
                                      [--ids]
                                      [--invited-email]
                                      [--organization-id]
                                      [--organization-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--upn]

可选参数

--auth-type

用户的身份验证类型。

--email

已登录用户的电子邮件。

--ids

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

--invited-email

正在邀请的用户的 UPN/电子邮件。

--organization-id

组织的 ID。

--organization-name

组织资源名称。

--resource-group -g

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

--subscription

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

--upn

已登录用户的 Upn。

全局参数

--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 confluent organization delete

删除组织资源。

az confluent organization delete [--ids]
                                 [--name]
                                 [--no-wait]
                                 [--resource-group]
                                 [--subscription]
                                 [--yes]

示例

删除组织

az confluent organization delete --name "myOrganization" --resource-group "myResourceGroup"

使用 ID 删除组织

az confluent organization delete --ids "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Confluent/organizations/{myOrganization}"

可选参数

--ids

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

--name --organization-name -n

组织资源名称。

--no-wait

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

默认值: False

--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

全局参数

--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 confluent organization list

列出指定资源组下的所有组织。 并列出指定订阅下的所有组织。

az confluent organization list [--resource-group]

示例

Organization_ListByResourceGroup

az confluent organization list --resource-group "myResourceGroup"

Organization_ListBySubscription

az confluent organization list

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<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 confluent organization list-role-binding

组织角色绑定。

az confluent organization list-role-binding [--ids]
                                            [--organization-name]
                                            [--resource-group]
                                            [--search-filters]
                                            [--subscription]

可选参数

--ids

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

--organization-name

组织资源名称。

--resource-group

资源组名称。

--search-filters

搜索请求支持速记语法、json-file 和 yaml-file 的筛选器。 请尝试“？？” 以显示更多内容。

--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 confluent organization list-service-accounts

组织服务帐户详细信息。

az confluent organization list-service-accounts [--ids]
                                                [--organization-name]
                                                [--resource-group]
                                                [--search-filters]
                                                [--subscription]

可选参数

--ids

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

--organization-name

组织资源名称。

--resource-group

资源组名称。

--search-filters

搜索请求支持速记语法、json-file 和 yaml-file 的筛选器。 请尝试“？？” 以显示更多内容。

--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 confluent organization list-users

组织用户详细信息。

az confluent organization list-users [--ids]
                                     [--organization-name]
                                     [--resource-group]
                                     [--search-filters]
                                     [--subscription]

可选参数

--ids

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

--organization-name

组织资源名称。

--resource-group

资源组名称。

--search-filters

搜索请求支持速记语法、json-file 和 yaml-file 的筛选器。 请尝试“？？” 以显示更多内容。

--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 confluent organization show

获取特定组织资源的属性。

az confluent organization show [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

示例

显示组织

az confluent organization show --name "myOrganization" --resource-group "myResourceGroup"

使用 ID 显示组织

az confluent organization show --ids "/subscriptions/{SubID}/resourceGroups/{ResourceGroup}/providers/Microsoft.Confluent/organizations/{myOrganization}"

可选参数

--ids

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

--name --organization-name -n

组织资源名称。

--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 confluent organization update

更新组织资源。

az confluent organization update [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--tags]

示例

Confluent_Update

az confluent organization update --tags client="dev-client" env="dev" --name "myOrganization" --resource-group "myResourceGroup"

可选参数

--ids

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

--name --organization-name -n

组织资源名称。

--resource-group -g

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

--subscription

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

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--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 confluent organization wait

将 CLI 置于等待状态，直到满足连接组织的条件。

az confluent organization wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]

示例

暂停执行下一行 CLI 脚本，直到成功创建 confluent 组织。

az confluent organization wait --name "myOrganization" --resource-group "myResourceGroup" --created

暂停执行下一行 CLI 脚本，直到成功删除连接组织。

az confluent organization wait --name "myOrganization" --resource-group "myResourceGroup" --deleted

可选参数

--created

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

默认值: False

--custom

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

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

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

默认值: 30

--name --organization-name -n

组织资源名称。

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