az aksarc

Note

此參考是Azure CLIaksarc擴充套件(版本 2.77.0 或更高版本)的一部分。 擴充功能會在您第一次執行 az aksarc 命令時自動安裝。 深入了解擴充功能。

管理布建的叢集。

命令

名稱 Description 類型 狀態
az aksarc create

建立布建的叢集。

Extension GA
az aksarc delete

刪除布建的叢集。

Extension GA
az aksarc deploy

將完整的 AKS 裸金屬叢集部署到一個或多個現有的 Arc-for-Server(裸機)主機上。

Extension GA
az aksarc get-credentials

取得已布建叢集的本機 kubeconfig。

Extension GA
az aksarc get-logs

從布建的叢集和基礎結構收集記錄。

Extension GA
az aksarc get-upgrades

取得已布建叢集可用的升級版本。

Extension GA
az aksarc get-versions

列出指定自定義位置中支援的 Kubernetes 版本。

Extension GA
az aksarc list

列出資源群組或訂用帳戶中布建的叢集。

Extension GA
az aksarc logs

Deprecated. 請改用 『az aksarc get-logs』。

Extension GA
az aksarc logs hci

從布建的叢集和基礎結構收集記錄。

Extension Deprecated
az aksarc nodepool

管理布建叢集中的節點集區。

Extension GA
az aksarc nodepool add

在布建的叢集中新增 nodepool。

Extension GA
az aksarc nodepool delete

刪除布建叢集中的 nodepool。

Extension GA
az aksarc nodepool list

列出布建叢集中的所有節點集區。

Extension GA
az aksarc nodepool scale

調整布建叢集中的 nodepool。

Extension GA
az aksarc nodepool show

取得布建叢集中的 nodepool。

Extension GA
az aksarc nodepool update

更新布建叢集中的 nodepool。

Extension GA
az aksarc notice

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

Extension GA
az aksarc release

管理已布建叢集的 VHD 映像。

Extension Preview
az aksarc release download

從版本下載 VHD 映像。

Extension Preview
az aksarc release save

將下載的 VHD 映射布建至 Arc 資源網橋。

Extension Preview
az aksarc show

取得布建的叢集。

Extension GA
az aksarc undeploy

拆除先前由「az aksarc deploy」創建的 AKS 裸金屬叢集。

Extension GA
az aksarc update

更新布建的叢集。

Extension GA
az aksarc upgrade

升級布建的叢集。

Extension GA
az aksarc vmsize

管理已布建叢集的虛擬機 SKU。

Extension GA
az aksarc vmsize list

列出指定之自定義位置中支援的虛擬機大小。

Extension GA
az aksarc vnet

管理已布建叢集的虛擬網路。

Extension GA
az aksarc vnet create

建立虛擬網路。

Extension GA
az aksarc vnet delete

刪除虛擬網路。

Extension GA
az aksarc vnet list

依資源群組或訂用帳戶列出虛擬網路。

Extension GA
az aksarc vnet show

取得虛擬網路。

Extension GA

az aksarc create

建立布建的叢集。

az aksarc create --custom-location
                 --name
                 --resource-group
                 --vnet-id --vnet-ids
                 [--aad-admin-group-object-ids]
                 [--acquire-policy-token]
                 [--ca-certs --custom-ca-trust-certificates]
                 [--ca-profile --cluster-autoscaler-profile]
                 [--change-reference]
                 [--control-plane-count --control-plane-node-count]
                 [--control-plane-ip]
                 [--control-plane-vm-size]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-ai-toolchain-operator --enable-kaito]
                 [--enable-azure-rbac]
                 [--enable-cluster-autoscaler]
                 [--enable-oidc-issuer]
                 [--enable-wi --enable-workload-identity]
                 [--gateway-id]
                 [--generate-ssh-keys]
                 [--gpu-count-per-node]
                 [--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-authorized-ip-ranges]
                 [--ssh-key-value]
                 [--tags]
                 [--validate]

範例

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

ARM resource ID of aksarc virtual network or Azure Local logical network.

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

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

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--ca-certs --custom-ca-trust-certificates

路徑指向包含安全配置檔自訂 CA 信任憑證的檔案。 檔案可包含多個 PEM 格式憑證(最多 10 個)。 每張憑證都會以 base64 編碼,並加入所有節點的信任儲存。

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

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

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--control-plane-count --control-plane-node-count

控制平面節點的數目。

--control-plane-ip

Kubernetes APIServer IPAddress。 IPAddress 應該可以從資源橋接設備(Resource Bridge Appliance)路由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-ai-toolchain-operator --enable-kaito

啟用已布建叢集的 AI 工具鏈作員。

屬性 值
預設值: 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
--gpu-count-per-node

