az azurestackhci virtualmachine extension

備註

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

命令群組 『azurestackhci』 是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

使用 azurestackhci 管理 virtualmachine 擴充功能。

命令

名稱	Description	類型	狀態
az azurestackhci virtualmachine extension create	建立 virtualmachine 擴充功能。	擴充套件	實驗性的
az azurestackhci virtualmachine extension delete	刪除 virtualmachine 擴充功能。	擴充套件	實驗性的
az azurestackhci virtualmachine extension list	列出 virtualmachine 的所有擴充功能。	擴充套件	實驗性的
az azurestackhci virtualmachine extension show	取得 virtualmachine 擴充功能的詳細數據。	擴充套件	實驗性的
az azurestackhci virtualmachine extension update	更新 virtualmachine 擴充功能。	擴充套件	實驗性的
az azurestackhci virtualmachine extension wait	將 CLI 置於等候狀態，直到符合 virtualmachine 擴充的條件為止。	擴充套件	實驗性的

az azurestackhci virtualmachine extension create

實驗

命令群組 『azurestackhci』 是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

建立 virtualmachine 擴充功能。

az azurestackhci virtualmachine extension create --name
                                                 --resource-group
                                                 --virtualmachine-name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--inst-handler-version]
                                                 [--instance-view-type]
                                                 [--location]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--settings]
                                                 [--status]
                                                 [--tags]
                                                 [--type-handler-version]

範例

PutExtension

az azurestackhci virtualmachine extension create --resource-group "test-rg" --location "West US2" --name "test-extension" --extension-type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10" --virtualmachine-name "test-virtualmachine"

必要參數

--name

延伸模組的名稱。

--resource-group -g

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

--virtualmachine-name

應該建立或更新擴充功能的 virtualmachine 名稱。

選擇性參數

--auto-upgrade-minor

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

接受的值: false, true

--enable-auto-upgrade

指出如果有較新版本可用，平臺是否應該自動升級延伸模組。

接受的值: false, true

--extension-type

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

--force-update-tag

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

--inst-handler-version

指定文稿處理程式的版本。

--instance-view-type

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

--location -l

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

--protected-settings

延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 預期值：json-string/json-file/@json-file。

--publisher

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

--settings

virtualmachine 擴充功能的 Json 格式化公用設定。

--status

實例檢視狀態。

--tags

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

--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 azurestackhci virtualmachine extension delete

實驗

命令群組 『azurestackhci』 是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除 virtualmachine 擴充功能。

az azurestackhci virtualmachine extension delete [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--virtualmachine-name]
                                                 [--yes]

範例

DeleteExtension

az azurestackhci virtualmachine extension delete --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

選擇性參數

--ids

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

--name

計算機擴充功能的名稱。

--resource-group -g

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

--subscription

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

--virtualmachine-name

應從中刪除擴充功能的虛擬機名稱。

--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 azurestackhci virtualmachine extension list

實驗

命令群組 『azurestackhci』 是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

列出 virtualmachine 的所有擴充功能。

az azurestackhci virtualmachine extension list --resource-group
                                               --virtualmachine-name

範例

ListExtensions

az azurestackhci virtualmachine extension list --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

必要參數

--resource-group -g

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

--virtualmachine-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 azurestackhci virtualmachine extension show

實驗

命令群組 『azurestackhci』 是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得 virtualmachine 擴充功能的詳細數據。

az azurestackhci virtualmachine extension show [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]
                                               [--virtualmachine-name]

範例

GetExtension

az azurestackhci virtualmachine extension show --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

選擇性參數

--ids

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

--name

計算機擴充功能的名稱。

--resource-group -g

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

--subscription

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

--virtualmachine-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 azurestackhci virtualmachine extension update

實驗

命令群組 『azurestackhci』 是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新 virtualmachine 擴充功能。

az azurestackhci virtualmachine extension update --name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--ids]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--resource-group]
                                                 [--settings]
                                                 [--subscription]
                                                 [--tags]
                                                 [--type-handler-version]
                                                 [--virtualmachine-name]

範例

UpdateExtension

az azurestackhci virtualmachine extension update --resource-group "test-rg" --name "test-extension" --extension-type "CustomScriptExtension" --virtualmachine-name "test-virtualmachine" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10"

必要參數

--name

延伸模組的名稱。

選擇性參數

--auto-upgrade-minor

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

接受的值: false, true

--enable-auto-upgrade

指出如果有較新版本可用，平臺是否應該自動升級延伸模組。

接受的值: false, true

--extension-type

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

--force-update-tag

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

--ids

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

--protected-settings

延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 預期值：json-string/json-file/@json-file。

--publisher

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

--resource-group -g

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

--settings

擴充功能的 Json 格式化公用設定。 預期值：json-string/json-file/@json-file。

--subscription

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

--tags

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

--type-handler-version

指定文稿處理程式的版本。

--virtualmachine-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 azurestackhci virtualmachine extension wait

實驗

命令群組 『azurestackhci』 是實驗性且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

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

az azurestackhci virtualmachine extension wait [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--ids]
                                               [--interval]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]
                                               [--timeout]
                                               [--updated]
                                               [--virtualmachine-name]

範例

暫停執行下一行 CLI 腳本，直到成功建立 virtualmachine 擴充功能為止。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --created

暫停執行下一行 CLI 腳本，直到 virtualmachine 擴充功能成功更新為止。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --updated

暫停執行下一行 CLI 腳本，直到成功刪除 virtualmachine 擴充功能為止。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --deleted

選擇性參數

--created

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

預設值: False

--custom

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

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30

--name

計算機擴充功能的名稱。

--resource-group -g

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

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