az aro hcp cluster

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

Commands

Name	Description	Type	Status
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 cluster create

Preview

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

Create an Azure Red Hat OpenShift with hosted control plane cluster.

az aro hcp cluster create --assign-control-plane-operator-identity --control-plane-identity
                          --assign-data-plane-operator-identity --data-plane-identity
                          --assign-service-managed-identity --service-identity
                          --name
                          --resource-group
                          [--acquire-policy-token]
                          [--api-visibility {Private, Public}]
                          [--authorized-cidrs]
                          [--base-domain-prefix]
                          [--change-reference]
                          [--channel-group]
                          [--crypto-restrictions {FIPS, None}]
                          [--host-prefix]
                          [--image-digest-mirrors]
                          [--image-registry-state {Disabled, Enabled}]
                          [--ingress-visibility {Disabled, Private, Public}]
                          [--kms-active-key]
                          [--kms-vault-name]
                          [--location]
                          [--machine-cidr]
                          [--managed-resource-group-name --managed-rg-name]
                          [--max-node-provision-time --node-provision-time]
                          [--max-nodes-total]
                          [--max-pod-grace-period]
                          [--network-type {OVNKubernetes, Other}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--node-drain-timeout]
                          [--nsg]
                          [--outbound-type {LoadBalancer}]
                          [--pod-cidr]
                          [--pod-priority-threshold]
                          [--service-cidr]
                          [--subnet-id]
                          [--tags]
                          [--vault-visibility {Private, Public}]
                          [--version]
                          [--vnet-int-subnet-id --vnet-integration-subnet-id]

Examples

Create a cluster

az aro hcp cluster create --resource-group MyResourceGroup --name MyCluster --location eastus --version 4.19 --channel-group stable --network-type OVNKubernetes --subnet-id <subnet-id> --kms-vault-name MyKeyVault --kms-active-key "{name:MyKey,version:<key-version>}" --assign-service-managed-identity <service-identity-id> --assign-control-plane-operator-identity cluster-api-azure <cluster-api-azure-identity-id> --assign-control-plane-operator-identity control-plane <control-plane-identity-id> --assign-control-plane-operator-identity cloud-controller-manager <cloud-controller-manager-identity-id> --assign-control-plane-operator-identity ingress <ingress-identity-id> --assign-control-plane-operator-identity disk-csi-driver <control-plane-disk-csi-driver-identity-id> --assign-control-plane-operator-identity file-csi-driver <control-plane-file-csi-driver-identity-id> --assign-control-plane-operator-identity image-registry <control-plane-image-registry-identity-id> --assign-control-plane-operator-identity cloud-network-config <cloud-network-config-identity-id> --assign-control-plane-operator-identity kms <kms-identity-id> --assign-data-plane-operator-identity disk-csi-driver <data-plane-disk-csi-driver-identity-id> --assign-data-plane-operator-identity file-csi-driver <data-plane-file-csi-driver-identity-id> --assign-data-plane-operator-identity image-registry <data-plane-image-registry-identity-id>

Required Parameters

--assign-control-plane-operator-identity --control-plane-identity

Assign a user-assigned identity to a control plane operator. Usage: --assign-control-plane-operator-identity OPERATOR_NAME IDENTITY. IDENTITY is a resource ID or the name of an identity in the cluster subnet's resource group. Repeat the argument to assign more identities.

Property	Value
Parameter group:	Identity Arguments

--assign-data-plane-operator-identity --data-plane-identity

Assign a user-assigned identity to a data plane operator. Usage: --assign-data-plane-operator-identity OPERATOR_NAME IDENTITY. IDENTITY is a resource ID or the name of an identity in the cluster subnet's resource group. Repeat the argument to assign more identities.

Property	Value
Parameter group:	Identity Arguments

--assign-service-managed-identity --service-identity

Assign the user-assigned identity used for service-level actions by resource ID or by name when it is in the cluster subnet's resource group.

Property	Value
Parameter group:	Identity Arguments

--name -n

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--api-visibility

The internet visibility of the OpenShift API server.

Property	Value
Parameter group:	API Arguments
Default value:	Public
Accepted values:	Private, Public

