您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

az connectedk8s

备注

此引用是 Azure CLI 的 connectedk8s 扩展的一部分,需要2.16.0 或更高版本。 首次运行 az connectedk8s 命令时,该扩展将自动安装。 详细了解扩展。

用于管理连接的 kubernetes 群集的命令。

命令

az connectedk8s connect

将连接的 kubernetes 群集载入 azure。

az connectedk8s delete

删除连接的 kubernetes 群集以及连接的群集代理。

az connectedk8s disable-features

禁用连接的群集上的选择性功能。

az connectedk8s enable-features

启用连接的群集上的选择性功能。

az connectedk8s list

列出连接的 kubernetes 群集。

az connectedk8s proxy

获取对已连接的 kubernetes 群集的访问权限。

az connectedk8s show

显示连接的 kubernetes 群集的详细信息。

az connectedk8s update

更新载入代理的属性。

az connectedk8s upgrade

以原子方式将载入代理升级到特定版本或默认为最新版本。

az connectedk8s connect

将连接的 kubernetes 群集载入 azure。

az connectedk8s connect --name
                        --resource-group
                        [--custom-locations-oid]
                        [--disable-auto-upgrade]
                        [--distribution {aks, aks_engine, aks_management, aks_workload, auto, capz, eks, generic, gke, k3s, kind, minikube, openshift, rancher_rke, tkg}]
                        [--infrastructure {auto, aws, azure, azure_stack_edge, azure_stack_hci, azure_stack_hub, gcp, generic, vsphere, windows_server}]
                        [--kube-config]
                        [--kube-context]
                        [--location]
                        [--no-wait]
                        [--proxy-cert]
                        [--proxy-http]
                        [--proxy-https]
                        [--proxy-skip-range]
                        [--tags]

示例

使用默认的 kube config 和 kube 上下文载入连接的 kubernetes 群集。

az connectedk8s connect -g resourceGroupName -n connectedClusterName

使用默认的 kube config 和 kube 上下文载入连接的 kubernetes 群集,并禁用 arc 代理的自动升级。

az connectedk8s connect -g resourceGroupName -n connectedClusterName --disable-auto-upgrade

通过指定 kubeconfig 和 kubecontext 板载连接的 kubernetes 群集。

az connectedk8s connect -g resourceGroupName -n connectedClusterName --kube-config /path/to/kubeconfig --kube-context kubeContextName

通过指定 https 代理、http 代理、无代理设置,载入连接的 kubernetes 群集。

az connectedk8s connect -g resourceGroupName -n connectedClusterName --proxy-https https://proxy-url --proxy-http http://proxy-url --proxy-skip-range excludedIP,excludedCIDR,exampleCIDRfollowed,10.0.0.0/24

通过指定 https 代理、http 代理、没有证书设置的代理,载入连接的 kubernetes 群集。

az connectedk8s connect -g resourceGroupName -n connectedClusterName --proxy-cert /path/to/crt --proxy-https https://proxy-url --proxy-http http://proxy-url --proxy-skip-range excludedIP,excludedCIDR,exampleCIDRfollowed,10.0.0.0/24

必需参数

--name -n

连接的群集的名称。

--resource-group -g

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

可选参数

--custom-locations-oid

"自定义位置" 应用的 OID。

--disable-auto-upgrade

用于禁用 arc 代理自动升级的标志。

--distribution

将在此连接的群集上运行的 Kubernetes 分发。

接受的值: aks, aks_engine, aks_management, aks_workload, auto, capz, eks, generic, gke, k3s, kind, minikube, openshift, rancher_rke, tkg
默认值: auto
--infrastructure

此连接群集所代表的 Kubernetes 群集将在其上运行的基础结构。

接受的值: auto, aws, azure, azure_stack_edge, azure_stack_hci, azure_stack_hub, gcp, generic, vsphere, windows_server
默认值: auto
--kube-config

Kube 配置文件的路径。

--kube-context

当前计算机中的 Kubconfig 上下文。

--location -l

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

--no-wait

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

--proxy-cert

代理证书文件的路径。

--proxy-http

