az aro
管理 Azure Red Hat OpenShift 群集。
命令
| 名称 | 说明 | 类型 | Status |
|---|---|---|---|
| az aro create |
创建群集。 |
Core | GA |
| az aro delete |
删除群集。 |
Core | GA |
| az aro get-admin-kubeconfig |
列出群集的管理员 kubeconfig。 |
Core | GA |
| az aro get-versions |
列出可用于安装的版本。 |
Core | GA |
| az aro list |
列出群集。 |
Core | GA |
| az aro list-credentials |
列出群集的凭据。 |
Core | GA |
| az aro show |
获取群集的详细信息。 |
Core | GA |
| az aro update |
更新群集。 |
Core | GA |
| az aro validate |
验证创建群集所需的权限。 |
Core | GA |
| az aro wait |
等待群集达到所需状态。 |
Core | GA |
az aro create
创建群集。
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 --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]
示例
创建群集。
az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet
使用受支持的 OpenShift 版本创建群集。
az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z
创建包含 5 个计算节点和 Red Hat 拉取机密的群集。
az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --worker-count 5 --pull-secret pullsecret.txt
创建专用群集。
az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --apiserver-visibility Private --ingress-visibility Private
必需参数
主 vnet 子网的名称或 ID。 如果提供名称, --vnet 则必须提供。
群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
辅助角色 vnet 子网的名称或 ID。 如果提供名称, --vnet 则必须提供。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
API 服务器可见性。
| 属性 | 值 |
|---|---|
| 默认值: | Public |
| 接受的值: | Private, Public |
群集服务主体的客户端 ID。
群集服务主体的客户端机密。
群集的资源组。
要用于主 VM 和辅助角色 VM 的 DiskEncryptionSet 的资源 ID。
群集域。
使用预配置的 NSG。
| 属性 | 值 |
|---|---|
| 默认值: | False |
| 接受的值: | false, true |
使用经过 FIPS 验证的加密模块。
| 属性 | 值 |
|---|---|
| 默认值: | False |
| 接受的值: | false, true |
入口可见性。
| 属性 | 值 |
|---|---|
| 默认值: | Public |
| 接受的值: | Private, Public |
Azure 为群集公共负载均衡器创建和管理的所需 IPv4 出站 IP 数。
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
主 VM 的主机标志加密。
| 属性 | 值 |
|---|---|
| 默认值: | False |
| 接受的值: | false, true |
主 VM 的大小。
| 属性 | 值 |
|---|---|
| 默认值: | Standard_D8s_v5 |
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | False |
群集的出站类型。 必须是“Loadbalancer”或“UserDefinedRouting”。
| 属性 | 值 |
|---|---|
| 默认值: | Loadbalancer |
Pod 网络的 CIDR。 必须至少为 /18 或更大。
| 属性 | 值 |
|---|---|
| 默认值: | 10.128.0.0/14 |
拉取群集的机密。
服务网络的 CIDR。 必须至少为 /18 或更大。
| 属性 | 值 |
|---|---|
| 默认值: | 172.30.0.0/16 |
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
用于创建群集的 OpenShift 版本。
vnet 的名称或 ID。 如果提供名称, --vnet-resource-group 则必须提供。
vnet 资源组的名称。
辅助角色 VM 计数。
| 属性 | 值 |
|---|---|
| 默认值: | 3 |
辅助角色 VM 的主机标志加密。
| 属性 | 值 |
|---|---|
| 默认值: | False |
| 接受的值: | false, true |
以 GB 为单位的工作器 VM 的磁盘大小。
| 属性 | 值 |
|---|---|
| 默认值: | 128 |
辅助角色 VM 的大小。
| 属性 | 值 |
|---|---|
| 默认值: | Standard_D4s_v5 |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro delete
删除群集。
az aro delete --name
--resource-group
[--no-wait]
[--yes]
示例
删除群集。
az aro delete --name MyCluster --resource-group MyResourceGroup
必需参数
群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | False |
不要提示确认。
| 属性 | 值 |
|---|---|
| 默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro get-admin-kubeconfig
列出群集的管理员 kubeconfig。
az aro get-admin-kubeconfig --name
--resource-group
[--file]
示例
列出群集的管理员 kubeconfig。 默认值是将其保存在名为“kubeconfig”的文件中。
az aro get-admin-kubeconfig --name MyCluster --resource-group MyResourceGroup
必需参数
群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
应保存 kubeconfig 的文件的路径。 默认值:本地目录中的 kubeconfig。
| 属性 | 值 |
|---|---|
| 默认值: | kubeconfig |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro get-versions
列出可用于安装的版本。
az aro get-versions --location
示例
列出适用于美国东部区域的安装版本。
az aro get-versions --location eastus
列出可用于具有表格式输出的美国东部区域的安装版本。
az aro get-versions --location eastus -o table
必需参数
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro list
列出群集。
az aro list [--resource-group]
示例
列出群集。
az aro list
列出具有表视图的群集。
az aro list -o table
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro list-credentials
列出群集的凭据。
az aro list-credentials --name
--resource-group
示例
列出群集的凭据。
az aro list-credentials --name MyCluster --resource-group MyResourceGroup
必需参数
群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro show
获取群集的详细信息。
az aro show --name
--resource-group
示例
获取群集的详细信息。
az aro show --name MyCluster --resource-group MyResourceGroup
必需参数
群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro update
更新群集。
az aro update --name
--resource-group
[--client-id]
[--client-secret]
[--lb-ip-count --load-balancer-managed-outbound-ip-count]
[--no-wait]
[--refresh-credentials {false, true}]
示例
更新群集。
az aro update --name MyCluster --resource-group MyResourceGroup
必需参数
群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
群集服务主体的客户端 ID。
群集服务主体的客户端机密。
Azure 为群集公共负载均衡器创建和管理的所需 IPv4 出站 IP 数。
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | False |
刷新群集应用程序凭据。
| 属性 | 值 |
|---|---|
| 默认值: | False |
| 接受的值: | false, true |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro validate
验证创建群集所需的权限。
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]
示例
验证权限。
az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet
验证权限和 OpenShift 版本
az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z
必需参数
主 vnet 子网的名称或 ID。 如果提供名称, --vnet 则必须提供。
群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
辅助角色 vnet 子网的名称或 ID。 如果提供名称, --vnet 则必须提供。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
群集服务主体的客户端 ID。
群集服务主体的客户端机密。
群集的资源组。
要用于主 VM 和辅助角色 VM 的 DiskEncryptionSet 的资源 ID。
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
Pod 网络的 CIDR。 必须至少为 /18 或更大。
服务网络的 CIDR。 必须至少为 /18 或更大。
用于创建群集的 OpenShift 版本。
vnet 的名称或 ID。 如果提供名称, --vnet-resource-group 则必须提供。
vnet 资源组的名称。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az aro wait
等待群集达到所需状态。
如果群集上的操作中断或已启动 --no-wait,请使用此命令等待它完成。
az aro wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
必需参数
群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
等待在“Succeeded”中使用“provisioningState”创建。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | False |
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
等到删除为止。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | False |
等待资源存在。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | False |
轮询间隔(以秒为单位)。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | 30 |
最大等待(以秒为单位)。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | 3600 |
等到 provisioningState 更新为“Succeeded”。
| 属性 | 值 |
|---|---|
| Parameter group: | Wait Condition Arguments |
| 默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |