Microsoft.Compute virtualMachineScaleSets/extensions

  • 2 minutes to read

The virtualMachineScaleSets/extensions resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Compute/virtualMachineScaleSets/extensions resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/extensions@2021-07-01' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    autoUpgradeMinorVersion: bool
    enableAutomaticUpgrade: bool
    forceUpdateTag: 'string'
    protectedSettings: any()
    provisionAfterExtensions: [ 'string' ]
    publisher: 'string'
    settings: any()
    suppressFailures: bool
    type: 'string'
    typeHandlerVersion: 'string'
  }
}

Property values

virtualMachineScaleSets/extensions

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.Compute/virtualMachineScaleSets/extensions'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2021-07-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 parentSymbolicName
properties Describes the properties of a Virtual Machine Scale Set Extension. VirtualMachineScaleSetExtensionProperties

VirtualMachineScaleSetExtensionProperties

Name Description Value
autoUpgradeMinorVersion 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. bool
enableAutomaticUpgrade Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. bool
forceUpdateTag If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. string
protectedSettings Any object For Bicep, you can use the any() function.
provisionAfterExtensions Collection of extension names after which this extension needs to be provisioned. string[]
publisher The name of the extension handler publisher. string
settings Any object For Bicep, you can use the any() function.
suppressFailures Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. bool
type Specifies the type of the extension; an example is "CustomScriptExtension". string
typeHandlerVersion Specifies the version of the script handler. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
This template decrypts previously encrypted Windows VMSS

Deploy to Azure		 This template disables encryption on a running Windows VM Scale Set
This template encrypts a running Windows VMSS

Deploy to Azure		 This template enables encryption on a running Windows VM Scale Set
Create and encrypt a new Windows VMSS with jumpbox

Deploy to Azure		 This template allows you to deploy a simple VM Scale Set of Windows VMs using the lastest patched version of serveral Windows versions. This template also deploys a jumpbox with a public IP address in the same virtual network. You can connect to the jumpbox via this public IP address, then connect from there to VMs in the scale set via private IP addresses.This template enables encryption on the VM Scale Set of Windows VMs.