要使用的 Http 代理 URL。

--proxy-https

要使用的 Https 代理 URL。

--proxy-skip-range

不应使用代理的 Url/CIDRs 的列表。

--tags

空格分隔标记:键 [= 值] [键 [= 值] ...]。使用 "" 清除现有标记。

az connectedk8s delete

删除连接的 kubernetes 群集以及连接的群集代理。

az connectedk8s delete --name
                       --resource-group
                       [--kube-config]
                       [--kube-context]
                       [--no-wait]
                       [--yes]

示例

使用默认的 kubeconfig 和 kubecontext 删除连接的 kubernetes 群集和连接的群集代理。

az connectedk8s delete -g resourceGroupName -n connectedClusterName

通过指定连接的群集代理删除的 kubeconfig 和 kubecontext,删除连接的 kubernetes 群集。

az connectedk8s delete -g resourceGroupName -n connectedClusterName --kube-config /path/to/kubeconfig --kube-context kubeContextName

必需参数

--name -n

连接的群集的名称。

--resource-group -g

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

可选参数

--kube-config

Kube 配置文件的路径。

--kube-context

当前计算机中的 Kubconfig 上下文。

--no-wait

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

--yes -y

不提示确认。

az connectedk8s disable-features

禁用连接的群集上的选择性功能。

az connectedk8s disable-features --features {azure-rbac, cluster-connect, custom-locations}
                                 --name
                                 --resource-group
                                 [--kube-config]
                                 [--kube-context]
                                 [--yes]

示例

禁用 azure rbac 功能。

az connectedk8s disable-features -n clusterName -g resourceGroupName --features azure-rbac

禁用多个功能。

az connectedk8s disable-features -n clusterName -g resourceGroupName --features custom-locations azure-rbac

必需参数

--features

要禁用的功能的空格分隔列表。

接受的值: azure-rbac, cluster-connect, custom-locations
--name -n

连接的群集的名称。

--resource-group -g

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

可选参数

--kube-config

Kube 配置文件的路径。

--kube-context

当前计算机中的 Kubconfig 上下文。

--yes -y

不提示确认。

az connectedk8s enable-features

启用连接的群集上的选择性功能。

az connectedk8s enable-features --features {azure-rbac, cluster-connect, custom-locations}
                                --name
                                --resource-group
                                [--app-id]
                                [--app-secret]
                                [--custom-locations-oid]
                                [--kube-config]
                                [--kube-context]
                                [--skip-azure-rbac-list]

示例

启用 Cluster-Connect 功能。

az connectedk8s enable-features -n clusterName -g resourceGroupName --features cluster-connect

启用 Azure RBAC 功能。

az connectedk8s enable-features -n clusterName -g resourceGroupName --features azure-rbac --app-id appID --app-secret="appSecret" --skip-azure-rbac-list "user1@domain.com,spn_oid"

启用多个功能。

az connectedk8s enable-features -n clusterName -g resourceGroupName --features cluster-connect custom-locations

必需参数

--features

要启用的功能的空格分隔列表。

接受的值: azure-rbac, cluster-connect, custom-locations
--name -n

连接的群集的名称。

--resource-group -g

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

可选参数

--app-id

用于启用 Azure RBAC 的应用程序 ID。 启用 azure-rbac 时指定。

--app-secret

用于启用 Azure RBAC 的应用程序机密。 启用 azure-rbac 时指定。

--custom-locations-oid

"自定义位置" 应用的 OID。

--kube-config

Kube 配置文件的路径。

--kube-context

当前计算机中的 Kubconfig 上下文。

--skip-azure-rbac-list

用户名/电子邮件/oid 的名称的逗号分隔列表。 将跳过这些用户的 Azure RBAC。 启用 azure-rbac 时指定。

az connectedk8s list

列出连接的 kubernetes 群集。

az connectedk8s list [--resource-group]

示例

列出资源组中所有已连接的 kubernetes 群集。

az connectedk8s list -g resourceGroupName --subscription subscriptionName

列出订阅中的所有已连接 kubernetes 群集。

az connectedk8s list --subscription subscriptionName

可选参数

