共用方式為

az stack-hci cluster

Note

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

使用 stack hci 管理叢集。

命令

名稱 Description 類型 狀態
az stack-hci cluster create

建立 HCI 叢集。

 Extension GA
az stack-hci cluster create-identity

建立叢集身分識別。

 Extension GA
az stack-hci cluster delete

刪除 HCI 叢集。

 Extension GA
az stack-hci cluster extend-software-assurance-benefit

將軟體保證權益延伸至叢集。

 Extension GA
az stack-hci cluster identity

管理身分識別。

 Extension GA
az stack-hci cluster identity assign

指派身分識別。

 Extension GA
az stack-hci cluster identity remove

拿掉身分識別。

 Extension GA
az stack-hci cluster list

列出訂用帳戶中的所有 HCI 叢集。

 Extension GA
az stack-hci cluster show

取得 HCI 叢集。

 Extension GA
az stack-hci cluster update

更新 HCI 叢集。

 Extension GA
az stack-hci cluster wait

將 CLI 置於等候狀態，直到符合條件為止。

 Extension GA

az stack-hci cluster create

建立 HCI 叢集。

az stack-hci cluster create --cluster-name --name
                            --resource-group
                            [--aad-application-object-id]
                            [--aad-client-id]
                            [--aad-service-principal-object-id]
                            [--aad-tenant-id]
                            [--desired-properties]
                            [--endpoint]
                            [--location]
                            [--mi-system-assigned {0, 1, f, false, n, no, t, true, y, yes}]
                            [--tags]

範例

建立叢集

az stack-hci cluster create --location "East US" --aad-client-id "24a6e53d-04e5-44d2-b7cc-1b732a847dfc" --aad-tenant-id "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94" --endpoint "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com" --name "myCluster" --resource- group "test-rg"

必要參數

--cluster-name --name -n

叢集的名稱。

--resource-group -g

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

選擇性參數

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

--aad-application-object-id

叢集 AAD 身分識別的物件標識碼。

屬性 值
參數群組: Properties Arguments
--aad-client-id

叢集 AAD 身分識別的應用程式識別碼。

屬性 值
參數群組: Properties Arguments
--aad-service-principal-object-id

叢集身分識別服務主體的標識碼。

屬性 值
參數群組: Properties Arguments
--aad-tenant-id

叢集 AAD 身分識別的租用戶標識碼。

屬性 值
參數群組: Properties Arguments
--desired-properties

叢集的所需屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性 值
參數群組: Properties Arguments
--endpoint

從 Azure 入口網站設定管理端點。

屬性 值
參數群組: Properties Arguments
--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

屬性 值
參數群組: Cluster Arguments
--mi-system-assigned

啟用系統指派的身分識別。

屬性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性 值
參數群組: Cluster 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 stack-hci cluster create-identity

建立叢集身分識別。

az stack-hci cluster create-identity [--cluster-name]
                                     [--ids]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]

範例

建立叢集身分識別

az stack-hci cluster create-identity --name "myCluster" --resource-group "test-rg"

選擇性參數

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

--cluster-name

叢集的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--no-wait

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

屬性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
全域參數
--debug

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

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

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

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

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False

az stack-hci cluster delete

刪除 HCI 叢集。

az stack-hci cluster delete [--cluster-name --name]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--yes]

範例

刪除叢集

az stack-hci cluster delete --name "myCluster" --resource-group "test-rg"

選擇性參數

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

--cluster-name --name -n

叢集的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--no-wait

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

屬性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id 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/。

--verbose

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

屬性 值
預設值: False

az stack-hci cluster extend-software-assurance-benefit

將軟體保證權益延伸至叢集。

az stack-hci cluster extend-software-assurance-benefit [--cluster-name]
                                                       [--ids]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--software-assurance-intent {Disable, Enable}]
                                                       [--subscription]

範例

擴充軟體保證權益

az stack-hci cluster extend-software-assurance-benefit --cluster-name name -g rg --software-assurance-intent enable

選擇性參數

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

--cluster-name

叢集的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--no-wait

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

屬性 值
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--software-assurance-intent

