az aro

Manage Azure Red Hat OpenShift clusters.

Commands

az aro create

Create a cluster.

az aro delete

Delete a cluster.

az aro list

List clusters.

az aro list-credentials

List credentials of a cluster.

az aro show

Get the details of a cluster.

az aro update

Update a cluster.

az aro wait

Wait for a cluster to reach a desired state.

az aro create

Create a cluster.

az aro create --master-subnet
              --name
              --resource-group
              --worker-subnet
              [--apiserver-visibility {Private, Public}]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--domain]
              [--ingress-visibility {Private, Public}]
              [--location]
              [--master-vm-size]
              [--no-wait]
              [--pod-cidr]
              [--pull-secret]
              [--service-cidr]
              [--subscription]
              [--tags]
              [--vnet]
              [--vnet-resource-group]
              [--worker-count]
              [--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 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
--client-id

Client ID of cluster service principal.

--client-secret

Client secret of cluster service principal.

--cluster-resource-group

Resource group of cluster.

--domain

Domain of cluster.

--ingress-visibility

Ingress visibility.

accepted values: Private, Public
--location -l

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

--master-vm-size

Size of master VMs.

--no-wait

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

--pod-cidr

CIDR of pod network.

--pull-secret

Pull secret of cluster.

--service-cidr

CIDR of service network.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

--worker-vm-disk-size-gb

Disk size in GB of worker VMs.

--worker-vm-size

Size of worker VMs.

az aro delete

Delete a cluster.

az aro delete --name
              --resource-group
              [--no-wait]
              [--subscription]
              [--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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

az aro list

List clusters.

az aro list [--query-examples]
            [--resource-group]
            [--subscription]

Examples

List clusters.

az aro list

List clusters with table view.

az aro list -o table

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az aro list-credentials

List credentials of a cluster.

az aro list-credentials --name
                        --resource-group
                        [--subscription]

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az aro show

Get the details of a cluster.

az aro show --name
            --resource-group
            [--query-examples]
            [--subscription]

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az aro update

Update a cluster.

az aro update --name
              --resource-group
              [--no-wait]
              [--subscription]

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

--no-wait

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az aro wait

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]
            [--subscription]
            [--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'.

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.