az aro

Commands

Name	Description	Type	Status
az aro create	Create a cluster.	Core	GA
az aro create (aro extension)	Create a cluster.	Extension	Preview
az aro delete	Delete a cluster.	Core	GA
az aro delete (aro extension)	Delete a cluster.	Extension	Preview
az aro get-admin-kubeconfig	List admin kubeconfig of a cluster.	Core	GA
az aro get-admin-kubeconfig (aro extension)	List admin kubeconfig of a cluster.	Extension	Preview
az aro get-versions	List versions available for installation.	Core	GA
az aro get-versions (aro extension)	List versions available for installation.	Extension	Preview
az aro hcp	Manage Azure Red Hat OpenShift with hosted control plane resource types.	Extension	Preview
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 identity	Manage identities related to Azure Red Hat OpenShift clusters.	Core and Extension	GA
az aro identity create-required	Create required identities.	Core	GA
az aro identity create-required (aro extension)	Create required identities.	Extension	Preview
az aro identity get-required	Get required identities.	Core	GA
az aro identity get-required (aro extension)	Get required identities.	Extension	Preview
az aro list	List clusters.	Core	GA
az aro list (aro extension)	List clusters.	Extension	Preview
az aro list-credentials	List credentials of a cluster.	Core	GA
az aro list-credentials (aro extension)	List credentials of a cluster.	Extension	Preview
az aro show	Get the details of a cluster.	Core	GA
az aro show (aro extension)	Get the details of a cluster.	Extension	Preview
az aro update	Update a cluster.	Core	GA
az aro update (aro extension)	Update a cluster.	Extension	Preview
az aro validate	Validate permissions required to create a cluster.	Core	GA
az aro validate (aro extension)	Validate permissions required to create a cluster.	Extension	Preview
az aro wait	Wait for a cluster to reach a desired state.	Core	GA
az aro wait (aro extension)	Wait for a cluster to reach a desired state.	Extension	Preview

az aro create --master-subnet
              --name
              --resource-group
              --worker-subnet
              [--acquire-policy-token]
              [--apiserver-visibility {Private, Public}]
              [--assign-cluster-identity --mi-user-assigned]
              [--assign-platform-wi --assign-platform-workload-identity]
              [--change-reference]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--disk-encryption-set]
              [--domain]
              [--enable-managed-identity --enable-mi {false, true}]
              [--enable-preconfigured-nsg {false, true}]
              [--fips --fips-validated-modules {false, true}]
              [--ingress-visibility {Private, Public}]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--location]
              [--master-enc-host --master-encryption-at-host {false, true}]
              [--master-vm-size]
              [--no-wait]
              [--outbound-type]
              [--pod-cidr]
              [--pull-secret]
              [--service-cidr]
              [--tags]
              [--version]
              [--vnet]
              [--vnet-resource-group]
              [--worker-count]
              [--worker-enc-host --worker-encryption-at-host {false, true}]
              [--worker-vm-disk-size-gb]
              [--worker-vm-size]

Examples

Create a cluster.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

Create a cluster with a supported OpenShift version.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

Create a cluster with 5 compute nodes and Red Hat pull secret.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --worker-count 5 --pull-secret pullsecret.txt

Create a private cluster.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --apiserver-visibility Private --ingress-visibility Private

Required Parameters

Optional Parameters

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

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 create --master-subnet
              --name
              --resource-group
              --worker-subnet
              [--acquire-policy-token]
              [--apiserver-visibility {Private, Public}]
              [--assign-cluster-identity --mi-user-assigned]
              [--assign-platform-wi --assign-platform-workload-identity]
              [--change-reference]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--disk-encryption-set]
              [--domain]
              [--enable-managed-identity --enable-mi {false, true}]
              [--enable-preconfigured-nsg {false, true}]
              [--fips --fips-validated-modules {false, true}]
              [--ingress-visibility {Private, Public}]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--location]
              [--master-enc-host --master-encryption-at-host {false, true}]
              [--master-vm-size]
              [--no-wait]
              [--outbound-type]
              [--pod-cidr]
              [--pull-secret]
              [--service-cidr]
              [--tags]
              [--version]
              [--vnet]
              [--vnet-resource-group]
              [--worker-count]
              [--worker-enc-host --worker-encryption-at-host {false, true}]
              [--worker-vm-disk-size-gb]
              [--worker-vm-size]

Examples

Create a cluster.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

Create a cluster with a supported OpenShift version.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

Create a cluster with 5 compute nodes and Red Hat pull secret.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --worker-count 5 --pull-secret pullsecret.txt

Create a private cluster.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --apiserver-visibility Private --ingress-visibility Private

Required Parameters

Optional Parameters

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

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 delete --name
              --resource-group
              [--acquire-policy-token]
              [--change-reference]
              [--delete-identities {false, true}]
              [--no-wait]
              [--yes]

Examples

Delete a cluster.

az aro delete --name MyCluster --resource-group MyResourceGroup

Required Parameters

