Microsoft.Compute virtualMachines/extensions
Bicep 資源定義
virtualMachines/extensions 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.Compute/virtualMachines/extensions 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2023-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
instanceView: {
name: 'string'
statuses: [
{
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
]
substatuses: [
{
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
]
type: 'string'
typeHandlerVersion: 'string'
}
protectedSettings: any()
protectedSettingsFromKeyVault: {
secretUrl: 'string'
sourceVault: {
id: 'string'
}
}
provisionAfterExtensions: [
'string'
]
publisher: 'string'
settings: any()
suppressFailures: bool
type: 'string'
typeHandlerVersion: 'string'
}
}
屬性值
virtualMachines/extensions
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
字串 (必要) |
| location | 資源位置 | 字串 |
| tags | 資源標籤 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| 父系 (parent) | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： virtualMachines |
| properties | 描述虛擬機擴充功能的屬性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| autoUpgradeMinorVersion | 指出擴充功能是否應該在部署時間使用較新的次要版本。 不過，部署之後，除非重新部署延伸模組，否則延伸模組將不會升級次要版本，即使此屬性設定為 true 亦然。 | bool |
| enableAutomaticUpgrade | 指出如果有較新版本的擴充功能可用，平臺是否應該自動升級延伸模組。 | bool |
| forceUpdateTag | 延伸模組處理程式應該如何強制更新，即使延伸模組組態尚未變更也一樣。 | 字串 |
| instanceView | 虛擬機擴充實例檢視。 | VirtualMachineExtensionInstanceView |
| protectedSettings | 此延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 | 針對 Bicep，您可以使用 任何 () 函式。 |
| protectedSettingsFromKeyVault | 以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用的擴充功能 | KeyVaultSecretReference |
| provisionAfterExtensions | 延伸模組名稱的集合，之後必須布建此延伸模組。 | string[] |
| publisher | 擴充處理程序發行者的名稱。 | 字串 |
| 設定 | 擴充功能的 Json 格式化公用設定。 | 針對 Bicep，您可以使用 任何 () 函式。 |
| suppressFailures | 指出延伸模組的失敗是否會隱藏 (作業失敗，例如不會連線到 VM，而不論此值) 為何。 預設值為 false。 | bool |
| 類型 | 指定延伸模組的類型;範例為 「CustomScriptExtension」。。 | 字串 |
| typeHandlerVersion | 指定文稿處理程式的版本。 | 字串 |
VirtualMachineExtensionInstanceView
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 虛擬機擴充功能名稱。 | 字串 |
| 狀態 | 資源狀態資訊。 | InstanceViewStatus[] |
| substatuses | 資源狀態資訊。 | InstanceViewStatus[] |
| 類型 | 指定延伸模組的類型;範例為 「CustomScriptExtension」。。 | 字串 |
| typeHandlerVersion | 指定文稿處理程式的版本。 | 字串 |
InstanceViewStatus
| 名稱 | 描述 | 值 |
|---|---|---|
| code | 狀態碼。 | 字串 |
| displayStatus | 狀態的簡短可當地語系化標籤。 | 字串 |
| 等級 | 層級程序代碼。 | 'Error' 'Info' 'Warning' |
| message | 詳細的狀態消息，包括警示和錯誤訊息。 | 字串 |
| time | 狀態的時間。 | 字串 |
KeyVaultSecretReference
| 名稱 | 描述 | 值 |
|---|---|---|
| secretUrl | 參考 金鑰保存庫 秘密的 URL。 | 字串 (必要) |
| sourceVault | 包含秘密之 金鑰保存庫的相對 URL。 | 必要子資源 () |
SubResource
| 名稱 | 描述 | 值 |
|---|---|---|
| id | 資源標識碼 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
建立已啟用反惡意代碼擴充功能的 Windows VM |
此範本會建立 Windows VM 並設定反惡意代碼防護 |
| 在 Windows VM 上使用 DSC 擴充功能的 IIS 伺服器 |
此範本會建立 Windows VM，並使用 DSC 擴充功能設定 IIS 伺服器。 請注意，如果您使用 Azure 記憶體，DSC 設定模組需要傳入 SAS 令牌。 對於來自 GitHub 的 DSC 模組連結 (此範本中的預設值) ，則不需要這樣做。 |
| ESET VM 擴充功能 |
使用ESET擴充功能建立VM |
| McAfee Endpoint Security (Windows VM 上的試用版授權) |
此範本會建立 Windows VM，並設定 McAfee Endpoint Security 的試用版 |
| 使用 OMS 擴充功能部署 Ubuntu VM |
此範本可讓您部署已安裝 OMS 延伸模組並上線至指定工作區的 Ubuntu VM |
| 使用 OMS 擴充功能部署 Windows VM |
此範本可讓您部署已安裝 OMS 擴充功能的 Windows VM 並上線至指定的工作區 |
| Windows VM 上的 Symantec Endpoint Protection 擴充功能試用版 |
此範本會建立 Windows VM，並設定 Symantec Endpoint Protection 的試用版 |
| Ubuntu VM 上的自定義腳本擴充功能 |
此範本會建立Ubuntu VM並安裝 CustomScript 擴充功能 |
| Ubuntu VM 上的OS修補擴充功能 |
此範本會建立Ubuntu VM並安裝OSPatching擴充功能 |
| 使用診斷部署進階 Windows VM |
此範本可讓您使用最新修補的版本，使用 Windows 版本的幾個不同選項來部署進階 Windows VM。 |
| 部署具有監視和診斷的簡單 Windows VM |
此範本可讓您部署簡單的 Windows VM 以及可啟用 VM 監視和診斷的診斷擴充功能 |
| 使用腳本擴充功能在Ubuntu VM上安裝 Mongo DB |
此範本會在兩個不同的腳本中，在Ubuntu虛擬機上部署設定及安裝Mongo DB。 此範本是一個良好的範例，示範如何在相同虛擬機上執行的兩個腳本之間表達相依性。 此範本也會部署記憶體帳戶、虛擬網路、公用IP位址和網路介面。 |
ARM 範本資源定義
virtualMachines/extensions 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.Compute/virtualMachines/extensions 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Compute/virtualMachines/extensions",
"apiVersion": "2023-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"instanceView": {
"name": "string",
"statuses": [
{
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
}
],
"substatuses": [
{
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
}
],
"type": "string",
"typeHandlerVersion": "string"
},
"protectedSettings": {},
"protectedSettingsFromKeyVault": {
"secretUrl": "string",
"sourceVault": {
"id": "string"
}
},
"provisionAfterExtensions": [ "string" ],
"publisher": "string",
"settings": {},
"suppressFailures": "bool",
"type": "string",
"typeHandlerVersion": "string"
}
}
屬性值
virtualMachines/extensions
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.Compute/virtualMachines/extensions' |
| apiVersion | 資源 API 版本 | '2023-09-01' |
| NAME | 資源名稱 瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。 |
需要字串 () |
| location | 資源位置 | 字串 |
| tags | 資源標籤 | 標記名稱和值的字典。 請參閱 範本中的標籤 |
| properties | 描述虛擬機擴充功能的屬性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| autoUpgradeMinorVersion | 指出擴充功能是否應該在部署期間使用較新的次要版本。 不過，部署之後，除非重新部署延伸模組，否則延伸模組將不會升級次要版本，即使此屬性設定為 true 亦然。 | bool |
| enableAutomaticUpgrade | 指出如果有較新版本的擴充功能可用，平臺是否應該自動升級延伸模組。 | bool |
| forceUpdateTag | 延伸模組處理程式應該如何強制更新，即使延伸模組組態尚未變更也一樣。 | 字串 |
| instanceView | 虛擬機擴充實例檢視。 | VirtualMachineExtensionInstanceView |
| protectedSettings | 延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或完全不包含受保護的設定。 | |
| protectedSettingsFromKeyVault | 以傳址方式傳遞並從金鑰保存庫取用的延伸模組受保護設定 | KeyVaultSecretReference |
| provisionAfterExtensions | 延伸模組名稱的集合，之後必須布建此延伸模組。 | string[] |
| publisher | 擴充處理程序發行者的名稱。 | 字串 |
| 設定 | 延伸模組的 Json 格式化公用設定。 | |
| suppressFailures | 指出從擴充功能產生的失敗是否會隱藏 (作業失敗，例如不會連線到 VM，而不論此值為何) 。 預設值為 false。 | bool |
| 類型 | 指定延伸模組的類型;例如“CustomScriptExtension”。 | 字串 |
| typeHandlerVersion | 指定文稿處理程式的版本。 | 字串 |
VirtualMachineExtensionInstanceView
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 虛擬機擴充功能名稱。 | 字串 |
| 狀態 | 資源狀態資訊。 | InstanceViewStatus[] |
| 子狀態 | 資源狀態資訊。 | InstanceViewStatus[] |
| 類型 | 指定延伸模組的類型;例如“CustomScriptExtension”。 | 字串 |
| typeHandlerVersion | 指定文稿處理程式的版本。 | 字串 |
InstanceViewStatus
| 名稱 | 描述 | 值 |
|---|---|---|
| code | 狀態碼。 | 字串 |
| displayStatus | 狀態的簡短可當地語系化標籤。 | 字串 |
| 等級 | 層級程序代碼。 | 'Error' 'Info' 'Warning' |
| message | 詳細的狀態消息，包括警示和錯誤訊息。 | 字串 |
| time | 狀態的時間。 | 字串 |
KeyVaultSecretReference
| 名稱 | 描述 | 值 |
|---|---|---|
| secretUrl | 參考 金鑰保存庫 秘密的 URL。 | 字串 (必要) |
| sourceVault | 包含秘密之 金鑰保存庫的相對 URL。 | 必要子資源 () |
SubResource
| 名稱 | 描述 | 值 |
|---|---|---|
| id | 資源標識碼 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 建立已啟用反惡意代碼擴充功能的 Windows VM |
此範本會建立 Windows VM 並設定反惡意代碼防護 |
| 在 Windows VM 上使用 DSC 擴充功能的 IIS 伺服器 |
此範本會建立 Windows VM，並使用 DSC 擴充功能設定 IIS 伺服器。 請注意，如果您使用 Azure 記憶體，DSC 設定模組需要傳入 SAS 令牌。 對於來自 GitHub 的 DSC 模組連結 (此範本中的預設值) ，則不需要這樣做。 |
| ESET VM 擴充功能 |
使用ESET擴充功能建立VM |
| McAfee Endpoint Security (Windows VM 上的試用版授權) |
此範本會建立 Windows VM，並設定 McAfee Endpoint Security 的試用版 |
| 使用 OMS 擴充功能部署 Ubuntu VM |
此範本可讓您部署已安裝 OMS 延伸模組並上線至指定工作區的 Ubuntu VM |
| 使用 OMS 擴充功能部署 Windows VM |
此範本可讓您部署已安裝 OMS 擴充功能的 Windows VM 並上線至指定的工作區 |
| Windows VM 上的 Symantec Endpoint Protection 擴充功能試用版 |
此範本會建立 Windows VM，並設定 Symantec Endpoint Protection 的試用版 |
| Ubuntu VM 上的自定義腳本擴充功能 |
此範本會建立Ubuntu VM並安裝 CustomScript 擴充功能 |
| Ubuntu VM 上的OS修補擴充功能 |
此範本會建立Ubuntu VM並安裝OSPatching擴充功能 |
| 使用診斷部署進階 Windows VM |
此範本可讓您使用最新修補的版本，使用 Windows 版本的幾個不同選項來部署進階 Windows VM。 |
| 部署具有監視和診斷的簡單 Windows VM |
此範本可讓您部署簡單的 Windows VM 以及可啟用 VM 監視和診斷的診斷擴充功能 |
| 使用腳本擴充功能在Ubuntu VM上安裝 Mongo DB |
此範本會在兩個不同的腳本中，在Ubuntu虛擬機上部署設定及安裝Mongo DB。 此範本是一個良好的範例，示範如何在相同虛擬機上執行的兩個腳本之間表達相依性。 此範本也會部署記憶體帳戶、虛擬網路、公用IP位址和網路介面。 |
Terraform (AzAPI 提供者) 資源定義
virtualMachines/extensions 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.Compute/virtualMachines/extensions 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/virtualMachines/extensions@2023-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
instanceView = {
name = "string"
statuses = [
{
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
]
substatuses = [
{
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
]
type = "string"
typeHandlerVersion = "string"
}
protectedSettingsFromKeyVault = {
secretUrl = "string"
sourceVault = {
id = "string"
}
}
provisionAfterExtensions = [
"string"
]
publisher = "string"
suppressFailures = bool
type = "string"
typeHandlerVersion = "string"
}
})
}
屬性值
virtualMachines/extensions
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.Compute/virtualMachines/extensions@2023-09-01” |
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源位置 | 字串 |
| parent_id | 此資源之父系的資源標識碼。 | 類型資源的標識碼： virtualMachines |
| tags | 資源標籤 | 標記名稱和值的字典。 |
| properties | 描述虛擬機擴充功能的屬性。 | VirtualMachineExtensionProperties |
VirtualMachineExtensionProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| autoUpgradeMinorVersion | 指出擴充功能是否應該在部署時間使用較新的次要版本。 不過，部署之後，除非重新部署延伸模組，否則延伸模組將不會升級次要版本，即使此屬性設定為 true 亦然。 | bool |
| enableAutomaticUpgrade | 指出如果有較新版本的擴充功能可用，平臺是否應該自動升級延伸模組。 | bool |
| forceUpdateTag | 延伸模組處理程式應該如何強制更新，即使延伸模組組態尚未變更也一樣。 | 字串 |
| instanceView | 虛擬機擴充實例檢視。 | VirtualMachineExtensionInstanceView |
| protectedSettings | 此延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。 | |
| protectedSettingsFromKeyVault | 以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用的擴充功能 | KeyVaultSecretReference |
| provisionAfterExtensions | 延伸模組名稱的集合，之後必須布建此延伸模組。 | string[] |
| publisher | 擴充處理程序發行者的名稱。 | 字串 |
| 設定 | 擴充功能的 Json 格式化公用設定。 | |
| suppressFailures | 指出延伸模組的失敗是否會隱藏 (作業失敗，例如不會連線到 VM，而不論此值) 為何。 預設值為 false。 | bool |
| 類型 | 指定延伸模組的類型;範例為 「CustomScriptExtension」。。 | 字串 |
| typeHandlerVersion | 指定文稿處理程式的版本。 | 字串 |
VirtualMachineExtensionInstanceView
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 虛擬機擴充功能名稱。 | 字串 |
| 狀態 | 資源狀態資訊。 | InstanceViewStatus[] |
| substatuses | 資源狀態資訊。 | InstanceViewStatus[] |
| 類型 | 指定延伸模組的類型;範例為 「CustomScriptExtension」。。 | 字串 |
| typeHandlerVersion | 指定文稿處理程式的版本。 | 字串 |
InstanceViewStatus
| 名稱 | 描述 | 值 |
|---|---|---|
| code | 狀態碼。 | 字串 |
| displayStatus | 狀態的簡短可當地語系化標籤。 | 字串 |
| 等級 | 層級程序代碼。 | “Error” “Info” 「警告」 |
| message | 詳細的狀態消息，包括警示和錯誤訊息。 | 字串 |
| time | 狀態的時間。 | 字串 |
KeyVaultSecretReference
| 名稱 | 描述 | 值 |
|---|---|---|
| secretUrl | 參考 金鑰保存庫 秘密的 URL。 | 字串 (必要) |
| sourceVault | 包含秘密之 金鑰保存庫的相對 URL。 | 必要子資源 () |
SubResource
| 名稱 | 描述 | 值 |
|---|---|---|
| id | 資源標識碼 | 字串 |
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應