Share via


az confluent organization environment

Note

This reference is part of the confluent extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az confluent organization environment command. Learn more about extensions.

Commands to get the confluent environments in the organization.

Commands

Name Description Type Status
az confluent organization environment cluster

Command to get the confluent cluster details in a environment.

Extension GA
az confluent organization environment cluster create-api-key

Create API keys for Schema Registry or Kafka clusters within an environment.

Extension GA
az confluent organization environment cluster list

List all clusters within a specific Confluent environment.

Extension GA
az confluent organization environment cluster show

Retrieve details of a specific Confluent cluster by its ID.

Extension GA
az confluent organization environment list

List all Confluent environments within a specific organization.

Extension GA
az confluent organization environment schema-registry-cluster

Retrieve details of Schema Registry clusters within a Confluent environment.

Extension GA
az confluent organization environment schema-registry-cluster list

List all Schema Registry clusters within a Confluent environment.

Extension GA
az confluent organization environment schema-registry-cluster show

Retrieve details of a specific Schema Registry cluster by its ID.

Extension GA
az confluent organization environment show

Display details of a specific Confluent environment within an organization.

Extension GA

az confluent organization environment list

List all Confluent environments within a specific organization.

az confluent organization environment list --organization-name
                                           --resource-group
                                           [--max-items]
                                           [--next-token]
                                           [--page-size]
                                           [--page-token]

Required Parameters

--organization-name

Organization resource name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--page-size

Pagination size.

--page-token

An opaque pagination token to fetch the next set of records.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az confluent organization environment show

Display details of a specific Confluent environment within an organization.

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

Optional Parameters

--environment-id --name -n

Confluent environment id.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--organization-name

Organization resource name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.