Microsoft.Compute virtualMachineScaleSets/extensions

10/05/2020
2 minutes to read

Template format

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

{
  "name": "string",
  "type": "Microsoft.Compute/virtualMachineScaleSets/extensions",
  "apiVersion": "2020-06-01",
  "properties": {
    "publisher": "string",
    "type": "string",
    "typeHandlerVersion": "string",
    "autoUpgradeMinorVersion": "boolean",
    "enableAutomaticUpgrade": "boolean",
    "settings": {},
    "protectedSettings": {},
    "provisionAfterExtensions": [
      "string"
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Compute/virtualMachineScaleSets/extensions object

Name	Type	Required	Value
name	string	Yes	The name of the virtual machine extension.
type	enum	Yes	extensions -or- Microsoft.Compute/virtualMachineScaleSets/extensions See Set name and type for child resources.
apiVersion	enum	Yes	2020-06-01
properties	object	Yes	VirtualMachineScaleSetExtensionProperties object

VirtualMachineScaleSetExtensionProperties object

Name	Type	Required	Value
publisher	string	No	The name of the extension handler publisher.
type	string	No	Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion	string	No	Specifies the version of the script handler.
autoUpgradeMinorVersion	boolean	No	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enableAutomaticUpgrade	boolean	No	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
settings	object	No	Json formatted public settings for the extension.
protectedSettings	object	No	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
provisionAfterExtensions	array	No	Collection of extension names after which this extension needs to be provisioned. - string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
This template decrypts previously encrypted Windows VMSS	This template disables encryption on a running Windows VM Scale Set
This template encrypts a running Windows VMSS	This template enables encryption on a running Windows VM Scale Set