az aksarc

命令

名稱	Description	類型	狀態
az aksarc create	建立布建的叢集。	Extension	GA
az aksarc delete	刪除布建的叢集。	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 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 --custom-location
                 --name
                 --resource-group
                 --vnet-id --vnet-ids
                 [--aad-admin-group-object-ids]
                 [--ca-profile --cluster-autoscaler-profile]
                 [--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]
                 [--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"

必要參數

選擇性參數

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

全域參數

--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 --name
                 --resource-group
                 [--no-wait]
                 [--yes]

範例

DeleteProvisionedCluster

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

必要參數

選擇性參數

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

全域參數

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

必要參數

選擇性參數

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

全域參數

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

選擇性參數

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

全域參數

--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 --name
                       --resource-group

範例

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

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

必要參數

全域參數

--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 --custom-location
                       [--resource-group]

範例

VMListSkus

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

必要參數

選擇性參數

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

全域參數

--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 [--resource-group]

範例

ListProvisionedClusterByResourceGroup

az aksarc list --resource-group "sample-rg"

ListProvisionedClusterBySubscription

az aksarc list

選擇性參數

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

全域參數

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

範例

GetNoticeFile

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

必要參數

全域參數

--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 --name
               --resource-group

範例

GetProvisionedCluster

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

必要參數

全域參數

--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 --name
                 --resource-group
                 [--aad-admin-group-object-ids]
                 [--ca-profile --cluster-autoscaler-profile]
                 [--control-plane-count --control-plane-node-count]
                 [--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]

範例

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

必要參數

選擇性參數

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

全域參數

--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 --name
                  --resource-group
                  [--kubernetes-version]
                  [--no-wait]
                  [--yes]

範例

UpgradeProvisionedCluster

az aksarc upgrade --name "sample-aksarccluster" --resource-group "sample-rg" --kubernetes-version "1.22.2"

必要參數

選擇性參數

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

全域參數

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