az vm extension

管理 VM 上的擴充功能。

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

命令

az vm extension delete

移除連結至 VM 的擴充功能。

az vm extension image

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

az vm extension image list

列出可用延伸模組的相關資訊。

az vm extension image list-names

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

az vm extension image list-versions

列出可用延伸模組的版本。

az vm extension image show

顯示延伸模組的資訊。

az vm extension list

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

az vm extension set

設定 VM 的擴充功能。

az vm extension show

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

az vm extension wait

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

az vm extension delete

移除連結至 VM 的擴充功能。

az vm extension delete [--ids]
                       [--name]
                       [--no-wait]
                       [--resource-group]
                       [--vm-name]

範例

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

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

從 VM 刪除包含字串 「MyExtension」 的副檔名。

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

選擇性參數

--ids

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

--name -n

延伸模組的名稱。

--no-wait

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

--resource-group -g

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

--vm-name

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

az vm extension list

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

az vm extension list --resource-group
                     --vm-name

範例

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

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

必要參數

--resource-group -g

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

--vm-name

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

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]
                    [--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 擴充功能新增至 VM (--ids 所指定的) 。

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

強制更新,即使擴充功能設定尚未變更也一樣。

--ids

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

--no-auto-upgrade

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

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

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

接受的值: false, true
--no-wait

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

--protected-settings

以 JSON 格式保護的機密資訊設定,例如認證。 也接受 JSON 檔案路徑。

--resource-group -g

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

--settings

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

--version

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

--vm-name

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

az vm extension show

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

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

範例

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

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

選擇性參數

--expand

要套用至作業的展開運算式。

--ids

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

--instance-view

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

--name -n

延伸模組的名稱。

--resource-group -g

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

--vm-name

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

az vm extension wait

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

az vm extension wait [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--expand]
                     [--ids]
                     [--interval]
                     [--name]
                     [--resource-group]
                     [--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' 建立。

--custom

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

--deleted

等到刪除為止。

--exists

等候資源存在。

--expand

要套用至作業的展開運算式。

--ids

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

--interval

以秒為單位輪詢間隔。

預設值: 30
--name -n

延伸模組的名稱。

--resource-group -g

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

--timeout

等候時間上限,以秒為單位。

預設值: 3600
--updated

等候 provisioningState 更新為 'Succeeded'。

--vm-name

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