az aro hcp

Preview

Note

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

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure Red Hat OpenShift with hosted control plane resource types.

Commands

Name	Description	Type	Status
az aro hcp cluster	Manage Azure Red Hat OpenShift with hosted control plane clusters.	Extension	Preview
az aro hcp cluster create	Create an Azure Red Hat OpenShift with hosted control plane cluster.	Extension	Preview
az aro hcp cluster delete	Delete an Azure Red Hat OpenShift with hosted control plane cluster.	Extension	Preview
az aro hcp cluster external-auth	Manage Azure Red Hat OpenShift with hosted control plane external authentication.	Extension	Preview
az aro hcp cluster external-auth create	Create an Azure Red Hat OpenShift with hosted control plane external authentication instance.	Extension	Preview
az aro hcp cluster external-auth delete	Delete an Azure Red Hat OpenShift with hosted control plane external authentication instance.	Extension	Preview
az aro hcp cluster external-auth list	List Azure Red Hat OpenShift with hosted control plane external authentication instances.	Extension	Preview
az aro hcp cluster external-auth show	Get an Azure Red Hat OpenShift with hosted control plane external authentication instance.	Extension	Preview
az aro hcp cluster external-auth update	Update an Azure Red Hat OpenShift with hosted control plane external authentication instance.	Extension	Preview
az aro hcp cluster external-auth wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az aro hcp cluster list	List Azure Red Hat OpenShift with hosted control plane clusters.	Extension	Preview
az aro hcp cluster nodepool	Manage Azure Red Hat OpenShift with hosted control plane node pools.	Extension	Preview
az aro hcp cluster nodepool create	Create an Azure Red Hat OpenShift with hosted control plane node pool.	Extension	Preview
az aro hcp cluster nodepool delete	Delete an Azure Red Hat OpenShift with hosted control plane node pool.	Extension	Preview
az aro hcp cluster nodepool list	List Azure Red Hat OpenShift with hosted control plane node pools.	Extension	Preview
az aro hcp cluster nodepool show	Get an Azure Red Hat OpenShift with hosted control plane node pool.	Extension	Preview
az aro hcp cluster nodepool update	Update an Azure Red Hat OpenShift with hosted control plane node pool.	Extension	Preview
az aro hcp cluster nodepool wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az aro hcp cluster request-credential	Request a temporary credential for your Azure Red Hat OpenShift with hosted control plane cluster.	Extension	Preview
az aro hcp cluster revoke-credential	Revoke all credentials for your Azure Red Hat OpenShift with hosted control plane cluster.	Extension	Preview
az aro hcp cluster show	Get an Azure Red Hat OpenShift with hosted control plane cluster.	Extension	Preview
az aro hcp cluster update	Update an Azure Red Hat OpenShift with hosted control plane cluster.	Extension	Preview
az aro hcp cluster wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az aro hcp get-versions	List Azure Red Hat OpenShift with hosted control plane versions.	Extension	Preview

az aro hcp get-versions

Preview

Command group 'aro' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Azure Red Hat OpenShift with hosted control plane versions.

az aro hcp get-versions --location
                        [--acquire-policy-token]
                        [--change-reference]
                        [--control-plane {0, 1, f, false, n, no, t, true, y, yes}]
                        [--max-items]
                        [--next-token]
                        [--node-pools {0, 1, f, false, n, no, t, true, y, yes}]

Examples

List available OpenShift versions in a location

az aro hcp get-versions --location eastus

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--control-plane

List the distinct Major.Minor (X.Y) versions available for the control plane. Use one of these with 'cluster create --version', which takes an X.Y version.

Property	Value
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--node-pools

List all available full X.Y.Z versions for node pools. Use one of these with 'nodepool create --version', which requires a full X.Y.Z version.

Property	Value
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

Feedback

Was this page helpful?