az vm extension

管理 VM 上的擴充功能。

擴充功能是小型應用程式，可在 Azure 虛擬機上提供部署後設定和自動化工作。例如，如果虛擬機需要軟體安裝、防毒防護或 Docker 設定，VM 擴充功能可用來完成這些工作。擴充功能可以與新的虛擬機部署搭配使用，或針對任何現有的系統執行。

命令

名稱	Description	類型	狀態
az vm extension delete	刪除作業以刪除延伸模組。	Core	GA
az vm extension image	尋找訂用帳戶和區域的可用 VM 擴充功能。	Core	GA
az vm extension image list	列出可用擴充功能的相關信息。	Core	GA
az vm extension image list-names	列出可用延伸模組的名稱。	Core	GA
az vm extension image list-versions	列出可用擴充功能的版本。	Core	GA
az vm extension image show	顯示延伸模組的資訊。	Core	GA
az vm extension list	列出連結至 VM 的擴充功能。	Core	GA
az vm extension set	設定 VM 的擴充功能。	Core	GA
az vm extension show	顯示附加至 VM 之擴充功能的相關信息。	Core	GA
az vm extension wait	將 CLI 置於等候狀態，直到符合條件為止。	Core	GA

az vm extension delete

編輯

刪除作業以刪除延伸模組。

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

範例

使用 VM 名稱和擴充功能，從 VM 中刪除擴充功能。

az vm extension delete -g MyResourceGroup --vm-name MyVm -n MyExtensionName

刪除包含 VM 字串「MyExtension」的擴充功能。

az vm extension delete --ids $(az resource list --query "[?contains(name, 'MyExtension')].id" -o tsv)

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

屬性	值
Parameter group:	Resource Id Arguments

--name --vm-extension-name -n

虛擬機擴充功能的名稱。

屬性	值
Parameter group:	Resource Id Arguments

--no-wait

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

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

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--vm-name

虛擬機的名稱。您可以使用來設定預設值 az configure --defaults vm=<name>。

屬性	值
Parameter group:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

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

--query

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

--verbose

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

屬性	值
預設值:	False

az vm extension list

編輯

列出連結至 VM 的擴充功能。

az vm extension list [--ids]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

範例

列出具名 VM 的附加延伸模組。

az vm extension list -g MyResourceGroup --vm-name MyVm

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

屬性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--vm-name

虛擬機的名稱。您可以使用來設定預設值 az configure --defaults vm=<name>。

屬性	值
Parameter group:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

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

--query

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

--verbose

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

屬性	值
預設值:	False

az vm extension set

編輯

設定 VM 的擴充功能。

從 az vm extension image list取得擴充功能詳細數據。

az vm extension set --name
                    --publisher
                    [--enable-auto-upgrade {false, true}]
                    [--extension-instance-name]
                    [--force-update]
                    [--ids]
                    [--no-auto-upgrade {false, true}]
                    [--no-auto-upgrade-minor-version {false, true}]
                    [--no-wait]
                    [--protected-settings]
                    [--resource-group]
                    [--settings]
                    [--subscription]
                    [--version]
                    [--vm-name]

範例

將用戶帳戶新增至Linux VM。

az vm extension set -n VMAccessForLinux --publisher Microsoft.OSTCExtensions --version 1.4 \
    --vm-name MyVm --resource-group MyResourceGroup \
    --protected-settings '{"username":"user1", "ssh_key":"ssh_rsa ..."}'

將 customScript 擴充功能新增至 --ids 所指定的 VM（s）。

az vm extension set -n customScript --publisher Microsoft.Azure.Extensions --ids {vm_id}

如果有較新版本的擴充功能可用，請新增延伸模組，並啟用平臺的自動升級。

az vm extension set -n extName --publisher publisher --vm-name MyVM -g MyResourceGroup \
--enable-auto-upgrade true

必要參數

--name -n

延伸模組的名稱。

