az connectedk8s

注意

此參考是 Azure CLI (2.30.0 版或更高版本) 的 connectedk8s 延伸模組的一部分。 當您第一次執行 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 troubleshoot

在已啟用 Arc 的 Kubernetes 叢集上執行診斷檢查。

az connectedk8s update

更新 Arc 上線 Kubernetes 叢集的屬性。

az connectedk8s upgrade

以不可部分完成的方式將上線代理程式升級至特定版本,或預設為最新版本。

az connectedk8s connect

將已連線的 kubernetes 叢集上線至 Azure。

az connectedk8s connect --name
                        --resource-group
                        [--correlation-id]
                        [--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}]
                        [--enable-private-link {false, true}]
                        [--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]
                        [--onboarding-timeout]
                        [--pls-arm-id]
                        [--proxy-cert]
                        [--proxy-http]
                        [--proxy-https]
                        [--proxy-skip-range]
                        [--tags]

範例

使用預設 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 Proxy、HTTP Proxy、無 Proxy 設定,將連線的 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 Proxy、HTTP proxy、沒有具有憑證設定的 Proxy,將連線的 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

必要參數

--name -n

已連線叢集的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--correlation-id

GUID,用來在內部追蹤叢集上線的來源。 除非建議,否則請勿加以修改。

--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
--enable-private-link

旗標,在連線的叢集資源上啟用/停用私人連結支援。 允許的值:false、true。

接受的值: false, true
--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

不等候長時間執行的作業完成。

--onboarding-timeout

) 在 kubernetes 叢集上安裝 arc-agent Pod 所需的時間,以秒為單位 (。 如果您的叢集上的硬體/網路條件約束需要更多時間來安裝 arc-agent Pod,請覆寫此值。

預設值: 600
--pls-arm-id --private-link-scope-resource-id

與此連線叢集相關聯之私人連結範圍資源的 ARM 資源識別碼。

--proxy-cert

Proxy 憑證檔案的路徑。

--proxy-http

要使用的 Http Proxy URL。

--proxy-https

要使用的 Https Proxy URL。

--proxy-skip-range

不應該使用 Proxy 的 URL/CIDR 清單。

--tags

空格分隔標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標籤。

az connectedk8s delete

刪除已連線的 Kubernetes 叢集以及連線的叢集代理程式。

az connectedk8s delete --name
                       --resource-group
                       [--force]
                       [--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> 來設定預設群組。

選擇性參數

--force

強制刪除以從叢集移除所有 azure-arc 資源。

--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 的應用程式識別碼。 啟用 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 troubleshoot

在已啟用 Arc 的 Kubernetes 叢集上執行診斷檢查。

az connectedk8s troubleshoot --name
                             --resource-group
                             [--kube-config]
                             [--kube-context]
                             [--tags]

範例

在已啟用 Arc 的 Kubernetes 叢集上執行診斷檢查。

az connectedk8s troubleshoot -n clusterName -g resourceGroupName

必要參數

--name -n

已連線叢集的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--kube-config

kube 組態檔的路徑。

--kube-context

來自目前電腦的 Kubconfig 內容。

--tags

空格分隔標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標籤。

az connectedk8s update

更新 Arc 上線 Kubernetes 叢集的屬性。

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]
                       [--tags]

範例

更新代理程式的 Proxy 值

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

停用代理程式的 Proxy 設定

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

停用代理程式的 Proxy 設定。

--kube-config

kube 組態檔的路徑。

--kube-context

來自目前電腦的 Kubconfig 內容。

--proxy-cert

Proxy 和) 的任何其他憑證檔案路徑 (。

--proxy-http

要使用的 Http Proxy URL。

--proxy-https

要使用的 Https Proxy URL。

--proxy-skip-range

不應該使用 Proxy 的 URL/CIDR 清單。

--tags

空格分隔標記:key[=value] [key[=value] ...]。使用 「」 清除現有的標籤。

az connectedk8s upgrade

以不可部分完成的方式將上線代理程式升級至特定版本,或預設為最新版本。

az connectedk8s upgrade --name
                        --resource-group
                        [--agent-version]
                        [--kube-config]
                        [--kube-context]
                        [--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

必要參數

--name -n

已連線叢集的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--agent-version

要更新 Helm 圖表的代理程式版本。

--kube-config

kube 組態檔的路徑。

--kube-context

來自目前電腦的 Kubconfig 內容。

--upgrade-timeout

) kubernetes 叢集上升級 arc-agent Pod 所需的時間,以秒為單位 (。 如果您的叢集上的硬體/網路條件約束需要更多時間來升級 arc-agent Pod,請覆寫此值。

預設值: 600