Optional Parameters

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

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 delete --name
              --resource-group
              [--acquire-policy-token]
              [--change-reference]
              [--delete-identities {false, true}]
              [--no-wait]
              [--yes]

Examples

Delete a cluster.

az aro delete --name MyCluster --resource-group MyResourceGroup

Required Parameters

Optional Parameters

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

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 get-admin-kubeconfig --name
                            --resource-group
                            [--acquire-policy-token]
                            [--change-reference]
                            [--file]

Examples

List admin kubeconfig of a cluster. The default is to save it in a file named "kubeconfig".

az aro get-admin-kubeconfig --name MyCluster --resource-group MyResourceGroup

Required Parameters

Optional Parameters

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

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 get-admin-kubeconfig --name
                            --resource-group
                            [--acquire-policy-token]
                            [--change-reference]
                            [--file]

Examples

List admin kubeconfig of a cluster. The default is to save it in a file named "kubeconfig".

az aro get-admin-kubeconfig --name MyCluster --resource-group MyResourceGroup

Required Parameters

Optional Parameters

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

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 get-versions --location
                    [--acquire-policy-token]
                    [--change-reference]

Examples

List install versions available for the East US region.

az aro get-versions --location eastus

List install versions available for the East US region with table formatted output.

az aro get-versions --location eastus -o table

Required Parameters

Optional Parameters

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

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 get-versions --location
                    [--acquire-policy-token]
                    [--change-reference]

Examples

List install versions available for the East US region.

az aro get-versions --location eastus

List install versions available for the East US region with table formatted output.

az aro get-versions --location eastus -o table

Required Parameters

Optional Parameters

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

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 list [--resource-group]

Examples

List clusters.

az aro list

List clusters with table view.

az aro list -o table

Optional Parameters

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

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 list [--resource-group]

Examples

List clusters.

az aro list

List clusters with table view.

az aro list -o table

Optional Parameters

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

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 list-credentials --name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]

Examples

List credentials of a cluster.

az aro list-credentials --name MyCluster --resource-group MyResourceGroup

Required Parameters

Optional Parameters

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

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 list-credentials --name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]

Examples

List credentials of a cluster.

az aro list-credentials --name MyCluster --resource-group MyResourceGroup

Required Parameters

Optional Parameters

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

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 show --name
            --resource-group

Examples

Get the details of a cluster.

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

Required Parameters

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 show --name
            --resource-group

Examples

Get the details of a cluster.

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

Required Parameters

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 update --name
              --resource-group
              [--acquire-policy-token]
              [--assign-cluster-identity --mi-user-assigned]
              [--assign-platform-wi --assign-platform-workload-identity]
              [--change-reference]
              [--client-id]
              [--client-secret]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--no-wait]
              [--refresh-credentials {false, true}]
              [--upgradeable-to]

Examples

Update a cluster.

az aro update --name MyCluster --resource-group MyResourceGroup

Required Parameters

Optional Parameters

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

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 update --name
              --resource-group
              [--acquire-policy-token]
              [--assign-cluster-identity --mi-user-assigned]
              [--assign-platform-wi --assign-platform-workload-identity]
              [--change-reference]
              [--client-id]
              [--client-secret]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--no-wait]
              [--refresh-credentials {false, true}]
              [--upgradeable-to]

Examples

Update a cluster.

az aro update --name MyCluster --resource-group MyResourceGroup

Required Parameters

Optional Parameters

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

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 validate --master-subnet
                --name
                --resource-group
                --worker-subnet
                [--acquire-policy-token]
                [--assign-cluster-identity --mi-user-assigned]
                [--assign-platform-wi --assign-platform-workload-identity]
                [--change-reference]
                [--client-id]
                [--client-secret]
                [--cluster-resource-group]
                [--disk-encryption-set]
                [--enable-managed-identity --enable-mi {false, true}]
                [--location]
                [--pod-cidr]
                [--service-cidr]
                [--version]
                [--vnet]
                [--vnet-resource-group]

Examples

Validate permissions.

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

Validate permissions and OpenShift version

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

Required Parameters

Optional Parameters

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

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 validate --master-subnet
                --name
                --resource-group
                --worker-subnet
                [--acquire-policy-token]
                [--assign-cluster-identity --mi-user-assigned]
                [--assign-platform-wi --assign-platform-workload-identity]
                [--change-reference]
                [--client-id]
                [--client-secret]
                [--cluster-resource-group]
                [--disk-encryption-set]
                [--enable-managed-identity --enable-mi {false, true}]
                [--location]
                [--pod-cidr]
                [--service-cidr]
                [--version]
                [--vnet]
                [--vnet-resource-group]

Examples

Validate permissions.

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

Validate permissions and OpenShift version

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

Required Parameters

Optional Parameters

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

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 wait --name
            --resource-group
            [--acquire-policy-token]
            [--change-reference]
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

Required Parameters

Optional Parameters

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

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 wait --name
            --resource-group
            [--acquire-policy-token]
            [--change-reference]
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

Required Parameters

Optional Parameters

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

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