Microsoft.Compute/virtualMachines/extensions 2023-03-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

virtualMachines/extensions 資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.Compute/virtualMachines/extensions 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Compute/virtualMachines/extensions@2023-03-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

名字	描述	價值
名字	資源名稱請參閱如何在 Bicep 中設定子資源的名稱和類型。	字串（必要）
位置	資源位置	字串
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
父母	在 Bicep 中，您可以指定子資源的父資源。只有在父資源外部宣告子資源時，才需要新增這個屬性。如需詳細資訊，請參閱父資源外部的子資源。	類型資源的符號名稱：virtualMachines
性能	描述虛擬機擴充功能的屬性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	價值
autoUpgradeMinorVersion	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。	bool
enableAutomaticUpgrade	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。	bool
forceUpdateTag	即使延伸模組組態尚未變更，延伸模組處理程式也應該強制更新。	字串
instanceView	虛擬機擴充實例檢視。	VirtualMachineExtensionInstanceView
protectedSettings	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。	針對 Bicep，您可以使用 any（）函式。
protectedSettingsFromKeyVault	以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用	KeyVaultSecretReference
provisionAfterExtensions	必須布建此延伸模組之後的延伸模組名稱集合。	string[]
發行人	擴充處理程序發行者的名稱。	字串
設置	擴充功能的 Json 格式化公用設定。	針對 Bicep，您可以使用 any（）函式。
suppressFailures	指出延伸模組產生的失敗是否會隱藏（不論此值為何，無法連線到 VM 等作業失敗）。默認值為 false。	bool
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

VirtualMachineExtensionInstanceView

名字	描述	價值
名字	虛擬機擴充功能名稱。	字串
狀態	資源狀態資訊。	InstanceViewStatus[]
substatuses	資源狀態資訊。	InstanceViewStatus[]
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

InstanceViewStatus

名字	描述	價值
法典	狀態代碼。	字串
displayStatus	狀態的簡短可當地語系化標籤。	字串
水準	層級程序代碼。	'Error' 'Info' 'Warning'
消息	詳細的狀態消息，包括警示和錯誤訊息。	字串
時間	狀態的時間。	字串

KeyVaultSecretReference

名字	描述	價值
secretUrl	參考 Key Vault 中秘密的 URL。	字串（必要）
sourceVault	包含秘密之 Key Vault 的相對 URL。	SubResource （必要）

SubResource

名字	描述	價值
id	資源標識碼	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
建立已啟用反惡意代碼擴充功能的 Windows VM	此範本會建立 Windows VM 並設定反惡意代碼防護
在 Windows VM 上使用 DSC 擴充功能 IIS Server	此範本會建立 Windows VM，並使用 DSC 擴充功能設定 IIS 伺服器。請注意，如果您使用 Azure 記憶體，DSC 設定模組需要傳入 SAS 令牌。針對來自 GitHub 的 DSC 模組連結（此範本中的預設值），不需要此連結。
ESET VM 擴充功能	建立具有ESET擴充功能的VM
Windows VM 上的 McAfee Endpoint Security （試用版授權）	此範本會建立 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-03-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-03-01'
名字	資源名稱請參閱如何在JSON ARM 範本中設定子資源的名稱和類型。	字串（必要）
位置	資源位置	字串
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
性能	描述虛擬機擴充功能的屬性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	價值
autoUpgradeMinorVersion	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。	bool
enableAutomaticUpgrade	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。	bool
forceUpdateTag	即使延伸模組組態尚未變更，延伸模組處理程式也應該強制更新。	字串
instanceView	虛擬機擴充實例檢視。	VirtualMachineExtensionInstanceView
protectedSettings	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。
protectedSettingsFromKeyVault	以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用	KeyVaultSecretReference
provisionAfterExtensions	必須布建此延伸模組之後的延伸模組名稱集合。	string[]
發行人	擴充處理程序發行者的名稱。	字串
設置	擴充功能的 Json 格式化公用設定。
suppressFailures	指出延伸模組產生的失敗是否會隱藏（不論此值為何，無法連線到 VM 等作業失敗）。默認值為 false。	bool
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

VirtualMachineExtensionInstanceView

名字	描述	價值
名字	虛擬機擴充功能名稱。	字串
狀態	資源狀態資訊。	InstanceViewStatus[]
substatuses	資源狀態資訊。	InstanceViewStatus[]
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

InstanceViewStatus

