你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az connectedk8s
注意
此参考是 Azure CLI 的 connectedk8s 扩展的一部分(版本 2.38.0 或更高版本)。 该扩展将在首次运行 az connectedk8s 命令时自动安装。 详细了解扩展。
用于管理连接的 kubernetes 群集的命令。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
az connectedk8s connect |
将连接的 kubernetes 群集加入 Azure。 |
扩展 | GA |
az connectedk8s delete |
删除连接的 kubernetes 群集以及连接的群集代理。 |
扩展 | GA |
az connectedk8s disable-features |
禁用连接的群集上的选择性功能。 |
扩展 | 预览 |
az connectedk8s enable-features |
在连接的群集上启用选择性功能。 |
扩展 | 预览 |
az connectedk8s list |
列出连接的 kubernetes 群集。 |
扩展 | GA |
az connectedk8s proxy |
获取对连接的 kubernetes 群集的访问权限。 |
扩展 | GA |
az connectedk8s show |
显示连接的 kubernetes 群集的详细信息。 |
扩展 | GA |
az connectedk8s troubleshoot |
对已启用 Arc 的 Kubernetes 群集执行诊断检查。 |
扩展 | 预览 |
az connectedk8s update |
更新 arc 载入 kubernetes 群集的属性。 |
扩展 | GA |
az connectedk8s upgrade |
以原子方式将载入的代理升级到特定版本,或默认升级到最新版本。 |
扩展 | GA |
az connectedk8s connect
将连接的 kubernetes 群集加入 Azure。
az connectedk8s connect --name
--resource-group
[--azure-hybrid-benefit {False, NotApplicable, True}]
[--container-log-path]
[--correlation-id]
[--custom-ca-cert]
[--custom-locations-oid]
[--disable-auto-upgrade]
[--distribution {aks, aks_edge_k3s, aks_edge_k8s, aks_engine, aks_management, aks_workload, canonical, capz, eks, generic, gke, k3s, karbon, kind, minikube, openshift, rancher_rke, tkg}]
[--distribution-version]
[--enable-oidc-issuer {false, true}]
[--enable-private-link {false, true}]
[--enable-wi {false, true}]
[--infrastructure {LTSCWindows 10 Enterprise LTSC, Windows 10 Enterprise, Windows 10 Enterprise LTSC 2019, Windows 10 Enterprise LTSC 2021, Windows 10 Enterprise N, Windows 10 Enterprise N LTSC 2019, Windows 10 Enterprise N LTSC 2021, Windows 10 IoT Enterprise, Windows 10 IoT Enterprise LTSC 2019, Windows 10 IoT Enterprise LTSC 2021, Windows 10 Pro, Windows 11 Enterprise, Windows 11 Enterprise N, Windows 11 IoT Enterprise, Windows 11 Pro, Windows Server 2019, Windows Server 2019 Datacenter, Windows Server 2019 Standard, Windows Server 2022, Windows Server 2022 Datacenter, Windows Server 2022 Standard, aws, azure, azure_stack_edge, azure_stack_hci, azure_stack_hub, gcp, generic, vsphere, windows_server}]
[--kube-config]
[--kube-context]
[--location]
[--no-wait]
[--onboarding-timeout]
[--pls-arm-id]
[--proxy-http]
[--proxy-https]
[--proxy-skip-range]
[--self-hosted-issuer]
[--skip-ssl-verification]
[--tags]
[--yes]
示例
使用默认 kube 配置和 kube 上下文载入连接的 kubernetes 群集。
az connectedk8s connect -g resourceGroupName -n connectedClusterName
使用默认 kube 配置和 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
通过指定专用链接参数,载入连接 Kubernetes 群集,并启用专用链接功能。
az connectedk8s connect -g resourceGroupName -n connectedClusterName --enable-private-link true --private-link-scope-resource-id pls/resource/arm/id
使用自定义载入超时载入连接的 kubernetes 群集。
az connectedk8s connect -g resourceGroupName -n connectedClusterName --onboarding-timeout 600
载入启用了 oidc 颁发者和工作负载标识 Webhook 的连接的 kubernetes 群集。
az connectedk8s connect -g resourceGroupName -n connectedClusterName --enable-oidc-issuer --enable-workload-identity
使用公有云群集的自承载颁发者 URL 载入启用了 oidc 颁发者的连接的 kubernetes 群集。
az connectedk8s connect -g resourceGroupName -n connectedClusterName --enable-oidc-issuer --self-hosted-issuer aksissuerurl
必需参数
已连接的群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
用于启用/禁用Azure 混合权益功能的标志。
重写默认容器日志路径以启用 fluent-bit 日志记录。
用于在内部跟踪群集载入源的 guid。 除非建议,否则请不要修改。
代理或自定义证书颁发机构的证书文件的路径。
“custom-locations”应用的 OID。
用于禁用 Arc 代理自动升级的标志。
将在此连接的群集上运行的 Kubernetes 分发版。
连接的群集的 Kubernetes 分发版本。
启用用于工作负荷标识的 OIDC 颁发者 URL 的创建。
在连接的群集资源上启用/禁用专用链接支持的标志。 允许的值:false、true。
启用工作负荷标识 Webhook。
此连接的群集所表示的 Kubernetes 群集将在此基础结构上运行。
kube 配置文件的路径。
当前计算机的 Kubconfig 上下文。
Location。 az account list-locations
中的值。 可以使用 az configure --defaults location=<location>
配置默认位置。
不等待长时间运行的操作完成。
在 kubernetes 群集上安装 arc-agent pod 所需的时间(以秒为单位)。 如果群集上的硬件/网络约束需要更多时间来安装 arc-agent Pod,请重写此值。
与此连接的群集关联的专用链接范围资源的 ARM 资源 ID。
要使用的 Http 代理 URL。
要使用的 Https 代理 URL。
不应为其使用代理的 URL/CIDR 列表。
公有云群集的自承载颁发者 URL - AKS、GKE、EKS。
跳过任何群集连接的 SSL 验证。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s delete
删除连接的 kubernetes 群集以及连接的群集代理。
az connectedk8s delete [--force]
[--ids]
[--kube-config]
[--kube-context]
[--name]
[--no-wait]
[--resource-group]
[--skip-ssl-verification]
[--subscription]
[--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
可选参数
强制删除以从群集中删除所有 azure-arc 资源。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
kube 配置文件的路径。
当前计算机的 Kubconfig 上下文。
已连接的群集的名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
跳过任何群集连接的 SSL 验证。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s disable-features
此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
禁用连接的群集上的选择性功能。
az connectedk8s disable-features --features {azure-rbac, cluster-connect, custom-locations}
[--ids]
[--kube-config]
[--kube-context]
[--name]
[--resource-group]
[--skip-ssl-verification]
[--subscription]
[--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
必需参数
要禁用的功能的空间分隔列表。
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
kube 配置文件的路径。
当前计算机的 Kubconfig 上下文。
已连接的群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
跳过任何群集连接的 SSL 验证。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s enable-features
此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
在连接的群集上启用选择性功能。
az connectedk8s enable-features --features {azure-rbac, cluster-connect, custom-locations}
[--custom-locations-oid]
[--ids]
[--kube-config]
[--kube-context]
[--name]
[--resource-group]
[--skip-azure-rbac-list]
[--skip-ssl-verification]
[--subscription]
示例
启用 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 --skip-azure-rbac-list "user1@domain.com,spn_oid"
启用多个功能。
az connectedk8s enable-features -n clusterName -g resourceGroupName --features cluster-connect custom-locations
必需参数
要启用的功能的空间分隔列表。
可选参数
“custom-locations”应用的 OID。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
kube 配置文件的路径。
当前计算机的 Kubconfig 上下文。
已连接的群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
用户名/电子邮件/oid 名称的逗号分隔列表。 将为这些用户跳过 Azure RBAC。 指定启用 azure-rbac 时。
跳过任何群集连接的 SSL 验证。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s list
列出连接的 kubernetes 群集。
az connectedk8s list [--resource-group]
示例
列出资源组中的所有连接的 kubernetes 群集。
az connectedk8s list -g resourceGroupName --subscription subscriptionName
列出订阅中的所有连接的 kubernetes 群集。
az connectedk8s list --subscription subscriptionName
可选参数
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s proxy
获取对连接的 kubernetes 群集的访问权限。
az connectedk8s proxy [--file]
[--ids]
[--kube-context]
[--name]
[--port]
[--resource-group]
[--subscription]
[--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
可选参数
要更新的 Kubernetes 配置文件。 如果未提供,请更新文件“~/.kube/config”。 改用“-”将 YAML 打印为 stdout。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
如果指定,请覆盖默认上下文名称。
已连接的群集的名称。
用于访问连接的群集的端口。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
用于向 kubernetes 群集进行身份验证的服务帐户令牌。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s show
显示连接的 kubernetes 群集的详细信息。
az connectedk8s show [--ids]
[--name]
[--resource-group]
[--subscription]
示例
显示已连接的 kubernetes 群集的详细信息
az connectedk8s show -g resourceGroupName -n connectedClusterName
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
已连接的群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s troubleshoot
此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
对已启用 Arc 的 Kubernetes 群集执行诊断检查。
az connectedk8s troubleshoot --name
--resource-group
[--kube-config]
[--kube-context]
[--skip-ssl-verification]
[--tags]
示例
对已启用 Arc 的 Kubernetes 群集执行诊断检查。
az connectedk8s troubleshoot -n clusterName -g resourceGroupName
必需参数
已连接的群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
kube 配置文件的路径。
当前计算机的 Kubeconfig 上下文。
跳过任何群集连接的 SSL 验证。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s update
更新 arc 载入 kubernetes 群集的属性。
az connectedk8s update [--auto-upgrade {false, true}]
[--azure-hybrid-benefit {False, NotApplicable, True}]
[--container-log-path]
[--custom-ca-cert]
[--disable-proxy]
[--disable-wi {false, true}]
[--distribution {aks, aks_edge_k3s, aks_edge_k8s, aks_engine, aks_management, aks_workload, canonical, capz, eks, generic, gke, k3s, karbon, kind, minikube, openshift, rancher_rke, tkg}]
[--distribution-version]
[--enable-oidc-issuer {false, true}]
[--enable-wi {false, true}]
[--ids]
[--kube-config]
[--kube-context]
[--name]
[--proxy-http]
[--proxy-https]
[--proxy-skip-range]
[--resource-group]
[--self-hosted-issuer]
[--skip-ssl-verification]
[--subscription]
[--tags]
[--yes]
示例
更新代理的代理值
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
使用已启用 oidc 颁发者和工作负载标识 Webhook 更新连接的 kubernetes 群集。
az connectedk8s update -g resourceGroupName -n connectedClusterName --enable-oidc-issuer --enable-workload-identity
使用公有云群集的自承载颁发者 URL 更新启用了 oidc 颁发者的连接的 kubernetes 群集。
az connectedk8s update -g resourceGroupName -n connectedClusterName --enable-oidc-issuer --self-hosted-issuer aksissuerurl
在连接的 kubernetes 群集上禁用工作负荷标识 Webhook。
az connectedk8s update -g resourceGroupName -n connectedClusterName --disable-workload-identity
可选参数
用于启用/禁用 Arc 代理自动升级的标志。 默认情况下,会自动升级代理。
用于启用/禁用Azure 混合权益功能的标志。
重写默认容器日志路径以启用 fluent-bit 日志记录。
代理或自定义证书颁发机构的证书文件的路径。
禁用代理的代理设置。
禁用工作负荷标识 Webhook。
将在此连接的群集上运行的 Kubernetes 分发版。
连接的群集的 Kubernetes 分发版本。
启用用于工作负荷标识的 OIDC 颁发者 URL 的创建。
启用工作负荷标识 Webhook。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
kube 配置文件的路径。
当前计算机的 Kubconfig 上下文。
已连接的群集的名称。
要使用的 Http 代理 URL。
要使用的 Https 代理 URL。
不应为其使用代理的 URL/CIDR 列表。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
公有云群集的自承载颁发者 URL - AKS、GKE、EKS。
跳过任何群集连接的 SSL 验证。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az connectedk8s upgrade
以原子方式将载入的代理升级到特定版本,或默认升级到最新版本。
az connectedk8s upgrade [--agent-version]
[--ids]
[--kube-config]
[--kube-context]
[--name]
[--resource-group]
[--skip-ssl-verification]
[--subscription]
[--upgrade-timeout]
示例
将代理升级到最新版本
az connectedk8s upgrade -g resourceGroupName -n connectedClusterName
将代理升级到特定版本
az connectedk8s upgrade -g resourceGroupName -n connectedClusterName --agent-version 0.2.62
使用自定义升级超时升级代理。
az connectedk8s upgrade -g resourceGroupName -n connectedClusterName --upgrade-timeout 600
可选参数
要更新 helm 图表的代理版本。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
kube 配置文件的路径。
当前计算机的 Kubconfig 上下文。
已连接的群集的名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
跳过任何群集连接的 SSL 验证。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
在 kubernetes 群集上升级 arc-agent pod 所需的时间(以秒为单位)。 如果群集上的硬件/网络约束需要更多时间来升级 arc-agent Pod,请重写此值。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。