Microsoft.Compute virtualMachineScaleSets/extensions

Article
08/16/2024

Bicep resource definition

The virtualMachineScaleSets/extensions resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

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

Property values

virtualMachineScaleSets/extensions

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	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.	Symbolic name for resource of type: virtualMachineScaleSets
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	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.	For Bicep, you can use the any() function.
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[]
publisher	The name of the extension handler publisher.	string
settings	Json formatted public settings for the extension.	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

KeyVaultSecretReference

Name	Description	Value
secretUrl	The URL referencing a secret in a Key Vault.	string (required)
sourceVault	The relative URL of the Key Vault containing the secret.	SubResource (required)

SubResource

Name	Description	Value
id	Resource Id	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Darktrace Autoscaling vSensors	This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors
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
Create and encrypt a new Windows VMSS with jumpbox	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.
Deploy a trusted launch capable Windows VM Scale Set	This template allows you to deploy a trusted launch capable VM Scale Set of Windows VMs using the latest patched version of Windows Server 2016, Windows Server 2019 or Windows Server 2022 Azure Edition. These VMs are behind a load balancer with NAT rules for RDP connections. If you enable Secureboot and vTPM, the Guest Attestation extension will be installed on your VMSS. This extension will perform remote attestation by the cloud.

ARM template resource definition

The virtualMachineScaleSets/extensions resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Compute/virtualMachineScaleSets/extensions",
  "apiVersion": "2024-07-01",
  "name": "string",
  "properties": {
    "autoUpgradeMinorVersion": "bool",
    "enableAutomaticUpgrade": "bool",
    "forceUpdateTag": "string",
    "protectedSettings": {},
    "protectedSettingsFromKeyVault": {
      "secretUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "provisionAfterExtensions": [ "string" ],
    "publisher": "string",
    "settings": {},
    "suppressFailures": "bool",
    "type": "string",
    "typeHandlerVersion": "string"
  }
}

Property values

virtualMachineScaleSets/extensions

Name	Description	Value
type	The resource type	'Microsoft.Compute/virtualMachineScaleSets/extensions'
apiVersion	The resource api version	'2024-07-01'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
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	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[]
publisher	The name of the extension handler publisher.	string
settings	Json formatted public settings for the extension.
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

KeyVaultSecretReference

Name	Description	Value
secretUrl	The URL referencing a secret in a Key Vault.	string (required)
sourceVault	The relative URL of the Key Vault containing the secret.	SubResource (required)

SubResource

Name	Description	Value
id	Resource Id	string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Deploy Darktrace Autoscaling vSensors	This template allows you to deploy an automatically autoscaling deployment of Darktrace vSensors
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
Create and encrypt a new Windows VMSS with jumpbox	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.
Deploy a trusted launch capable Windows VM Scale Set	This template allows you to deploy a trusted launch capable VM Scale Set of Windows VMs using the latest patched version of Windows Server 2016, Windows Server 2019 or Windows Server 2022 Azure Edition. These VMs are behind a load balancer with NAT rules for RDP connections. If you enable Secureboot and vTPM, the Guest Attestation extension will be installed on your VMSS. This extension will perform remote attestation by the cloud.

Terraform (AzAPI provider) resource definition

The virtualMachineScaleSets/extensions resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/virtualMachineScaleSets/extensions@2024-07-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      autoUpgradeMinorVersion = bool
      enableAutomaticUpgrade = bool
      forceUpdateTag = "string"
      protectedSettingsFromKeyVault = {
        secretUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      provisionAfterExtensions = [
        "string"
      ]
      publisher = "string"
      suppressFailures = bool
      type = "string"
      typeHandlerVersion = "string"
    }
  })
}

Property values

virtualMachineScaleSets/extensions

Name	Description	Value
type	The resource type	"Microsoft.Compute/virtualMachineScaleSets/extensions@2024-07-01"
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: virtualMachineScaleSets
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	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
protectedSettingsFromKeyVault	The extensions protected settings that are passed by reference, and consumed from key vault	KeyVaultSecretReference
provisionAfterExtensions	Collection of extension names after which this extension needs to be provisioned.	string[]
publisher	The name of the extension handler publisher.	string
settings	Json formatted public settings for the extension.
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

KeyVaultSecretReference

Name	Description	Value
secretUrl	The URL referencing a secret in a Key Vault.	string (required)
sourceVault	The relative URL of the Key Vault containing the secret.	SubResource (required)

SubResource

Name	Description	Value
id	Resource Id	string

Share via

Microsoft.Compute virtualMachineScaleSets/extensions

Bicep resource definition

Resource format

Property values

virtualMachineScaleSets/extensions

VirtualMachineScaleSetExtensionProperties

KeyVaultSecretReference

SubResource

Quickstart templates

ARM template resource definition

Resource format

Property values

virtualMachineScaleSets/extensions

VirtualMachineScaleSetExtensionProperties

KeyVaultSecretReference

SubResource

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

virtualMachineScaleSets/extensions

VirtualMachineScaleSetExtensionProperties

KeyVaultSecretReference

SubResource

Feedback

Additional resources