你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az aksarc

注意

此参考是 Azure CLI（版本 2.32.0 或更高版本）的 aksarc 扩展的一部分。 该扩展将在首次运行 az aksarc 命令时自动安装。 详细了解扩展。

管理预配的群集。

命令

名称	说明	类型	Status
az aksarc create	创建预配的群集。	分机	GA
az aksarc delete	删除预配的群集。	分机	GA
az aksarc get-credentials	获取预配群集的本地 kubeconfig。	分机	GA
az aksarc get-upgrades	获取可用于预配群集的升级版本。	分机	GA
az aksarc get-versions	列出指定自定义位置中支持的 Kubernetes 版本。	分机	GA
az aksarc list	列出资源组或订阅中预配的群集。	分机	GA
az aksarc logs	从预配的群集收集日志。	分机	GA
az aksarc logs hci	从 HCI 环境中的预配群集收集日志。	分机	GA
az aksarc nodepool	管理预配群集中的节点池。	分机	GA
az aksarc nodepool add	在预配的群集中添加节点池。	分机	GA
az aksarc nodepool delete	删除预配群集中的节点池。	分机	GA
az aksarc nodepool list	列出预配群集中的所有节点池。	分机	GA
az aksarc nodepool scale	在预配的群集中缩放节点池。	分机	GA
az aksarc nodepool show	获取预配群集中的节点池。	分机	GA
az aksarc nodepool update	更新预配群集中的节点池。	分机	GA
az aksarc notice	将 NOTICE 文件输出到用户指定的文件路径。	分机	GA
az aksarc release	管理预配群集的 VHD 映像。	分机	预览
az aksarc release download	从发布下载 VHD 映像。	分机	预览
az aksarc release save	将下载的 VHD 映像预配到 arc 资源桥。	分机	预览
az aksarc show	获取预配的群集。	分机	GA
az aksarc update	更新预配的群集。	分机	GA
az aksarc upgrade	升级预配的群集。	分机	GA
az aksarc vmsize	管理预配群集的虚拟机 SKU。	分机	GA
az aksarc vmsize list	列出指定自定义位置中支持的虚拟机大小。	分机	GA
az aksarc vnet	管理预配群集的虚拟网络。	分机	GA
az aksarc vnet create	创建虚拟网络。	分机	GA
az aksarc vnet delete	删除虚拟网络。	分机	GA
az aksarc vnet list	按资源组或订阅列出虚拟网络。	分机	GA
az aksarc vnet show	获取虚拟网络。	分机	GA

az aksarc create

创建预配的群集。

az aksarc create --custom-location
                 --name
                 --resource-group
                 --vnet-id
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-azure-rbac]
                 [--enable-cluster-autoscaler]
                 [--enable-oidc-issuer]
                 [--enable-wi]
                 [--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-key-value]
                 [--tags]

示例

PutProvisionedCluster

az aksarc create --resource-group sample-rg --custom-location sample-cl --name sample-aksarccluster --vnet-ids "vnet-arm-id"

必需参数

--custom-location

用于预配群集的自定义位置的名称或 ID。

--name -n

预配群集的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--vnet-id --vnet-ids

aksarc 虚拟网络或 Azure Stack HCI 逻辑网络的 ARM 资源 ID。

可选参数

--aad-admin-group-object-ids -i

将在预配群集上设置为群集管理员的 aad 组对象 ID 的逗号分隔列表。

--ca-profile --cluster-autoscaler-profile

用于配置群集自动缩放程序的键=值对的空间分隔列表。 传递空字符串以清除配置文件。

--control-plane-count --control-plane-node-count

控制平面节点数。

--control-plane-ip

Kubernetes APIServer IPAddress。 IPAddress 应可从 Azure 资源桥设备路由，VM.It 应是所引用的网络子网的一部分。如果传递不可路由的 IPAddress，群集创建可能会失败或超时。

--control-plane-vm-size

控制平面的 VM 大小。

--disable-nfs-driver

为预配的群集禁用 NFS 驱动程序。

默认值: False

--disable-smb-driver

禁用预配群集的 SMB 驱动程序。

默认值: False

--enable-ahub

为预配的群集启用 Azure 混合用户权益（AHUB）。

默认值: False

--enable-azure-rbac

启用 Azure RBAC 以控制群集上的授权检查。

默认值: False

--enable-cluster-autoscaler -e

为预配的群集启用群集自动缩放程序。

默认值: False

--enable-oidc-issuer

启用 OIDC 颁发者。

默认值: False

--enable-wi --enable-workload-identity

启用工作负荷标识加载项。

默认值: False

--gateway-id

预配群集的网关 Arm ID。

--generate-ssh-keys

如果不存在，请生成 ssh 密钥对。