名字	描述	價值
法典	狀態代碼。	字串
displayStatus	狀態的簡短可當地語系化標籤。	字串
水準	層級程序代碼。	'Error' 'Info' 'Warning'
消息	詳細的狀態消息，包括警示和錯誤訊息。	字串
時間	狀態的時間。	字串

KeyVaultSecretReference

名字	描述	價值
secretUrl	參考 Key Vault 中秘密的 URL。	字串（必要）
sourceVault	包含秘密之 Key Vault 的相對 URL。	SubResource （必要）

SubResource

名字	描述	價值
id	資源標識碼	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
建立已啟用反惡意代碼擴充功能的 Windows VM	此範本會建立 Windows VM 並設定反惡意代碼防護
在 Windows VM 上使用 DSC 擴充功能 IIS Server	此範本會建立 Windows VM，並使用 DSC 擴充功能設定 IIS 伺服器。請注意，如果您使用 Azure 記憶體，DSC 設定模組需要傳入 SAS 令牌。針對來自 GitHub 的 DSC 模組連結（此範本中的預設值），不需要此連結。
ESET VM 擴充功能	建立具有ESET擴充功能的VM
Windows VM 上的 McAfee Endpoint Security （試用版授權）	此範本會建立 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-03-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-03-01”
名字	資源名稱	字串（必要）
位置	資源位置	字串
parent_id	此資源為父系之資源的標識碼。	類型資源的標識碼：virtualMachines
標籤	資源標籤	標記名稱和值的字典。
性能	描述虛擬機擴充功能的屬性。	VirtualMachineExtensionProperties

VirtualMachineExtensionProperties

名字	描述	價值
autoUpgradeMinorVersion	指出如果部署期間有新的次要版本，擴充功能是否應該使用較新的次要版本。不過，部署之後，除非重新部署，否則擴充功能不會升級次要版本，即使此屬性設定為 true 也一定會升級。	bool
enableAutomaticUpgrade	指出如果有較新版本的延伸模組可用，平臺是否應該自動升級延伸模組。	bool
forceUpdateTag	即使延伸模組組態尚未變更，延伸模組處理程式也應該強制更新。	字串
instanceView	虛擬機擴充實例檢視。	VirtualMachineExtensionInstanceView
protectedSettings	延伸模組可以包含 protectedSettings 或 protectedSettingsFromKeyVault 或完全沒有受保護的設定。
protectedSettingsFromKeyVault	以傳址方式傳遞的延伸模組受保護設定，並從金鑰保存庫取用	KeyVaultSecretReference
provisionAfterExtensions	必須布建此延伸模組之後的延伸模組名稱集合。	string[]
發行人	擴充處理程序發行者的名稱。	字串
設置	擴充功能的 Json 格式化公用設定。
suppressFailures	指出延伸模組產生的失敗是否會隱藏（不論此值為何，無法連線到 VM 等作業失敗）。默認值為 false。	bool
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

VirtualMachineExtensionInstanceView

名字	描述	價值
名字	虛擬機擴充功能名稱。	字串
狀態	資源狀態資訊。	InstanceViewStatus[]
substatuses	資源狀態資訊。	InstanceViewStatus[]
類型	指定延伸模組的類型;例如“CustomScriptExtension”。	字串
typeHandlerVersion	指定文稿處理程式的版本。	字串

InstanceViewStatus

名字	描述	價值
法典	狀態代碼。	字串
displayStatus	狀態的簡短可當地語系化標籤。	字串
水準	層級程序代碼。	“Error” “Info” “Warning”
消息	詳細的狀態消息，包括警示和錯誤訊息。	字串
時間	狀態的時間。	字串

KeyVaultSecretReference

名字	描述	價值
secretUrl	參考 Key Vault 中秘密的 URL。	字串（必要）
sourceVault	包含秘密之 Key Vault 的相對 URL。	SubResource （必要）

SubResource

名字	描述	價值
id	資源標識碼	字串

共用方式為

Microsoft.Compute virtualMachines/extensions 2023-03-01

Bicep 資源定義

資源格式

屬性值

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

快速入門範本

ARM 樣本資源定義

資源格式

屬性值

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

快速入門範本

Terraform （AzAPI 提供者）資源定義

資源格式

屬性值

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

意見反應

其他資源

共用方式為

Microsoft.Compute virtualMachines/extensions 2023-03-01

Bicep 資源定義

資源格式

屬性值

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

快速入門範本

ARM 樣本資源定義

資源格式

屬性值

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

virtualMachines/extensions

VirtualMachineExtensionProperties

VirtualMachineExtensionInstanceView

InstanceViewStatus

KeyVaultSecretReference

SubResource

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義