az aro

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage Azure Red Hat OpenShift clusters.

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

Edit

Create a cluster.

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

--master-subnet

Name or ID of master vnet subnet. If name is supplied, --vnet must be supplied.

--name -n

Name of cluster.

--resource-group -g

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

--worker-subnet

Name or ID of worker vnet subnet. If name is supplied, --vnet must be supplied.

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

--apiserver-visibility

API server visibility. [Default: Public].

Property	Value
Accepted values:	Private, Public

--assign-cluster-identity --mi-user-assigned

Set the user managed identity on the cluster. Value must be an identity name or resource ID.

Property	Value
Parameter group:	Identity Arguments

--assign-platform-wi --assign-platform-workload-identity

Assign a platform workload identity used within the cluster. Requires two values: an operator name and either the name or resource ID of the Azure identity to use for it.

Property	Value
Parameter group:	Identity Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--client-id

Client ID of cluster service principal.

--client-secret

Client secret of cluster service principal.

--cluster-resource-group

Resource group of cluster.

--disk-encryption-set

ResourceID of the DiskEncryptionSet to be used for master and worker VMs.

--domain

Domain of cluster.

--enable-managed-identity --enable-mi

Enable managed identity for this cluster.

Property	Value
Parameter group:	Identity Arguments
Default value:	False
Accepted values:	false, true

--enable-preconfigured-nsg

Use Preconfigured NSGs. Allowed values: false, true. [Default: false].

Property	Value
Accepted values:	false, true

--fips --fips-validated-modules

Use FIPS validated cryptography modules. [Default: false].

Property	Value
Accepted values:	false, true

--ingress-visibility

Ingress visibility. [Default: Public].

Property	Value
Accepted values:	Private, Public

--lb-ip-count --load-balancer-managed-outbound-ip-count

The desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer.

--location -l

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

--master-enc-host --master-encryption-at-host

Encryption at host flag for master VMs. [Default: false].

Property	Value
Default value:	False
Accepted values:	false, true

--master-vm-size

Size of master VMs. [Default: Standard_D8s_v5].

--no-wait

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

Property	Value
Default value:	False

--outbound-type

Outbound type of cluster. Must be "Loadbalancer" or "UserDefinedRouting". [Default: Loadbalancer].

--pod-cidr

CIDR of pod network. Must be a minimum of /18 or larger. [Default: 10.128.0.0/14].

--pull-secret

Pull secret of cluster.

--service-cidr

CIDR of service network. Must be a minimum of /18 or larger. [Default: 172.30.0.0/16].

--tags

Tags to be assigned to the openShiftCluster resource. space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--version

OpenShift version to use for cluster creation.

--vnet

Name or ID of vnet. If name is supplied, --vnet-resource-group must be supplied.

--vnet-resource-group

Name of vnet resource group.

--worker-count

Count of worker VMs. [Default: 3].

--worker-enc-host --worker-encryption-at-host

Encryption at host flag for worker VMs. [Default: false].

Property	Value
Default value:	False
Accepted values:	false, true

--worker-vm-disk-size-gb

Disk size in GB of worker VMs. [Default: 128].

--worker-vm-size

Size of worker VMs. [Default: Standard_D4s_v5].

Property	Value
Default value:	Standard_D4s_v5

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 (aro extension)

Preview

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

Create a cluster.

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

--master-subnet

Name or ID of master vnet subnet. If name is supplied, --vnet must be supplied.

--name -n

Name of cluster.

--resource-group -g

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

--worker-subnet

Name or ID of worker vnet subnet. If name is supplied, --vnet must be supplied.

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

--apiserver-visibility

API server visibility. [Default: Public].

Property	Value
Accepted values:	Private, Public

--assign-cluster-identity --mi-user-assigned

Set the user managed identity on the cluster. Value must be an identity name or resource ID.

Property	Value
Parameter group:	Identity Arguments

--assign-platform-wi --assign-platform-workload-identity

Assign a platform workload identity used within the cluster. Requires two values: an operator name and either the name or resource ID of the Azure identity to use for it.

Property	Value
Parameter group:	Identity Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--client-id

Client ID of cluster service principal.

--client-secret

Client secret of cluster service principal.

--cluster-resource-group

Resource group of cluster.

--disk-encryption-set

ResourceID of the DiskEncryptionSet to be used for master and worker VMs.

--domain

Domain of cluster.

--enable-managed-identity --enable-mi

Enable managed identity for this cluster.

Property	Value
Parameter group:	Identity Arguments
Default value:	False
Accepted values:	false, true

--enable-preconfigured-nsg