連接到一個節點的 GPU 數量。

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

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] ...]。使用 「清除現有的標記」。

--validate

驗證叢集的輸入參數,而不實際建立叢集。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc delete

刪除布建的叢集。

az aksarc delete --name
                 --resource-group
                 [--acquire-policy-token]
                 [--change-reference]
                 [--no-wait]
                 [--yes]

範例

DeleteProvisionedCluster

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

必要參數

--name -n

布建叢集的名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--no-wait

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

屬性 值
預設值: False
--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc deploy

將完整的 AKS 裸金屬叢集部署到一個或多個現有的 Arc-for-Server(裸機)主機上。

將完整的 AKS 裸金屬叢集部署到一個或多個現有的 Arc-for-Server(裸機)主機上。 唯一需要輸入的是組成叢集的 Arc 啟用機器名稱清單。 主機必須已經啟用 Arc-for-Server。

az aksarc deploy --arc-machine-name --arc-machine-names --machine-names
                 --resource-group
                 [--acquire-policy-token]
                 [--change-reference]
                 [--enable-wi --enable-workload-identity]
                 [--hci-rp-object-id]
                 [--kubernetes-version]
                 [--no-wait]
                 [--validate]
                 [--yes]

範例

部署單節點 AKS 裸金屬叢集

az aksarc deploy --resource-group sample-rg --arc-machine-names myArcHost

部署多節點 AKS 裸金屬叢集

az aksarc deploy --resource-group sample-rg --arc-machine-names host1 host2 host3

啟用 WorkloadIdentity 支援部署

az aksarc deploy --resource-group sample-rg --arc-machine-names myArcHost --enable-workload-identity

部署特定的 Kubernetes 版本化套件

az aksarc deploy --resource-group sample-rg --arc-machine-names myArcHost --kubernetes-version 1.35.5-20260701

部署時不使用 Microsoft Graph 查詢

az aksarc deploy --resource-group sample-rg --arc-machine-names myArcHost --hci-rp-object-id <hci-rp-object-id>

無需部署即可驗證

az aksarc deploy --resource-group sample-rg --arc-machine-names host1 host2 --validate

必要參數

--arc-machine-name --arc-machine-names --machine-names -m

資源群組中現有啟用 Arc(Arc-for-Servers)機器的空間分離名稱,組成叢集裝置池。 單節點池可提供一個,或多節點池提供多個。 這是唯一需要的輸入;其他所有叢集資源皆為自動導出。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--enable-wi --enable-workload-identity

啟用工作負載身份及 Azure IoT 操作 所需的 OIDC 發行者。

屬性 值
預設值: False
--hci-rp-object-id

Microsoft 的租戶專屬物件 ID。AzureStackHCI resource provider service principal. 若省略,CLI 會使用 HCI_RP_OBJECT_ID 設定,然後回退回 Microsoft Graph。

--kubernetes-version -k

叢集的 Kubernetes 版本化套件,例如 1.35.5-20260701。 若省略,AKS Arc 操作員會選擇目前的預設版本。

--no-wait

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

屬性 值
預設值: False
--validate

在沒有實際部署的情況下,驗證部署範本。

屬性 值
預設值: False
--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc get-credentials

取得已布建叢集的本機 kubeconfig。

