Share via


az stack-hci extension

注意

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

使用 stack hci 管理擴充功能。

命令

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

建立 HCI 叢集的擴充功能。

副檔名 GA
az stack-hci extension delete

刪除 HCI 叢集的特定弧線延伸。

副檔名 GA
az stack-hci extension list

列出弧線設定資源下的所有延伸模組。

副檔名 GA
az stack-hci extension show

取得 HCI 叢集的特定弧線延伸。

副檔名 GA
az stack-hci extension wait

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

副檔名 GA

az stack-hci extension create

建立 HCI 叢集的擴充功能。

az stack-hci extension create --arc-setting-name
                              --cluster-name
                              --extension-name
                              --resource-group
                              [--auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                              [--force-update-tag]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--protected-settings]
                              [--publisher]
                              [--settings]
                              [--type]
                              [--type-handler-version]

範例

建立弧形延伸模組

az stack-hci extension create --arc-setting-name "default" --cluster-name "myCluster" --type "MicrosoftMonitoringAgent" --protected-settings '{"workspaceId": "xx", "port": "6516"}' --publisher "Microsoft.Compute" --settings '{"workspaceKey": "xx"}' --type-handler-version "1.10" --name "MicrosoftMonitoringAgent" --resource-group "test-rg"

必要參數

--arc-setting-name

保存 HCI ArcSetting 資訊詳細數據的 Proxy 資源名稱。

--cluster-name

叢集的名稱。

--extension-name --name -n

計算機擴充功能的名稱。

--resource-group -g

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

選擇性參數

--auto-upgrade

指出如果部署期間有新的次要版本,擴充功能是否應該使用較新的次要版本。 不過,部署之後,除非重新部署,否則擴充功能不會升級次要版本,即使此屬性設定為 true 也一定會升級。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--force-update-tag

即使延伸模組組態尚未變更,延伸模組處理程式也應該強制更新。

--no-wait

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--protected-settings

受保護的設定(可能包含秘密)。 支援 json-file 和 yaml-file。

--publisher

擴充處理程序發行者的名稱。

--settings

擴充功能的 Json 格式化公用設定。 支援 json-file 和 yaml-file。

--type

指定延伸模組的類型;例如“CustomScriptExtension”。

--type-handler-version

指定文稿處理程式的版本。 如果未指定,則會使用最新版本。

全域參數
--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 stack-hci extension delete

刪除 HCI 叢集的特定弧線延伸。

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

範例

刪除弧形延伸模組

az stack-hci extension delete --arc-setting-name "default" --cluster-name "myCluster" --name "MicrosoftMonitoringAgent" --resource-group "test-rg"

選擇性參數

--arc-setting-name

保存 HCI ArcSetting 資訊詳細數據的 Proxy 資源名稱。

--cluster-name

叢集的名稱。

--extension-name --name -n

計算機擴充功能的名稱。

--ids

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

--no-wait

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

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

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

--subscription

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

--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 stack-hci extension list

列出弧線設定資源下的所有延伸模組。

az stack-hci extension list --arc-setting-name
                            --cluster-name
                            --resource-group
                            [--max-items]
                            [--next-token]

範例

列出 Arc 設定資源下的延伸模組

az stack-hci extension list --arc-setting-name "default" --cluster-name "myCluster" --resource-group "test-rg"

必要參數

--arc-setting-name

保存 HCI ArcSetting 資訊詳細數據的 Proxy 資源名稱。

--cluster-name

叢集的名稱。

--resource-group -g

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

選擇性參數

--max-items

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

--next-token

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

全域參數
--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 stack-hci extension show

取得 HCI 叢集的特定弧線延伸。

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

範例

取得 Arc 設定延伸模組

az stack-hci extension show --arc-setting-name "default" --cluster-name "myCluster" --name "MicrosoftMonitoringAgent" --resource-group "test-rg"

選擇性參數

--arc-setting-name

保存 HCI ArcSetting 資訊詳細數據的 Proxy 資源名稱。

--cluster-name

叢集的名稱。

--extension-name --name -n

計算機擴充功能的名稱。

--ids

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

--resource-group -g

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

--subscription

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

全域參數
--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 stack-hci extension wait

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

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

選擇性參數

--arc-setting-name

保存 HCI ArcSetting 資訊詳細數據的 Proxy 資源名稱。

--cluster-name

叢集的名稱。

--created

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

預設值: False
--custom

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

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--extension-name --name -n

計算機擴充功能的名稱。

--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30
--resource-group -g

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

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