Use Preconfigured NSGs. Allowed values: false, true. [Default: false].

Property	Value
Accepted values:	false, true

--fips --fips-validated-modules

Use FIPS validated cryptography modules. [Default: false].

Property	Value
Accepted values:	false, true

--ingress-visibility

Ingress visibility. [Default: Public].

Property	Value
Accepted values:	Private, Public

--lb-ip-count --load-balancer-managed-outbound-ip-count

The desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer.

--location -l

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

--master-enc-host --master-encryption-at-host

Encryption at host flag for master VMs. [Default: false].

Property	Value
Default value:	False
Accepted values:	false, true

--master-vm-size

Size of master VMs. [Default: Standard_D8s_v5].

--no-wait

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

Property	Value
Default value:	False

--outbound-type

Outbound type of cluster. Must be "Loadbalancer" or "UserDefinedRouting". [Default: Loadbalancer].

--pod-cidr

CIDR of pod network. Must be a minimum of /18 or larger. [Default: 10.128.0.0/14].

--pull-secret

Pull secret of cluster.

--service-cidr

CIDR of service network. Must be a minimum of /18 or larger. [Default: 172.30.0.0/16].

--tags

Tags to be assigned to the openShiftCluster resource. space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--version

OpenShift version to use for cluster creation.

--vnet

Name or ID of vnet. If name is supplied, --vnet-resource-group must be supplied.

--vnet-resource-group

Name of vnet resource group.

--worker-count

Count of worker VMs. [Default: 3].

--worker-enc-host --worker-encryption-at-host

Encryption at host flag for worker VMs. [Default: false].

Property	Value
Default value:	False
Accepted values:	false, true

--worker-vm-disk-size-gb

Disk size in GB of worker VMs. [Default: 128].

--worker-vm-size

Size of worker VMs. [Default: Standard_D4s_v5].

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

Edit

Delete a cluster.

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

--name -n

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--delete-identities

Delete the cluster's associated managed identities together with the cluster.

Property	Value
Parameter group:	Identity Arguments
Accepted values:	false, true

--no-wait

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

Property	Value
Default value:	False

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

--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 (aro extension)

Preview

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

Delete a cluster.

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

--name -n

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--delete-identities

Delete the cluster's associated managed identities together with the cluster.

Property	Value
Parameter group:	Identity Arguments
Accepted values:	false, true

--no-wait

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

Property	Value
Default value:	False

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

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

Edit

List admin kubeconfig of a cluster.

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

--name -n

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--file -f

Path to the file where kubeconfig should be saved. Default: kubeconfig in local directory.

Property	Value
Default value:	kubeconfig

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 (aro extension)

Preview

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

List admin kubeconfig of a cluster.

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

--name -n

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--file -f

Path to the file where kubeconfig should be saved. Default: kubeconfig in local directory.

Property	Value
Default value:	kubeconfig

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

Edit

List versions available for installation.

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

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

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 (aro extension)

Preview

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

List versions available for installation.

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

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

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

Edit

List clusters.

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.

--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 list (aro extension)

Preview

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

List clusters.

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.

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

Edit

List credentials of a cluster.

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

--name -n

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy 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 list-credentials (aro extension)

Preview

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

List credentials of a cluster.

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

--name -n

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy 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 show

Edit

Get the details of a cluster.

az aro show --name
            --resource-group

Examples

Get the details of a cluster.

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

Required Parameters

--name -n

Name of cluster.

--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 show (aro extension)

Preview

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

Get the details of a cluster.

az aro show --name
            --resource-group

Examples

Get the details of a cluster.

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

Required Parameters

--name -n

Name of cluster.

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

Edit

Update a cluster.

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

--name -n

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

--assign-cluster-identity --mi-user-assigned

Set the user managed identity on the cluster. Value must be an identity name or resource ID.

Property	Value
Parameter group:	Identity Arguments

--assign-platform-wi --assign-platform-workload-identity

Assign a platform workload identity used within the cluster. Requires two values: an operator name and either the name or resource ID of the Azure identity to use for it.

Property	Value
Parameter group:	Identity Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--client-id

Client ID of cluster service principal.

--client-secret

Client secret of cluster service principal.

--lb-ip-count --load-balancer-managed-outbound-ip-count

The desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer.

--no-wait

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

Property	Value
Default value:	False

--refresh-credentials

Refresh cluster application credentials.

Property	Value
Default value:	False
Accepted values:	false, true

--upgradeable-to

OpenShift version to upgrade to.

Property	Value
Parameter group:	Identity 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 update (aro extension)

Preview

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

Update a cluster.

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

--name -n

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