az aksarc get-credentials --name
                          --resource-group
                          [--acquire-policy-token]
                          [--admin]
                          [--change-reference]
                          [--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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--admin -a

取得叢集系統管理員認證。

屬性 值
預設值: False
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--context

如果指定,請覆寫預設內容名稱。

--file -f

要更新的 Kubernetes 組態檔。 如果未提供,請更新檔案 '~/.kube/config'。

屬性 值
預設值: ~\.kube\config
--overwrite-existing

以相同名稱覆寫任何現有的叢集專案。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc get-logs

從布建的叢集和基礎結構收集記錄。

az aksarc get-logs [--acquire-policy-token]
                   [--change-reference]
                   [--credentials-dir --ssh-key]
                   [--ip --ips]
                   [--kubeconfig]
                   [--out-dir]

範例

使用IP位址和SSH認證收集記錄

az aksarc get-logs --ip 192.168.200.31 192.168.200.32 --ssh-key ~/.ssh --out-dir ./logs

使用 kubeconfig 和 SSH 認證收集記錄、kubeconfig 僅用來收集 IP 位址,並使用 ssh 金鑰檔案路徑來取代目錄

az aksarc get-logs --kubeconfig ~/.kube/config --ssh-key ~/.ssh/id_rsa --out-dir ./logs

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--credentials-dir --ssh-key

接受連線至節點的 SSH 認證路徑,id_rsa檔案或目錄。

--ip --ips

需要從中收集記錄的節點(控制平面節點或背景工作節點)的IP位址。

--kubeconfig

要連線到叢集的 kubeconfig 檔案路徑。

--out-dir

用來儲存所收集記錄的輸出目錄。 如果未指定,記錄會儲存在當前目錄中。

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc get-upgrades

取得已布建叢集可用的升級版本。

az aksarc get-upgrades --name
                       --resource-group
                       [--acquire-policy-token]
                       [--change-reference]

範例

取得混合式 AKS 佈建叢集可用的升級版本

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

必要參數

--name -n

布建叢集的名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc get-versions

列出指定自定義位置中支援的 Kubernetes 版本。

az aksarc get-versions --custom-location
                       [--acquire-policy-token]
                       [--change-reference]
                       [--resource-group]

範例

VMListSkus

az aksarc get-versions -g sample-rg --custom-location sample-cl

必要參數

--custom-location

用來顯示支援的 k8s 版本的自訂位置名稱。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--resource-group -g

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

全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

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

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc notice

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

az aksarc notice --output-filepath
                 [--acquire-policy-token]
                 [--change-reference]

範例

GetNoticeFile

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

必要參數

--output-filepath

針對 NOTICE 檔案輸出 filepath。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

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

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc undeploy

拆除先前由「az aksarc deploy」創建的 AKS 裸金屬叢集。

拆除先前由「az aksarc deploy」創建的 AKS 裸金屬叢集,移除所有相關資源。 如果拆解未完成,請重新執行指令以重試。

az aksarc undeploy --arc-machine-name --arc-machine-names --machine-names
                   --resource-group
                   [--acquire-policy-token]
                   [--change-reference]
                   [--yes]

範例

為特定 Arc 機器取消部署 AKS Arc 資源

az aksarc undeploy --resource-group sample-rg --arc-machine-names host1 host2 host3

必要參數

--arc-machine-name --arc-machine-names --machine-names -m

部署 AKS Arc 的 Arc 機器的空格分隔名稱應該被拆除。 資源名稱是自動由它們衍生出來的。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc update

更新布建的叢集。

az aksarc update --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--acquire-policy-token]
                 [--ca-certs --custom-ca-trust-certificates]
                 [--ca-profile --cluster-autoscaler-profile]
                 [--change-reference]
                 [--control-plane-count --control-plane-node-count]
                 [--control-plane-vm-size]
                 [--disable-ahub]
                 [--disable-ai-toolchain-operator --disable-kaito]
                 [--disable-cluster-autoscaler]
                 [--disable-gateway]
                 [--disable-nfs-driver]
                 [--disable-smb-driver]
                 [--enable-ahub]
                 [--enable-ai-toolchain-operator --enable-kaito]
                 [--enable-cluster-autoscaler]
                 [--enable-nfs-driver]
                 [--enable-smb-driver]
                 [--gateway-id]
                 [--max-count]
                 [--min-count]
                 [--tags]
                 [--update-cluster-autoscaler]
                 [--yes]

範例

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 群組物件標識碼的逗號分隔清單。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--ca-certs --custom-ca-trust-certificates

路徑指向包含安全配置檔自訂 CA 信任憑證的檔案。 檔案可包含多個 PEM 格式憑證(最多 10 個)。 每張憑證都會以 base64 編碼,並加入所有節點的信任儲存。

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

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

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--control-plane-count --control-plane-node-count

要調整控制平面的節點數目。

--control-plane-vm-size

控制平面的 VM 大小。

--disable-ahub

為已配置叢集停用 Azure 混合使用者福利(AHUB)。

屬性 值
預設值: False
--disable-ai-toolchain-operator --disable-kaito

停用已布建叢集的 AI 工具鏈作員。

屬性 值
預設值: 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-ai-toolchain-operator --enable-kaito

啟用已布建叢集的 AI 工具鏈作員。

屬性 值
預設值: 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
--yes -y

請勿提示確認。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False

az aksarc upgrade

升級布建的叢集。

az aksarc upgrade --name
                  --resource-group
                  [--acquire-policy-token]
                  [--change-reference]
                  [--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>來設定預設群組。

選擇性參數

下列參數是選擇性參數,但視內容而定,命令可能需要一或多個參數才能成功執行。

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性 值
參數群組: Global Policy Arguments
--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性 值
參數群組: Global Policy Arguments
--kubernetes-version -k

布建叢集的 kubernetes 版本。

--no-wait

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

屬性 值
預設值: False
--yes

停用確認提示的旗標。

屬性 值
預設值: False
全域參數
--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性 值
預設值: False
--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

屬性 值
預設值: False
--output -o

輸出格式。

屬性 值
預設值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

增加記錄的詳細程度。 針對完整偵錯記錄使用 --debug。

屬性 值
預設值: False