az aksarc
Note
此参考是 Azure CLI 的 aksarc 扩展(版本 2.32.0 或更高版本)的一部分。 该扩展将在首次运行 az aksarc 命令时自动安装。 了解更多关于扩展的信息。
管理预配的群集。
命令
| 名称 | 说明 | 类型 | Status |
|---|---|---|---|
| az aksarc create |
创建预配的群集。 |
Extension | GA |
| az aksarc delete |
删除预配的群集。 |
Extension | GA |
| az aksarc get-credentials |
获取预配群集的本地 kubeconfig。 |
Extension | GA |
| az aksarc get-logs |
从预配的群集和底层基础结构收集日志。 |
Extension | GA |
| az aksarc get-upgrades |
获取可用于预配群集的升级版本。 |
Extension | GA |
| az aksarc get-versions |
列出指定自定义位置中支持的 Kubernetes 版本。 |
Extension | GA |
| az aksarc list |
列出资源组或订阅中预配的群集。 |
Extension | GA |
| az aksarc logs |
Deprecated. 请改用“az aksarc get-logs”。 |
Extension | GA |
| az aksarc logs hci |
从预配的群集和底层基础结构收集日志。 |
Extension | Deprecated |
| az aksarc nodepool |
管理预配群集中的节点池。 |
Extension | GA |
| az aksarc nodepool add |
在预配的群集中添加节点池。 |
Extension | GA |
| az aksarc nodepool delete |
删除预配群集中的节点池。 |
Extension | GA |
| az aksarc nodepool list |
列出预配群集中的所有节点池。 |
Extension | GA |
| az aksarc nodepool scale |
缩放预配群集中的节点池。 |
Extension | GA |
| az aksarc nodepool show |
获取预配群集中的节点池。 |
Extension | GA |
| az aksarc nodepool update |
更新预配群集中的节点池。 |
Extension | GA |
| az aksarc notice |
将 NOTICE 文件输出到用户指定的文件路径。 |
Extension | GA |
| az aksarc release |
管理预配群集的 VHD 映像。 |
Extension | Preview |
| az aksarc release download |
从发布下载 VHD 映像。 |
Extension | Preview |
| az aksarc release save |
将下载的 VHD 映像预配到 arc 资源桥。 |
Extension | Preview |
| az aksarc show |
获取预配的群集。 |
Extension | GA |
| az aksarc update |
更新预配的群集。 |
Extension | GA |
| az aksarc upgrade |
升级预配的群集。 |
Extension | GA |
| az aksarc vmsize |
管理预配群集的虚拟机 SKU。 |
Extension | GA |
| az aksarc vmsize list |
列出指定自定义位置中支持的虚拟机大小。 |
Extension | GA |
| az aksarc vnet |
管理预配群集的虚拟网络。 |
Extension | GA |
| az aksarc vnet create |
创建虚拟网络。 |
Extension | GA |
| az aksarc vnet delete |
删除虚拟网络。 |
Extension | GA |
| az aksarc vnet list |
按资源组或订阅列出虚拟网络。 |
Extension | GA |
| az aksarc vnet show |
获取虚拟网络。 |
Extension | GA |
az aksarc create
创建预配的群集。
az aksarc create --custom-location
--name
--resource-group
--vnet-id --vnet-ids
[--aad-admin-group-object-ids]
[--ca-profile --cluster-autoscaler-profile]
[--control-plane-count --control-plane-node-count]
[--control-plane-ip]
[--control-plane-vm-size]
[--disable-nfs-driver]
[--disable-smb-driver]
[--enable-ahub]
[--enable-ai-toolchain-operator --enable-kaito]
[--enable-azure-rbac]
[--enable-cluster-autoscaler]
[--enable-oidc-issuer]
[--enable-wi --enable-workload-identity]
[--gateway-id]
[--generate-ssh-keys]
[--kubernetes-version]
[--load-balancer-count]
[--location]
[--max-count]
[--max-pods]
[--min-count]
[--no-wait]
[--node-count]
[--node-vm-size]
[--nodepool-labels]
[--nodepool-taints]
[--pod-cidr]
[--ssh-auth-ips --ssh-authorized-ip-ranges]
[--ssh-key-value]
[--tags]
[--validate]
示例
PutProvisionedCluster
az aksarc create --resource-group sample-rg --custom-location sample-cl --name sample-aksarccluster --vnet-ids "vnet-arm-id"
必需参数
用于预配群集的自定义位置的名称或 ID。
预配群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
aksarc 虚拟网络或 Azure 本地逻辑网络的 ARM 资源 ID。
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
将在预配群集上设置为群集管理员的 aad 组对象 ID 的逗号分隔列表。
用于配置群集自动缩放程序的键=值对的空间分隔列表。 传递空字符串以清除配置文件。
控制平面节点数。
Kubernetes APIServer IPAddress。 IPAddress 应可从 Azure 资源桥设备路由,VM.It 应是所引用的网络子网的一部分。如果传递不可路由的 IPAddress,群集创建可能会失败或超时。
控制平面的 VM 大小。
为预配的群集禁用 NFS 驱动程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
禁用预配群集的 SMB 驱动程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集启用 Azure 混合用户权益(AHUB)。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集启用 AI 工具链作员。
| 属性 | 值 |
|---|---|
| 默认值: | False |
启用 Azure RBAC 以控制群集上的授权检查。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集启用群集自动缩放程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
启用 OIDC 颁发者。
| 属性 | 值 |
|---|---|
| 默认值: | False |
启用工作负荷标识加载项。
| 属性 | 值 |
|---|---|
| 默认值: | False |
预配群集的网关 Arm ID。
如果不存在,请生成 ssh 密钥对。
| 属性 | 值 |
|---|---|
| 默认值: | False |
预配群集的 kubernetes 版本。
负载均衡器节点数。
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
自动缩放的最大节点数。
可在节点上运行的 Pod 的最大数目。
自动缩放的最小节点数。
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | False |
在 nodepool 中创建的节点数。
| 属性 | 值 |
|---|---|
| 默认值: | 1 |
节点池中节点的 VM 大小。
空格分隔的标签:key[=value] [key[=value] ...]。
节点池污点的逗号分隔列表。
CIDR 表示法 IP 范围,从中分配 Pod IP。
允许通过 SSH 连接到群集 VM 的 IP 地址或 CIDR 的逗号分隔列表。
要注入控制平面的 ssh 公钥的路径。
| 属性 | 值 |
|---|---|
| 默认值: | ~\.ssh\id_rsa.pub |
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
在不实际创建群集的情况下验证群集的输入参数。
| 属性 | 值 |
|---|---|
| 默认值: | 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 aksarc delete
删除预配的群集。
az aksarc delete --name
--resource-group
[--no-wait]
[--yes]
示例
DeleteProvisionedCluster
az aksarc delete --name "sample-aksarccluster" --resource-group "sample-rg"
必需参数
预配群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | 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 aksarc get-credentials
获取预配群集的本地 kubeconfig。
az aksarc get-credentials --name
--resource-group
[--admin]
[--context]
[--file]
[--overwrite-existing]
示例
GetAdminCredential
az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg" --admin
GetAADUserCredential
az aksarc get-credentials --name "sample-aksarccluster" --resource-group "sample-rg"
必需参数
预配群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
获取群集管理员凭据。
| 属性 | 值 |
|---|---|
| 默认值: | False |
如果指定,请覆盖默认上下文名称。
要更新的 Kubernetes 配置文件。 如果未提供,请更新文件“~/.kube/config”。
| 属性 | 值 |
|---|---|
| 默认值: | ~\.kube\config |
覆盖具有相同名称的任何现有群集条目。
| 属性 | 值 |
|---|---|
| 默认值: | 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 aksarc get-logs
从预配的群集和底层基础结构收集日志。
az aksarc get-logs [--credentials-dir --ssh-key]
[--ip --ips]
[--kubeconfig]
[--out-dir]
示例
使用 IP 地址和 SSH 凭据收集日志
az aksarc get-logs --ip 192.168.200.31 192.168.200.32 --ssh-key ~/.ssh --out-dir ./logs
使用 kubeconfig 和 SSH 凭据收集日志,kubeconfig 仅用于收集 IP 地址,并使用 ssh 密钥文件路径而不是目录
az aksarc get-logs --kubeconfig ~/.kube/config --ssh-key ~/.ssh/id_rsa --out-dir ./logs
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
用于连接到节点的 SSH 凭据的路径,id_rsa文件或目录都将被接受。
需要从中收集日志的节点(控制平面节点或工作器节点)的 IP 地址。
要连接到群集的 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 aksarc get-upgrades
获取可用于预配群集的升级版本。
az aksarc get-upgrades --name
--resource-group
示例
获取可用于混合 AKS 预配群集的升级版本
az aksarc get-upgrades --name "samplecluster" --resource-group "sample-rg"
必需参数
预配群集的名称。
资源组的名称。 可以使用 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 aksarc get-versions
列出指定自定义位置中支持的 Kubernetes 版本。
az aksarc get-versions --custom-location
[--resource-group]
示例
VMListSkus
az aksarc get-versions -g sample-rg --custom-location sample-cl
必需参数
用于显示支持的 k8s 版本的自定义位置的名称。
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
资源组的名称。 可以使用 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 aksarc list
列出资源组或订阅中预配的群集。
az aksarc list [--resource-group]
示例
ListProvisionedClusterByResourceGroup
az aksarc list --resource-group "sample-rg"
ListProvisionedClusterBySubscription
az aksarc list
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
资源组的名称。 可以使用 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 aksarc notice
将 NOTICE 文件输出到用户指定的文件路径。
az aksarc notice --output-filepath
示例
GetNoticeFile
az aksarc notice --output-filepath "./Notice"
必需参数
通知文件的输出文件路径。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | 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 aksarc show
获取预配的群集。
az aksarc show --name
--resource-group
示例
GetProvisionedCluster
az aksarc show --name "sample-aksarccluster" --resource-group "sample-rg"
必需参数
预配群集的名称。
资源组的名称。 可以使用 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 aksarc update
更新预配的群集。
az aksarc update --name
--resource-group
[--aad-admin-group-object-ids]
[--ca-profile --cluster-autoscaler-profile]
[--control-plane-count --control-plane-node-count]
[--disable-ahub]
[--disable-ai-toolchain-operator --disable-kaito]
[--disable-cluster-autoscaler]
[--disable-gateway]
[--disable-nfs-driver]
[--disable-smb-driver]
[--enable-ahub]
[--enable-ai-toolchain-operator --enable-kaito]
[--enable-cluster-autoscaler]
[--enable-nfs-driver]
[--enable-smb-driver]
[--gateway-id]
[--max-count]
[--min-count]
[--tags]
[--update-cluster-autoscaler]
示例
UpdateProvisionedCluster
az aksarc update --tags additionalProperties="sample" --name "sample-aksarccluster" --resource-group "sample-rg"
为预配的群集启用 Azure 混合用户权益功能。
az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --enable-ahub
为预配的群集禁用 Azure 混合用户权益功能。
az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg"--disable-ahub
纵向扩展控制平面节点。
az aksarc update --name "sample-aksarccluster" --resource-group "sample-rg" --control-plane-node-count 5
必需参数
预配群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
将在预配群集上设置为群集管理员的 aad 组对象 ID 的逗号分隔列表。
用于配置群集自动缩放程序的键=值对的空间分隔列表。 传递空字符串以清除配置文件。
要缩放控制平面的节点数。
为预配的群集禁用 Azure 混合用户权益(AHUB)。
| 属性 | 值 |
|---|---|
| 默认值: | False |
禁用预配群集的 AI 工具链作员。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集禁用群集自动缩放程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
禁用预配群集的网关。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集禁用 NFS 驱动程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
禁用预配群集的 SMB 驱动程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集启用 Azure 混合用户权益(AHUB)。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集启用 AI 工具链作员。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集启用群集自动缩放程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集启用 NFS 驱动程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
为预配的群集启用 SMB 驱动程序。
| 属性 | 值 |
|---|---|
| 默认值: | False |
预配群集的网关 Arm ID。
自动缩放的最大节点数。
自动缩放的最小节点数。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
更新预配群集的群集自动缩放程序。
| 属性 | 值 |
|---|---|
| 默认值: | 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 aksarc upgrade
升级预配的群集。
az aksarc upgrade --name
--resource-group
[--kubernetes-version]
[--no-wait]
[--yes]
示例
UpgradeProvisionedCluster
az aksarc upgrade --name "sample-aksarccluster" --resource-group "sample-rg" --kubernetes-version "1.22.2"
必需参数
预配群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
以下参数是可选的,但根据上下文,命令可能需要一个或多个参数才能成功执行。
预配群集的 kubernetes 版本。
不等待长时间运行的操作完成。
| 属性 | 值 |
|---|---|
| 默认值: | 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 |