--authorized-cidrs

The list of authorized IPv4 CIDR blocks allowed to access the API server. Maximum 500 entries. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	API Arguments

--base-domain-prefix

BaseDomainPrefix is a prefix used in cluster endpoint DNS names and the names of related Azure resources.

Property	Value
Parameter group:	DNS Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--channel-group

ChannelGroup is the name of the set to which this version belongs. Each version belongs to only a single set. If not specified, the default value is 'stable'.

Property	Value
Parameter group:	Version Arguments

--crypto-restrictions

Cryptographic restrictions for kernel and userspace libraries.

Property	Value
Parameter group:	Properties Arguments
Default value:	None
Accepted values:	FIPS, None

--host-prefix

Network host prefix.

Property	Value
Parameter group:	Network Arguments
Default value:	23

--image-digest-mirrors

ImageDigestMirrors is a set of rules to allow pulling images from a mirrored registry by using digest specifications. WARNING: Updating this array will redeploy all node pools in the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--image-registry-state

State indicates the desired ImageStream-backed cluster image registry installation mode. This can only be set during cluster creation and cannot be changed after cluster creation. Enabled means the ImageStream-backed image registry will be run as pods on worker nodes in the cluster. Disabled means the ImageStream-backed image registry will not be present in the cluster. The default is Enabled.

Property	Value
Parameter group:	ClusterImageRegistry Arguments
Default value:	Enabled
Accepted values:	Disabled, Enabled

--ingress-visibility

The visibility of the default OpenShift ingress controller.

Property	Value
Parameter group:	Ingress Arguments
Default value:	Public
Accepted values:	Disabled, Private, Public

--kms-active-key

The details of the active key. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Etcd Encryption Arguments

--kms-vault-name

VaultName is the name of the keyvault that contains the secret.

Property	Value
Parameter group:	Etcd Encryption Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--machine-cidr

The CIDR block from which to assign machine IP addresses.

Property	Value
Parameter group:	Network Arguments
Default value:	10.0.0.0/16

--managed-resource-group-name --managed-rg-name

The name of the resource group to put cluster resources in. If not specified then a unique name is generated from the following pattern "aro-hcp-" + clusterName + "-" + UUID where clusterName means the hcpOpenShiftClusters resource name (up to 45 characters) followed by a 16-byte universally unique identifier per RFC 4122.

Property	Value
Parameter group:	Platform Arguments

--max-node-provision-time --node-provision-time

MaxNodeProvisionTimeSeconds is the maximum time to wait for node provisioning before considering the provisioning to be unsuccessful. The default is 900 seconds, or 15 minutes.

Property	Value
Parameter group:	Autoscaling Arguments

--max-nodes-total

MaxNodesTotal is the maximum allowable number of nodes. The autoscaler will not grow the cluster beyond this number. If omitted, the autoscaler will not have a maximum limit.

Property	Value
Parameter group:	Autoscaling Arguments

--max-pod-grace-period

MaxPodGracePeriodSeconds is the maximum amount of time in seconds to wait for graceful pod termination before scaling down a NodePool.

Property	Value
Parameter group:	Autoscaling Arguments

--network-type

The main controller responsible for rendering the core networking components.

Property	Value
Parameter group:	Network Arguments
Default value:	OVNKubernetes
Accepted values:	OVNKubernetes, Other

--no-wait

Do not wait for the long-running operation to finish.

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

--node-drain-timeout

NodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are in minutes and from 0 to 10080 minutes (1 week). 0 means that the MachinePool can be drained without any time limitation. This value is used as a default for all NodePools. It can be overridden by specifying nodeDrainTimeoutMinutes for a given NodePool.

Property	Value
Parameter group:	Properties Arguments

--nsg

ResourceId for the NSG (network security group) attached to the cluster subnet Note that NSGs cannot be reused for other ARO-HCP clusters.

Property	Value
Parameter group:	Platform Arguments

--outbound-type

The core outgoing configuration.

Property	Value
Parameter group:	Platform Arguments
Default value:	LoadBalancer
Accepted values:	LoadBalancer

--pod-cidr

The CIDR of the pod IP addresses.

Property	Value
Parameter group:	Network Arguments
Default value:	10.128.0.0/14

--pod-priority-threshold

PodPriorityThreshold enables users to schedule "best-effort" pods, which shouldn't trigger autoscaler actions, but only run when there are spare resources available. The default is -10. See the following for more details: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption.

Property	Value
Parameter group:	Autoscaling Arguments

--service-cidr

The CIDR block for assigned service IPs.

Property	Value
Parameter group:	Network Arguments
Default value:	172.30.0.0/16

--subnet-id

The Azure resource ID of the worker subnet. Note that a subnet cannot be reused between ARO-HCP Clusters.

Property	Value
Parameter group:	Platform Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--vault-visibility

Visibility of the keyvault that contains the secret.

Property	Value
Parameter group:	Etcd Encryption Arguments
Accepted values:	Private, Public

--version

The desired X.Y version of the cluster control plane.

Property	Value
Parameter group:	Version Arguments

--vnet-int-subnet-id --vnet-integration-subnet-id

The Azure resource ID of a subnet that enables direct, private network connectivity between the hosted control plane and your cluster's nodes. This subnet must be dedicated to ARO HCP and cannot be shared with the cluster subnet or any node pool subnets.

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

--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 aro hcp cluster delete

Preview

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

Delete an Azure Red Hat OpenShift with hosted control plane cluster.

az aro hcp cluster delete [--acquire-policy-token]
                          [--change-reference]
                          [--ids]
                          [--name]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--subscription]
                          [--yes]

Examples

Delete a cluster

az aro hcp cluster delete --resource-group MyResourceGroup --name MyCluster --yes

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

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

--name -n

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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

az aro hcp cluster list

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

az aro hcp cluster list [--max-items]
                        [--next-token]
                        [--resource-group]

Examples

List clusters in a resource group

az aro hcp cluster list --resource-group MyResourceGroup

List clusters in the subscription

az aro hcp cluster list

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

--resource-group -g

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

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 aro hcp cluster request-credential

Preview

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

Request a temporary credential for your Azure Red Hat OpenShift with hosted control plane cluster.

az aro hcp cluster request-credential [--acquire-policy-token]
                                      [--admin {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--change-reference]
                                      [--context]
                                      [--file]
                                      [--ids]
                                      [--name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--overwrite-existing {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]

Examples

Request a temporary admin credential

az aro hcp cluster request-credential --resource-group MyResourceGroup --name MyCluster

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

--admin -a

Get cluster administrator credentials. Default: cluster user credentials.

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--context

If specified, overwrite the default context name.

--file -f

Kubernetes configuration file to update. Use "-" to print the kubeconfig to stdout instead.

Property	Value
Default value:	~\.kube\config

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

--name -n

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

--overwrite-existing

Overwrite any existing cluster entry with the same name.

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

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

az aro hcp cluster revoke-credential

Preview

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

Revoke all credentials for your Azure Red Hat OpenShift with hosted control plane cluster.

az aro hcp cluster revoke-credential [--acquire-policy-token]
                                     [--change-reference]
                                     [--ids]
                                     [--name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]

Examples

Revoke all admin credentials

az aro hcp cluster revoke-credential --resource-group MyResourceGroup --name MyCluster

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

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

--name -n

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

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

az aro hcp cluster show

Preview

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

Get an Azure Red Hat OpenShift with hosted control plane cluster.

az aro hcp cluster show [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

Examples

Show a cluster

az aro hcp cluster show --resource-group MyResourceGroup --name MyCluster

Optional Parameters

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

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

--name -n

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

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

az aro hcp cluster update

Preview

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

Update an Azure Red Hat OpenShift with hosted control plane cluster.

az aro hcp cluster update [--acquire-policy-token]
                          [--add]
                          [--assign-control-plane-operator-identity --control-plane-identity]
                          [--assign-data-plane-operator-identity --data-plane-identity]
                          [--assign-service-managed-identity --service-identity]
                          [--change-reference]
                          [--channel-group]
                          [--etcd]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--ids]
                          [--image-digest-mirrors]
                          [--max-node-provision-time --node-provision-time]
                          [--max-nodes-total]
                          [--max-pod-grace-period]
                          [--name]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--node-drain-timeout]
                          [--pod-priority-threshold]
                          [--remove]
                          [--resource-group]
                          [--set]
                          [--subscription]
                          [--tags]
                          [--version]

Examples

Update cluster tags

az aro hcp cluster update --resource-group MyResourceGroup --name MyCluster --tags env=prod team=platform

Update cluster operator identities

az aro hcp cluster update --resource-group MyResourceGroup --name MyCluster --assign-service-managed-identity <service-identity-id> --assign-control-plane-operator-identity cluster-api-azure <control-plane-identity-id> --assign-data-plane-operator-identity disk-csi-driver <data-plane-identity-id>

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--assign-control-plane-operator-identity --control-plane-identity

Assign user-assigned identities to control plane operators. Usage: --assign-control-plane-operator-identity OPERATOR_NAME IDENTITY. IDENTITY is a resource ID or the name of an identity in the cluster subnet's resource group. Repeat the argument to assign more identities.

Property	Value
Parameter group:	Identity Arguments

--assign-data-plane-operator-identity --data-plane-identity

Assign user-assigned identities to data plane operators. Usage: --assign-data-plane-operator-identity OPERATOR_NAME IDENTITY. IDENTITY is a resource ID or the name of an identity in the cluster subnet's resource group. Repeat the argument to assign more identities.

Property	Value
Parameter group:	Identity Arguments

--assign-service-managed-identity --service-identity

Assign the user-assigned identity used for service-level actions by resource ID or by name when it is in the cluster subnet's resource group.

Property	Value
Parameter group:	Identity Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--channel-group

ChannelGroup is the name of the set to which this version belongs. Each version belongs to only a single set. If not specified, the default value is 'stable'.

Property	Value
Parameter group:	Version Arguments

--etcd

Configure ETCD. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--image-digest-mirrors

ImageDigestMirrors is a set of rules to allow pulling images from a mirrored registry by using digest specifications. WARNING: Updating this array will redeploy all node pools in the cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--max-node-provision-time --node-provision-time

MaxNodeProvisionTimeSeconds is the maximum time to wait for node provisioning before considering the provisioning to be unsuccessful. The default is 900 seconds, or 15 minutes.

Property	Value
Parameter group:	Autoscaling Arguments

--max-nodes-total

MaxNodesTotal is the maximum allowable number of nodes. The autoscaler will not grow the cluster beyond this number. If omitted, the autoscaler will not have a maximum limit.

Property	Value
Parameter group:	Autoscaling Arguments

--max-pod-grace-period

MaxPodGracePeriodSeconds is the maximum amount of time in seconds to wait for graceful pod termination before scaling down a NodePool.

Property	Value
Parameter group:	Autoscaling Arguments

--name -n

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

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

--node-drain-timeout

NodeDrainTimeoutMinutes is the grace period for how long Pod Disruption Budget-protected workloads will be respected during any node draining operation. After this grace period, any workloads protected by Pod Disruption Budgets that have not been successfully drained from a node will be forcibly evicted. This is especially relevant to cluster upgrades. Valid values are in minutes and from 0 to 10080 minutes (1 week). 0 means that the MachinePool can be drained without any time limitation. This value is used as a default for all NodePools. It can be overridden by specifying nodeDrainTimeoutMinutes for a given NodePool.

Property	Value
Parameter group:	Properties Arguments

--pod-priority-threshold

PodPriorityThreshold enables users to schedule "best-effort" pods, which shouldn't trigger autoscaler actions, but only run when there are spare resources available. The default is -10. See the following for more details: https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#how-does-cluster-autoscaler-work-with-pod-priority-and-preemption.

Property	Value
Parameter group:	Autoscaling Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update 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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--version

ID is the desired X.Y version of the cluster control plane.

Property	Value
Parameter group:	Version 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

az aro hcp cluster wait

Preview

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

Place the CLI in a waiting state until a condition is met.

az aro hcp cluster wait [--acquire-policy-token]
                        [--change-reference]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--name]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name -n

The name of the Azure Red Hat OpenShift with hosted control plane cluster.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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