az aro

  • Reference

Manage Azure Red Hat OpenShift clusters.

Commands

Name Description Type Status
az aro create

Create a cluster.

 Core GA
az aro delete

Delete a cluster.

 Core GA
az aro get-admin-kubeconfig

List admin kubeconfig of a cluster.

 Core GA
az aro get-versions

List versions available for installation.

 Core GA
az aro list

List clusters.

 Core GA
az aro list-credentials

List credentials of a cluster.

 Core GA
az aro show

Get the details of a cluster.

 Core GA
az aro update

Update a cluster.

 Core GA
az aro validate

Validate permissions required to create a cluster.

 Core GA
az aro wait

Wait for a cluster to reach a desired state.

 Core GA

az aro create

Edit

Create a cluster.

az aro create --master-subnet
              --name
              --resource-group
              --worker-subnet
              [--apiserver-visibility {Private, Public}]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--disk-encryption-set]
              [--domain]
              [--enable-preconfigured-nsg {false, true}]
              [--fips {false, true}]
              [--ingress-visibility {Private, Public}]
              [--location]
              [--master-enc-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 {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

--apiserver-visibility

API server visibility.

accepted values: Private, Public
default value: Public
--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-preconfigured-nsg

Use Preconfigured NSGs. Default: False.

accepted values: false, true
default value: False
--fips --fips-validated-modules

Use FIPS validated cryptography modules. Default: False.

accepted values: false, true
default value: False
--ingress-visibility

Ingress visibility.

accepted values: Private, Public
default value: Public
--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.

accepted values: false, true
default value: False
--master-vm-size

Size of master VMs.

default value: Standard_D8s_v3
--no-wait

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

default value: False
--outbound-type

Outbound type of cluster. Must be "Loadbalancer" or "UserDefinedRouting".

default value: Loadbalancer
--pod-cidr

CIDR of pod network. Must be a minimum of /18 or larger.

default value: 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 value: 172.30.0.0/16
--tags

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 value: 3
--worker-enc-host --worker-encryption-at-host

Encryption at host flag for worker VMs. Default: False.

accepted values: false, true
default value: False
--worker-vm-disk-size-gb

Disk size in GB of worker VMs.

default value: 128
--worker-vm-size

Size of worker VMs.

default value: Standard_D4s_v3
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aro delete

Edit

Delete a cluster.

az aro delete --name
              --resource-group
              [--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

--no-wait

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

default value: False
--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aro get-admin-kubeconfig

Edit

List admin kubeconfig of a cluster.

az aro get-admin-kubeconfig --name
                            --resource-group
                            [--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

--file -f

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

default value: kubeconfig
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aro get-versions

Edit

List versions available for installation.

az aro get-versions --location

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aro list-credentials

Edit

List credentials of a cluster.

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aro update

Edit

Update a cluster.

az aro update --name
              --resource-group
              [--client-id]
              [--client-secret]
              [--no-wait]
              [--refresh-credentials {false, true}]

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

--client-id

Client ID of cluster service principal.

--client-secret

Client secret of cluster service principal.

--no-wait

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

default value: False
--refresh-credentials

Refresh cluster application credentials.

accepted values: false, true
default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az aro validate

Edit

Validate permissions required to create a cluster.

az aro validate --master-subnet
                --name
                --resource-group
                --worker-subnet
                [--client-id]
                [--client-secret]
                [--cluster-resource-group]
                [--disk-encryption-set]
                [--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

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

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

--service-cidr

CIDR of service network. Must be a minimum of /18 or larger.

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.