Microsoft.Compute/virtualMachines/extensions template reference

API Version: 2016-04-30-preview

Template format

To create a Microsoft.Compute/virtualMachines/extensions resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Compute/virtualMachines/extensions",
  "apiVersion": "2016-04-30-preview",
  "location": "string",
  "tags": {},
  "properties": {
    "forceUpdateTag": "string",
    "publisher": "string",
    "type": "string",
    "typeHandlerVersion": "string",
    "autoUpgradeMinorVersion": boolean,
    "settings": {},
    "protectedSettings": {},
    "instanceView": {
      "name": "string",
      "type": "string",
      "typeHandlerVersion": "string",
      "substatuses": [
        {
          "code": "string",
          "level": "string",
          "displayStatus": "string",
          "message": "string",
          "time": "string"
        }
      ],
      "statuses": [
        {
          "code": "string",
          "level": "string",
          "displayStatus": "string",
          "message": "string",
          "time": "string"
        }
      ]
    }
  }
}

Property values

The following tables describe the values you need to set in the schema. For information about the resource type and name, see Set name and type for child resource in Resource Manager template.

Microsoft.Compute/virtualMachines/extensions object

Name Type Required Value
name string Yes The name of the virtual machine extension.
type enum Yes Microsoft.Compute/virtualMachines/extensions
apiVersion enum Yes 2016-04-30-preview
location string Yes Resource location.
tags object No Resource tags.
properties object Yes VirtualMachineExtensionProperties object

VirtualMachineExtensionProperties object

Name Type Required Value
forceUpdateTag string No How the extension handler should be forced to update even if the extension configuration has not changed.
publisher string No The name of the extension handler publisher.
type string No The type of the extension handler.
typeHandlerVersion string No The type version of the extension handler.
autoUpgradeMinorVersion boolean No Whether the extension handler should be automatically upgraded across minor versions.
settings object No Json formatted public settings for the extension.
protectedSettings object No Json formatted protected settings for the extension.
instanceView object No The virtual machine extension instance view. - VirtualMachineExtensionInstanceView object

VirtualMachineExtensionInstanceView object

Name Type Required Value
name string No The virtual machine extension name.
type string No The full type of the extension handler which includes both publisher and type.
typeHandlerVersion string No The type version of the extension handler.
substatuses array No The resource status information. - InstanceViewStatus object
statuses array No The resource status information. - InstanceViewStatus object

InstanceViewStatus object

Name Type Required Value
code string No The status code.
level enum No The level code. - Info, Warning, Error
displayStatus string No The short localizable label for the status.
message string No The detailed status message, including for alerts and error messages.
time string No The time of the status.

Quickstart templates

For example templates, see Compute templates.