az akshybrid

注意

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

此命令群組處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

管理布建的叢集。

命令

名稱	Description	類型	狀態
az akshybrid create	建立布建的叢集。	副檔名	預覽版
az akshybrid delete	刪除布建的叢集。	副檔名	預覽版
az akshybrid get-credentials	取得已布建叢集的本機 kubeconfig。	副檔名	預覽版
az akshybrid get-upgrades	取得已布建叢集可用的升級版本。	副檔名	預覽版
az akshybrid get-versions	列出指定自定義位置中支援的 Kubernetes 版本。	副檔名	預覽版
az akshybrid nodepool	管理布建叢集中的節點集區。	副檔名	預覽版
az akshybrid nodepool add	在布建的叢集中新增 nodepool。	副檔名	預覽版
az akshybrid nodepool delete	刪除布建叢集中的 nodepool。	副檔名	預覽版
az akshybrid nodepool list	列出布建叢集中的所有節點集區。	副檔名	預覽版
az akshybrid nodepool scale	調整布建叢集中的 nodepool。	副檔名	預覽版
az akshybrid nodepool show	取得布建叢集中的 nodepool。	副檔名	預覽版
az akshybrid notice	將 NOTICE 檔案輸出至使用者指定的 filepath。	副檔名	預覽版
az akshybrid show	取得布建的叢集。	副檔名	預覽版
az akshybrid update	更新 布建的叢集。	副檔名	預覽版
az akshybrid upgrade	升級布建的叢集。	副檔名	預覽版
az akshybrid vmsize	管理 akshybrid 的虛擬機 SKU。	副檔名	預覽版
az akshybrid vmsize list	列出指定之自定義位置中支援的虛擬機大小。	副檔名	預覽版
az akshybrid vnet	管理已布建叢集的虛擬網路。	副檔名	預覽版
az akshybrid vnet create	建立虛擬網路。	副檔名	預覽版
az akshybrid vnet delete	刪除虛擬網路。	副檔名	預覽版
az akshybrid vnet list	依資源群組或訂用帳戶列出虛擬網路。	副檔名	預覽版
az akshybrid vnet show	取得虛擬網路。	副檔名	預覽版

az akshybrid create

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

建立布建的叢集。

az akshybrid create --custom-location
                    --name
                    --resource-group
                    [--aad-admin-group-object-ids]
                    [--arc-agent-auto-upgrade]
                    [--arc-agent-version]
                    [--control-plane-count]
                    [--control-plane-ip]
                    [--control-plane-vm-size]
                    [--generate-ssh-keys]
                    [--kubernetes-version]
                    [--load-balancer-count]
                    [--location]
                    [--no-ssh-key]
                    [--no-wait]
                    [--node-count]
                    [--node-vm-size]
                    [--pod-cidr]
                    [--ssh-key-value]
                    [--tags]
                    [--vnet-ids]

範例

PutProvisionedCluster

az akshybrid create -g sample-rg --custom-location sample-cl -n sample-akshybridcluster --vnet-id vnet1

必要參數

--custom-location

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

--name -n

布建叢集的名稱。

--resource-group -g

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

選擇性參數

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

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

--arc-agent-auto-upgrade

Arc Agent 自動升級。

預設值: Enabled

--arc-agent-version

Arc 代理程式版本。

--control-plane-count

控制平面節點的數目。

--control-plane-ip

控制平面的 API 伺服器 IP 位址。

--control-plane-vm-size

控制平面的 VM 大小。

--generate-ssh-keys

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

預設值: False

--kubernetes-version -k

布建叢集的 kubernetes 版本。

--load-balancer-count

負載平衡器節點數目。

--location -l

位置。 來自的值： az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--no-ssh-key -x

請勿使用 插入任何公鑰。

預設值: False

--no-wait

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

預設值: False

--node-count -c

要建立於 nodepool 中的節點數目。

--node-vm-size

nodepool 中節點的 VM 大小。

--pod-cidr

要從中指派 Pod IP 的 CIDR 表示法IP範圍。

--ssh-key-value

要插入控制平面之 SSH 公鑰的路徑。

預設值: ~\.ssh\id_rsa.pub

--tags

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

--vnet-ids

VNet 的 ARM 資源識別碼。

全域參數

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

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除布建的叢集。

az akshybrid delete --name
                    --resource-group
                    [--no-wait]
                    [--yes]

範例

DeleteProvisionedCluster

az akshybrid delete --name "sample-akshybridcluster" --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 akshybrid get-credentials

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

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

az akshybrid get-credentials --name
                             --resource-group
                             [--admin]
                             [--context]
                             [--file]
                             [--overwrite-existing]

範例

Get 管理員 Credential

az akshybrid get-credentials --name "sample-akshybridcluster" --resource-group "sample-rg" --admin

GetAADUserCredential

az akshybrid get-credentials --name "sample-akshybridcluster" --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 akshybrid get-upgrades

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

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

az akshybrid get-upgrades --name
                          --resource-group

範例

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

az akshybrid 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 akshybrid get-versions

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

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

az akshybrid get-versions --custom-location
                          --resource-group

範例

VMListSkus

az akshybrid 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 akshybrid notice

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

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

az akshybrid notice --output-filepath

範例

GetNoticeFile

az akshybrid 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 akshybrid show

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得布建的叢集。

az akshybrid show --name
                  --resource-group

範例

GetProvisionedCluster

az akshybrid show --name "sample-akshybridcluster" --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 akshybrid update

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新 布建的叢集。

az akshybrid update --name
                    --resource-group
                    [--aad-admin-group-object-ids]
                    [--tags]

範例

UpdateProvisionedCluster

az akshybrid update --tags additionalProperties="sample" --name "sample-akshybridcluster" --resource-group "sample-rg"

必要參數

--name -n

布建叢集的名稱。

--resource-group -g

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

選擇性參數

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

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

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

預覽

命令群組 『akshybrid』 處於預覽狀態，目前正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

升級布建的叢集。

az akshybrid upgrade --name
                     --resource-group
                     [--kubernetes-version]
                     [--no-wait]
                     [--node-image-only]
                     [--yes]

範例

UpgradeProvisionedCluster

az akshybrid upgrade --name "sample-akshybridcluster" --resource-group "sample-rg" --kubernetes-version v1.22.2

UpgradeProvisionedClusterNodeImage

az akshybrid upgrade --name "sample-akshybridcluster" --resource-group "sample-rg" --node-image-only

必要參數

--name -n

布建叢集的名稱。

--resource-group -g

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

選擇性參數

--kubernetes-version -k

布建叢集的 kubernetes 版本。

--no-wait

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

預設值: False

--node-image-only

僅升級節點映像的旗標。

預設值: 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 來取得完整偵錯記錄。