az vm extension

  • 參考

管理 VM 上的擴充功能。

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

命令

名稱 Description 類型 狀態
az vm extension delete

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

 核心 GA
az vm extension image

尋找訂用帳戶和區域的可用 VM 擴充功能。

 核心 GA
az vm extension image list

列出可用擴充功能的相關資訊。

 核心 GA
az vm extension image list-names

列出可用延伸模組的名稱。

 核心 GA
az vm extension image list-versions

列出可用擴充功能的版本。

 核心 GA
az vm extension image show

顯示延伸模組的資訊。

 核心 GA
az vm extension list

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

 核心 GA
az vm extension set

設定 VM 的擴充功能。

 核心 GA
az vm extension show

顯示附加至 VM 之擴充功能的相關資訊。

 核心 GA
az vm extension wait

將 CLI 置於等候狀態，直到符合虛擬機器擴充功能的條件為止。

 核心 GA

az vm extension delete

編輯

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

az vm extension delete [--ids]
                       [--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)

選擇性參數

--ids

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

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

虛擬機器擴充功能的名稱。

--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 帳戶。

--vm-name

虛擬機器的名稱。 您可以使用 來設定預設值 az configure --defaults vm=<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 vm extension list

編輯

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

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

範例

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

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

選擇性參數

--ids

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

--resource-group -g

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

--subscription

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

--vm-name

虛擬機器的名稱。 您可以使用 來設定預設值 az configure --defaults vm=<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 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

延伸模組發行者的名稱。

選擇性參數

--enable-auto-upgrade

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

接受的值: false, true
--extension-instance-name

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

--force-update

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

預設值: False
--ids

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

--no-auto-upgrade
已被取代

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

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

接受的值: false, true
預設值: False
--no-auto-upgrade-minor-version

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

接受的值: false, true
預設值: False
--no-wait

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

預設值: False
--protected-settings

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

--resource-group -g

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

--settings

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

--subscription

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

--version

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

--vm-name

虛擬機器的名稱。 您可以使用 來設定預設值 az configure --defaults vm=<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 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

選擇性參數

--ids

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

--instance-view

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

預設值: False
--name -n

延伸模組的名稱。

--resource-group -g

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

--subscription

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

--vm-name

虛擬機器的名稱。 您可以使用 來設定預設值 az configure --defaults vm=<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 vm extension wait

編輯

將 CLI 置於等候狀態，直到符合虛擬機器擴充功能的條件為止。

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

範例

將 CLI 置於等候狀態，直到符合虛擬機器擴充功能的條件為止。 （自動產生）

az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

將 CLI 置於等候狀態，直到符合虛擬機器擴充功能的條件為止。 （自動產生）

az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

將 CLI 置於等候狀態，直到符合虛擬機器擴充功能的條件為止。 （自動產生）

az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm

選擇性參數

--created

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

預設值: False
--custom

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

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30
--name -n

延伸模組的名稱。

--resource-group -g

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

--subscription

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

--timeout

以秒為單位的等候上限。

預設值: 3600
--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False
--vm-name

虛擬機器的名稱。 您可以使用 來設定預設值 az configure --defaults vm=<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 來取得完整偵錯記錄。