默认值: False

--kubernetes-version -k

预配群集的 kubernetes 版本。

--load-balancer-count

负载均衡器节点数。

--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--max-count

自动缩放的最大节点数。

--max-pods -m

可在节点上运行的 Pod 的最大数目。

--min-count

自动缩放的最小节点数。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--node-count -c

在 nodepool 中创建的节点数。

默认值: 1

--node-vm-size

节点池中节点的 VM 大小。

--nodepool-labels

空格分隔的标签：key[=value] [key[=value] ...]。

--nodepool-taints

节点池污点的逗号分隔列表。

--pod-cidr

CIDR 表示法 IP 范围，从中分配 Pod IP。

--ssh-auth-ips --ssh-authorized-ip-ranges

允许通过 SSH 连接到群集 VM 的 IP 地址或 CIDR 的逗号分隔列表。

--ssh-key-value

要注入控制平面的 ssh 公钥的路径。

默认值: ~\.ssh\id_rsa.pub

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az aksarc delete

删除预配的群集。

az aksarc delete --name
                 --resource-group
                 [--no-wait]
                 [--yes]

示例

DeleteProvisionedCluster

az aksarc delete --name "sample-aksarccluster" --resource-group "sample-rg"

必需参数

--name -n

预配群集的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

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"

必需参数

--name -n

预配群集的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--admin -a

获取群集管理员凭据。

默认值: False

--context

如果指定，请覆盖默认上下文名称。

--file -f

要更新的 Kubernetes 配置文件。 如果未提供，请更新文件“~/.kube/config”。

默认值: ~\.kube\config

--overwrite-existing

覆盖具有相同名称的任何现有群集条目。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az aksarc get-upgrades

获取可用于预配群集的升级版本。

az aksarc get-upgrades --name
                       --resource-group

示例

获取可用于混合 AKS 预配群集的升级版本

az aksarc get-upgrades --name "samplecluster" --resource-group "sample-rg"

必需参数

--name -n

预配群集的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

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

必需参数

--custom-location

用于显示支持的 k8s 版本的自定义位置的名称。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az aksarc list

列出资源组或订阅中预配的群集。

az aksarc list [--resource-group]

示例

ListProvisionedClusterByResourceGroup

az aksarc list --resource-group "sample-rg"

ListProvisionedClusterBySubscription

az aksarc list

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az aksarc notice

将 NOTICE 文件输出到用户指定的文件路径。

az aksarc notice --output-filepath

示例

GetNoticeFile

az aksarc notice --output-filepath "./Notice"

必需参数

--output-filepath

通知文件的输出文件路径。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az aksarc show

获取预配的群集。

az aksarc show --name
               --resource-group

示例

GetProvisionedCluster

az aksarc show --name "sample-aksarccluster" --resource-group "sample-rg"

必需参数

--name -n

预配群集的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az aksarc update

更新预配的群集。

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--ca-profile]
                 [--control-plane-count]
                 [--disable-ahub]
                 [--disable-cluster-autoscaler]
                 [--disable-gateway]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--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

必需参数

--name -n

预配群集的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--aad-admin-group-object-ids -i

将在预配群集上设置为群集管理员的 aad 组对象 ID 的逗号分隔列表。

--ca-profile --cluster-autoscaler-profile

用于配置群集自动缩放程序的键=值对的空间分隔列表。 传递空字符串以清除配置文件。

--control-plane-count --control-plane-node-count

要缩放控制平面的节点数。

--disable-ahub

为预配的群集禁用 Azure 混合用户权益（AHUB）。

默认值: False

--disable-cluster-autoscaler -d

为预配的群集禁用群集自动缩放程序。

默认值: False

--disable-gateway

禁用预配群集的网关。

默认值: False

--disable-nfs-driver

为预配的群集禁用 NFS 驱动程序。

默认值: False

--disable-smb-driver

禁用预配群集的 SMB 驱动程序。

默认值: False

--enable-ahub

为预配的群集启用 Azure 混合用户权益（AHUB）。

默认值: False

--enable-cluster-autoscaler -e

为预配的群集启用群集自动缩放程序。

默认值: False

--enable-nfs-driver

为预配的群集启用 NFS 驱动程序。

默认值: False

--enable-smb-driver

为预配的群集启用 SMB 驱动程序。

默认值: False

--gateway-id

预配群集的网关 Arm ID。

--max-count

自动缩放的最大节点数。

--min-count

自动缩放的最小节点数。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

--update-cluster-autoscaler -u

更新预配群集的群集自动缩放程序。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

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"

必需参数

--name -n

预配群集的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--kubernetes-version -k

预配群集的 kubernetes 版本。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--yes

用于禁用确认提示的标志。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。