屬性	值
值來源:	az vm extension image list

--publisher

延伸模組發行者的名稱。

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--enable-auto-upgrade

指出如果有較新版本的擴充功能可用，平臺應該會自動升級延伸模組。

屬性	值
接受的值:	false, true

--extension-instance-name

可自定義的擴充實例名稱。預設值：延伸模組的名稱。

--force-update

強制更新，即使延伸模組組態尚未變更也一樣。

屬性	值
預設值:	False

--ids

屬性	值
Parameter group:	Resource Id Arguments

--no-auto-upgrade

已被取代

選項 '--no-auto-upgrade' 已被取代，將在未來的版本中移除。請改用『--no-auto-upgrade-minor-version』。

如果設定，即使重新部署擴充功能，擴充服務也不會自動挑選或升級至最新的次要版本。

屬性	值
預設值:	False
接受的值:	false, true

--no-auto-upgrade-minor-version

如果設定，即使重新部署擴充功能，擴充服務也不會自動挑選或升級至最新的次要版本。

屬性	值
預設值:	False
接受的值:	false, true

--no-wait

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

屬性	值
預設值:	False

--protected-settings

JSON 格式的受保護設定，例如認證等敏感性資訊。也接受 JSON 檔案路徑。

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--settings

JSON 格式的延伸模組設定。也接受 JSON 檔案路徑。

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--version

延伸模組的版本。若要將擴充功能版本釘選到此值，請指定 --no-auto-upgrade-minor-version。

--vm-name

虛擬機的名稱。您可以使用來設定預設值 az configure --defaults vm=<name>。

屬性	值
Parameter group:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

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

--query

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

--verbose

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

屬性	值
預設值:	False

az vm extension show

編輯

顯示附加至 VM 之擴充功能的相關信息。

az vm extension show [--ids]
                     [--instance-view]
                     [--name]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

範例

使用 VM 名稱和擴充功能名稱來顯示連結至 VM 的擴充功能。

az vm extension show -g MyResourceGroup --vm-name MyVm -n extension_name

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

屬性	值
Parameter group:	Resource Id Arguments

--instance-view

虛擬機擴充功能的實例檢視。

屬性	值
預設值:	False

--name -n

延伸模組的名稱。

屬性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--vm-name

虛擬機的名稱。您可以使用來設定預設值 az configure --defaults vm=<name>。

屬性	值
Parameter group:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

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

--query

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

--verbose

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

屬性	值
預設值:	False

az vm extension wait

編輯

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

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

選擇性參數

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	False

--custom

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

屬性	值
Parameter group:	Wait Condition Arguments

--deleted

等到刪除為止。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	False

--exists

等候資源存在。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	False

--expand

要套用至作業的展開表達式。

--ids

屬性	值
Parameter group:	Resource Id Arguments

--interval

輪詢間隔以秒為單位。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	30

--name --vm-extension-name -n

虛擬機擴充功能的名稱。

屬性	值
Parameter group:	Resource Id Arguments

--resource-group -g

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

屬性	值
Parameter group:	Resource Id Arguments

--subscription

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

屬性	值
Parameter group:	Resource Id Arguments

--timeout

以秒為單位的等候上限。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	3600

--updated

等到 provisioningState 更新為 'Succeeded'。

屬性	值
Parameter group:	Wait Condition Arguments
預設值:	False

--vm-name

虛擬機的名稱。您可以使用來設定預設值 az configure --defaults vm=<name>。

屬性	值
Parameter group:	Resource Id Arguments

全域參數

--debug

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

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

Output format.

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

--query

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

--verbose

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

屬性	值
預設值:	False

共用方式為

az vm extension

命令

az vm extension delete

範例

選擇性參數

az vm extension list

範例

選擇性參數

az vm extension set

範例

必要參數

選擇性參數

az vm extension show

範例

選擇性參數

az vm extension wait

選擇性參數

意見反應