--resource-group -g

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

az connectedk8s proxy

获取对已连接的 kubernetes 群集的访问权限。

az connectedk8s proxy --name
                      --resource-group
                      [--file]
                      [--kube-context]
                      [--port]
                      [--token]

示例

获取对已连接的 kubernetes 群集的访问权限。

az connectedk8s proxy -n clusterName -g resourceGroupName

使用自定义端口访问连接的 kubernetes 群集

az connectedk8s proxy -n clusterName -g resourceGroupName --port portValue

使用服务帐户令牌访问连接的 kubernetes 群集

az connectedk8s proxy -n clusterName -g resourceGroupName --token tokenValue

通过指定自定义 kubeconfig 位置获取对已连接 kubernetes 群集的访问权限

az connectedk8s proxy -n clusterName -g resourceGroupName -f path/to/kubeconfig

通过指定自定义上下文来获取对已连接 kubernetes 群集的访问权限

az connectedk8s proxy -n clusterName -g resourceGroupName --kube-context contextName

必需参数

--name -n

连接的群集的名称。

--resource-group -g

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

可选参数

--file -f

要更新的 Kubernetes 配置文件。 如果未提供,则更新文件 "~/.kube/config"。 使用 "-" 可以改为将 YAML 打印到 stdout。

默认值: ~/.kube/config
--kube-context

如果已指定,则覆盖默认上下文名称。

--port

用于访问已连接群集的端口。

默认值: 47011
--token

用于向 kubernetes 群集进行身份验证的服务帐户标记。

az connectedk8s show

显示连接的 kubernetes 群集的详细信息。

az connectedk8s show --name
                     --resource-group

示例

显示连接的 kubernetes 群集的详细信息

az connectedk8s show -g resourceGroupName -n connectedClusterName

必需参数

--name -n

连接的群集的名称。

--resource-group -g

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

az connectedk8s update

更新载入代理的属性。

az connectedk8s update --name
                       --resource-group
                       [--auto-upgrade {false, true}]
                       [--disable-proxy]
                       [--kube-config]
                       [--kube-context]
                       [--proxy-cert]
                       [--proxy-http]
                       [--proxy-https]
                       [--proxy-skip-range]

示例

更新代理的代理值

az connectedk8s update -g resourceGroupName -n connectedClusterName  --proxy-cert /path/to/crt --proxy-https https://proxy-url --proxy-http http://proxy-url --proxy-skip-range excludedIP,excludedCIDR,exampleCIDRfollowed,10.0.0.0/24

禁用代理的代理设置

az connectedk8s update -g resourceGroupName -n connectedClusterName --disable-proxy

禁用代理的自动升级

az connectedk8s update -g resourceGroupName -n connectedClusterName --auto-upgrade false

必需参数

--name -n

连接的群集的名称。

--resource-group -g

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

可选参数

--auto-upgrade

用于启用/禁用 arc 代理自动升级的标志。 默认情况下,将启用代理的自动升级。

接受的值: false, true
--disable-proxy

禁用代理的代理设置。

--kube-config

kube 配置文件的路径。

--kube-context

当前计算机中的 Kubconfig 上下文。

--proxy-cert

代理的证书文件的路径。

--proxy-http

要使用的 Http 代理 URL。

--proxy-https

要使用的 Https 代理 URL。

--proxy-skip-range

不应使用代理的 URL/CIDR 列表。

az connectedk8s upgrade

以原子方式将载入代理升级到特定版本或默认为最新版本。

az connectedk8s upgrade --name
                        --resource-group
                        [--agent-version]
                        [--kube-config]
                        [--kube-context]

示例

将代理升级到最新版本

az connectedk8s upgrade -g resourceGroupName -n connectedClusterName

将代理升级到特定版本

az connectedk8s upgrade -g resourceGroupName -n connectedClusterName --agent-version 0.2.62

必需参数

--name -n

连接的群集的名称。

--resource-group -g

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

可选参数

--agent-version

要更新 helm 图表的代理版本。

--kube-config

kube 配置文件的路径。

--kube-context

当前计算机中的 Kubconfig 上下文。