--assign-cluster-identity --mi-user-assigned

Set the user managed identity on the cluster. Value must be an identity name or resource ID.

Property	Value
Parameter group:	Identity Arguments

--assign-platform-wi --assign-platform-workload-identity

Assign a platform workload identity used within the cluster. Requires two values: an operator name and either the name or resource ID of the Azure identity to use for it.

Property	Value
Parameter group:	Identity Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--client-id

Client ID of cluster service principal.

--client-secret

Client secret of cluster service principal.

--lb-ip-count --load-balancer-managed-outbound-ip-count

The desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer.

--no-wait

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

Property	Value
Default value:	False

--refresh-credentials

Refresh cluster application credentials.

Property	Value
Default value:	False
Accepted values:	false, true

--upgradeable-to

OpenShift version to upgrade to.

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

Edit

Validate permissions required to create a cluster.

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

--master-subnet

Name or ID of master vnet subnet. If name is supplied, --vnet must be supplied.

--name -n

Name of cluster.

--resource-group -g

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

--worker-subnet

Name or ID of worker vnet subnet. If name is supplied, --vnet must be supplied.

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

--assign-cluster-identity --mi-user-assigned

Set the user managed identity on the cluster. Value must be an identity name or resource ID.

Property	Value
Parameter group:	Identity Arguments

--assign-platform-wi --assign-platform-workload-identity

Assign a platform workload identity used within the cluster. Requires two values: an operator name and either the name or resource ID of the Azure identity to use for it.

Property	Value
Parameter group:	Identity Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--client-id

Client ID of cluster service principal.

--client-secret

Client secret of cluster service principal.

--cluster-resource-group

Resource group of cluster.

--disk-encryption-set

ResourceID of the DiskEncryptionSet to be used for master and worker VMs.

--enable-managed-identity --enable-mi

Enable managed identity for this cluster.

Property	Value
Parameter group:	Identity Arguments
Default value:	False
Accepted values:	false, true

--location -l

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

--pod-cidr

CIDR of pod network. Must be a minimum of /18 or larger. [Default: 10.128.0.0/14].

--service-cidr

CIDR of service network. Must be a minimum of /18 or larger. [Default: 172.30.0.0/16].

--version

OpenShift version to use for cluster creation.

--vnet

Name or ID of vnet. If name is supplied, --vnet-resource-group must be supplied.

--vnet-resource-group

Name of vnet resource group.

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 (aro extension)

Preview

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

Validate permissions required to create a cluster.

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

--master-subnet

Name or ID of master vnet subnet. If name is supplied, --vnet must be supplied.

--name -n

Name of cluster.

--resource-group -g

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

--worker-subnet

Name or ID of worker vnet subnet. If name is supplied, --vnet must be supplied.

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

--assign-cluster-identity --mi-user-assigned

Set the user managed identity on the cluster. Value must be an identity name or resource ID.

Property	Value
Parameter group:	Identity Arguments

--assign-platform-wi --assign-platform-workload-identity

Assign a platform workload identity used within the cluster. Requires two values: an operator name and either the name or resource ID of the Azure identity to use for it.

Property	Value
Parameter group:	Identity Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--client-id

Client ID of cluster service principal.

--client-secret

Client secret of cluster service principal.

--cluster-resource-group

Resource group of cluster.

--disk-encryption-set

ResourceID of the DiskEncryptionSet to be used for master and worker VMs.

--enable-managed-identity --enable-mi

Enable managed identity for this cluster.

Property	Value
Parameter group:	Identity Arguments
Default value:	False
Accepted values:	false, true

--location -l

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

--pod-cidr

CIDR of pod network. Must be a minimum of /18 or larger. [Default: 10.128.0.0/14].

--service-cidr

CIDR of service network. Must be a minimum of /18 or larger. [Default: 172.30.0.0/16].

--version

OpenShift version to use for cluster creation.

--vnet

Name or ID of vnet. If name is supplied, --vnet-resource-group must be supplied.

--vnet-resource-group

Name of vnet resource group.

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

Edit

Wait for a cluster to reach a desired state.

If an operation on a cluster was interrupted or was started with --no-wait, use this command to wait for it to complete.

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

Required Parameters

--name -n

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

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

--interval

Polling interval in seconds.

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

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

--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 (aro extension)

Preview

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

Wait for a cluster to reach a desired state.

If an operation on a cluster was interrupted or was started with --no-wait, use this command to wait for it to complete.

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

Required Parameters

--name -n

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

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

--interval

Polling interval in seconds.

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

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

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

คำติชม

หน้านี้มีประโยชน์หรือไม่