軟體保證權益的客戶意圖。

屬性 值
參數群組: Properties Arguments
接受的值: Disable, Enable
--subscription

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

屬性 值
參數群組: Resource Id Arguments
全域參數
--debug

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

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

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

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

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False

az stack-hci cluster list

列出訂用帳戶中的所有 HCI 叢集。

az stack-hci cluster list [--max-items]
                          [--next-token]
                          [--resource-group]

範例

列出指定資源群組中的叢集

az stack-hci cluster list --resource-group "test-rg"

列出指定訂用帳戶中的叢集

az stack-hci cluster list

選擇性參數

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

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。 若要繼續分頁，請在後續命令的 --next-token 自變數中提供令牌值。

屬性 值
參數群組: Pagination Arguments
--next-token

標記，指定要開始分頁的位置。 這是先前截斷回應中的令牌值。

屬性 值
參數群組: Pagination 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 stack-hci cluster show

取得 HCI 叢集。

az stack-hci cluster show [--cluster-name --name]
                          [--ids]
                          [--resource-group]
                          [--subscription]

範例

取得叢集

az stack-hci cluster show --name "myCluster" --resource-group "test-rg"

選擇性參數

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

--cluster-name --name -n

叢集的名稱。

屬性 值
參數群組: Resource Id Arguments
--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
全域參數
--debug

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

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

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

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

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False

az stack-hci cluster update

更新 HCI 叢集。

az stack-hci cluster update [--aad-client-id]
                            [--aad-tenant-id]
                            [--add]
                            [--cluster-name --name]
                            [--desired-properties]
                            [--endpoint]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--subscription]
                            [--tags]

範例

更新叢集

az stack-hci cluster update --endpoint "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com" --desired-properties "{diagnosticLevel:Basic,windowsServerSubscription:Enabled}" --tags "tag:"value" --name "myCluster" --resource-group "test-rg"

選擇性參數

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

--aad-client-id

叢集 AAD 身分識別的應用程式識別碼。

屬性 值
參數群組: Properties Arguments
--aad-tenant-id

叢集 AAD 身分識別的租用戶標識碼。

屬性 值
參數群組: Properties Arguments
--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例： --add property.listProperty <key=value, string or JSON string>.

屬性 值
參數群組: Generic Update Arguments
--cluster-name --name -n

叢集的名稱。

屬性 值
參數群組: Resource Id Arguments
--desired-properties

叢集的所需屬性。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

屬性 值
參數群組: Properties Arguments
--endpoint

從 Azure 入口網站設定管理端點。

屬性 值
參數群組: Properties Arguments
--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性 值
參數群組: Generic Update Arguments
接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性 值
參數群組: Generic Update Arguments
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--set

指定要設定的屬性路徑和值，以更新物件。 範例： --set property1.property2=<value>.

屬性 值
參數群組: Generic Update Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

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

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

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

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

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

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False

az stack-hci cluster wait

將 CLI 置於等候狀態，直到符合條件為止。

az stack-hci cluster wait [--cluster-name --name]
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--resource-group]
                          [--subscription]
                          [--timeout]
                          [--updated]

選擇性參數

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

--cluster-name --name -n

叢集的名稱。

屬性 值
參數群組: Resource Id Arguments
--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--custom

等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

屬性 值
參數群組: Wait Condition Arguments
--deleted

等到刪除為止。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--exists

等候資源存在。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
--ids

一或多個資源識別碼（以空格分隔）。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

屬性 值
參數群組: Resource Id Arguments
--interval

輪詢間隔以秒為單位。

屬性 值
參數群組: Wait Condition Arguments
預設值: 30
--resource-group -g

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

屬性 值
參數群組: Resource Id Arguments
--subscription

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

屬性 值
參數群組: Resource Id Arguments
--timeout

以秒為單位的等候上限。

屬性 值
參數群組: Wait Condition Arguments
預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

屬性 值
參數群組: Wait Condition Arguments
預設值: False
全域參數
--debug

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

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

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

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

輸出格式。

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

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

--verbose

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

屬性 值
預設值: False