az aksarc

注意

此參考是 Azure CLI 的 aksarc 擴充功能的一部分（2.32.0 版或更高版本）。 擴充功能會在您第一次執行 az aksarc 命令時自動安裝。 深入了解擴充功能。

管理布建的叢集。

命令

名稱	Description	類型	狀態
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	在布建的叢集中新增 nodepool。	副檔名	GA
az aksarc nodepool delete	刪除布建叢集中的 nodepool。	副檔名	GA
az aksarc nodepool list	列出布建叢集中的所有節點集區。	副檔名	GA
az aksarc nodepool scale	調整布建叢集中的 nodepool。	副檔名	GA
az aksarc nodepool show	取得布建叢集中的 nodepool。	副檔名	GA
az aksarc nodepool update	更新布建叢集中的 nodepool。	副檔名	GA
az aksarc notice	將 NOTICE 檔案輸出至使用者指定的 filepath。	副檔名	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

要用於布建叢集之自定義位置的名稱或標識碼。

--name -n

布建叢集的名稱。

--resource-group -g

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

--vnet-id --vnet-ids

aksarc 虛擬網路或 Azure Stack HCI 邏輯網路的 ARM 資源識別碼。

選擇性參數

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

將在布建叢集上設定為叢集管理員之 aad 群組物件標識碼的逗號分隔清單。

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

用於設定叢集自動調整程式之索引鍵=值組的空間分隔清單。 傳遞空字串以清除配置檔。

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

控制平面節點的數目。

--control-plane-ip

Kubernetes APIServer IPAddress。 IPAddress 應可從 Azure Resource Bridge Appliance 路由傳送，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標識碼。

--generate-ssh-keys

如果不存在，請產生 ssh 金鑰組。

預設值: False

--kubernetes-version -k

布建叢集的 kubernetes 版本。

--load-balancer-count

負載平衡器節點數目。

--location -l

位置。​​ 值的來源：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

nodepool 中節點的 VM 大小。

--nodepool-labels

以空格分隔的標籤：key[=value] [key[=value] ...]。

--nodepool-taints

以逗號分隔的 nodepool 污點清單。

--pod-cidr

要從中指派 Pod IP 的 CIDR 表示法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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az aksarc notice

將 NOTICE 檔案輸出至使用者指定的 filepath。

az aksarc notice --output-filepath

範例

GetNoticeFile

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

必要參數

--output-filepath

針對 NOTICE 檔案輸出 filepath。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

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

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 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 群組物件標識碼的逗號分隔清單。

--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標識碼。

--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

訂用帳戶的名稱或識別碼。 您可以使用 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

訂用帳戶的名稱或識別碼。 您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。