Share via


az confluent organization environment schema-registry-cluster

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 schema-registry-cluster command. Learn more about extensions.

Retrieve details of Schema Registry clusters within a Confluent environment.

Commands

Name Description Type Status
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 schema-registry-cluster list

List all Schema Registry clusters within a Confluent environment.

az confluent organization environment schema-registry-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 -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
--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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az confluent organization environment schema-registry-cluster show

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-id

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

Property Value
Parameter group: Resource Id Arguments
--environment-id

Confluent environment id.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--organization-name

Organization resource name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False