az confluent organization environment cluster

Note

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

Command to get the confluent cluster details in a environment.

Commands

Name	Description	Type	Status
az confluent organization environment cluster create-api-key	Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment.	Extension	GA
az confluent organization environment cluster list	List of all the clusters in a environment.	Extension	GA
az confluent organization environment cluster show	Get cluster by Id.	Extension	GA

az confluent organization environment cluster create-api-key

Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment.

az confluent organization environment cluster create-api-key [--cluster-id]
                                                             [--description]
                                                             [--environment-id]
                                                             [--ids]
                                                             [--name]
                                                             [--organization-name]
                                                             [--resource-group]
                                                             [--subscription]

Optional Parameters

--cluster-id

Confluent kafka or schema registry cluster id.

--description

Description of the API Key.

--environment-id

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.

--name

Name of the API Key.

--organization-name

Organization resource name.

--resource-group

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

az confluent organization environment cluster list

List of all the clusters in a environment.

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

Required Parameters

--environment-id

Confluent environment id.

--organization-name

Organization resource name.

--resource-group

Resource 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 cluster show

Get cluster by Id.

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

Optional Parameters

--cluster-id

Confluent kafka or schema registry cluster id prefixed with lkc or lks.

--environment-id

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

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