az aro
Manage Azure Red Hat OpenShift clusters.
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 |
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}]
[--lb-ip-count]
[--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]
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
Name or ID of master vnet subnet. If name is supplied, --vnet
must be supplied.
Name of cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of worker vnet subnet. If name is supplied, --vnet
must be supplied.
API server visibility.
Client ID of cluster service principal.
Client secret of cluster service principal.
Resource group of cluster.
ResourceID of the DiskEncryptionSet to be used for master and worker VMs.
Domain of cluster.
Use Preconfigured NSGs.
Use FIPS validated cryptography modules.
Ingress visibility.
The desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Encryption at host flag for master VMs.
Size of master VMs.
Do not wait for the long-running operation to finish.
Outbound type of cluster. Must be "Loadbalancer" or "UserDefinedRouting".
CIDR of pod network. Must be a minimum of /18 or larger.
Pull secret of cluster.
CIDR of service network. Must be a minimum of /18 or larger.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
OpenShift version to use for cluster creation.
Name or ID of vnet. If name is supplied, --vnet-resource-group
must be supplied.
Name of vnet resource group.
Count of worker VMs.
Encryption at host flag for worker VMs.
Disk size in GB of worker VMs.
Size of worker VMs.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Delete a cluster.
az aro delete --name
--resource-group
[--no-wait]
[--yes]
Delete a cluster.
az aro delete --name MyCluster --resource-group MyResourceGroup
Name of cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List admin kubeconfig of a cluster.
az aro get-admin-kubeconfig --name
--resource-group
[--file]
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
Name of cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Path to the file where kubeconfig should be saved. Default: kubeconfig in local directory.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List versions available for installation.
az aro get-versions --location
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
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List clusters.
az aro list [--resource-group]
List clusters.
az aro list
List clusters with table view.
az aro list -o table
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
List credentials of a cluster.
az aro list-credentials --name
--resource-group
List credentials of a cluster.
az aro list-credentials --name MyCluster --resource-group MyResourceGroup
Name of cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Get the details of a cluster.
az aro show --name
--resource-group
Get the details of a cluster.
az aro show --name MyCluster --resource-group MyResourceGroup
Name of cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Update a cluster.
az aro update --name
--resource-group
[--client-id]
[--client-secret]
[--lb-ip-count]
[--no-wait]
[--refresh-credentials {false, true}]
Update a cluster.
az aro update --name MyCluster --resource-group MyResourceGroup
Name of cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Client ID of cluster service principal.
Client secret of cluster service principal.
The desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer.
Do not wait for the long-running operation to finish.
Refresh cluster application credentials.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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]
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
Name or ID of master vnet subnet. If name is supplied, --vnet
must be supplied.
Name of cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of worker vnet subnet. If name is supplied, --vnet
must be supplied.
Client ID of cluster service principal.
Client secret of cluster service principal.
Resource group of cluster.
ResourceID of the DiskEncryptionSet to be used for master and worker VMs.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
CIDR of pod network. Must be a minimum of /18 or larger.
CIDR of service network. Must be a minimum of /18 or larger.
OpenShift version to use for cluster creation.
Name or ID of vnet. If name is supplied, --vnet-resource-group
must be supplied.
Name of vnet resource group.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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]
Name of cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: