Microsoft.Compute virtualMachineScaleSets/extensions

• Latest
• 2025-11-01
• 2025-04-01
• 2024-11-01
• 2024-07-01
• 2024-03-01
• 2023-09-01
• 2023-07-01
• 2023-03-01
• 2022-11-01
• 2022-08-01
• 2022-03-01
• 2021-11-01
• 2021-07-01
• 2021-04-01
• 2021-03-01
• 2020-12-01
• 2020-06-01
• 2019-12-01
• 2019-07-01
• 2019-03-01
• 2018-10-01
• 2018-06-01
• 2018-04-01
• 2017-12-01
• 2017-03-30

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@2025-11-01' = {
 parent: resourceSymbolicName
 name: 'string'
 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

Microsoft.Compute/virtualMachineScaleSets/extensions

KeyVaultSecretReference

SubResource

VirtualMachineScaleSetExtensionProperties

Usage Examples

Bicep Samples

A basic example of deploying Extension for a Virtual Machine Scale Set.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2022-07-01' = {
 name: resourceName
 location: location
 properties: {
 addressSpace: {
 addressPrefixes: [
 '10.0.0.0/16'
 ]
 }
 dhcpOptions: {
 dnsServers: []
 }
 subnets: []
 }
}

resource virtualMachineScaleSet 'Microsoft.Compute/virtualMachineScaleSets@2023-03-01' = {
 name: resourceName
 location: location
 sku: {
 capacity: 1
 name: 'Standard_F2'
 tier: 'Standard'
 }
 properties: {
 additionalCapabilities: {}
 doNotRunExtensionsOnOverprovisionedVMs: false
 orchestrationMode: 'Uniform'
 overprovision: true
 scaleInPolicy: {
 forceDeletion: false
 rules: [
 'Default'
 ]
 }
 singlePlacementGroup: true
 upgradePolicy: {
 mode: 'Manual'
 }
 virtualMachineProfile: {
 diagnosticsProfile: {
 bootDiagnostics: {
 enabled: false
 storageUri: ''
 }
 }
 extensionProfile: {
 extensionsTimeBudget: 'PT1H30M'
 }
 networkProfile: {
 networkInterfaceConfigurations: [
 {
 name: 'example'
 properties: {
 dnsSettings: {
 dnsServers: []
 }
 enableAcceleratedNetworking: false
 enableIPForwarding: false
 ipConfigurations: [
 {
 name: 'internal'
 properties: {
 applicationGatewayBackendAddressPools: []
 applicationSecurityGroups: []
 loadBalancerBackendAddressPools: []
 loadBalancerInboundNatPools: []
 primary: true
 privateIPAddressVersion: 'IPv4'
 subnet: {
 id: subnet.id
 }
 }
 }
 ]
 primary: true
 }
 }
 ]
 }
 osProfile: {
 adminUsername: 'adminuser'
 computerNamePrefix: resourceName
 linuxConfiguration: {
 disablePasswordAuthentication: true
 provisionVMAgent: true
 ssh: {
 publicKeys: [
 {
 keyData: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC+wWK73dCr+jgQOAxNsHAnNNNMEMWOHYEccp6wJm2gotpr9katuF/ZAdou5AaW1C61slRkHRkpRRX9FA9CYBiitZgvCCz+3nWNN7l/Up54Zps/pHWGZLHNJZRYyAB6j5yVLMVHIHriY49d/GZTZVNB8GoJv9Gakwc/fuEZYYl4YDFiGMBP///TzlI4jhiJzjKnEvqPFki5p2ZRJqcbCiF4pJrxUQR/RXqVFQdbRLZgYfJ8xGB878RENq3yQ39d8dVOkq4edbkzwcUmwwwkYVPIoDGsYLaRHnG+To7FvMeyO7xDVQkMKzopTQV8AuKpyvpqu0a9pWOMaiCyDytO7GGN you@me.com'
 path: '/home/adminuser/.ssh/authorized_keys'
 }
 ]
 }
 }
 secrets: []
 }
 priority: 'Regular'
 storageProfile: {
 dataDisks: []
 imageReference: {
 offer: 'UbuntuServer'
 publisher: 'Canonical'
 sku: '16.04-LTS'
 version: 'latest'
 }
 osDisk: {
 caching: 'ReadWrite'
 createOption: 'FromImage'
 managedDisk: {
 storageAccountType: 'Standard_LRS'
 }
 osType: 'Linux'
 writeAcceleratorEnabled: false
 }
 }
 }
 }
}

resource extension 'Microsoft.Compute/virtualMachineScaleSets/extensions@2023-03-01' = {
 name: resourceName
 parent: virtualMachineScaleSet
 properties: {
 autoUpgradeMinorVersion: true
 enableAutomaticUpgrade: false
 provisionAfterExtensions: []
 publisher: 'Microsoft.Azure.Extensions'
 settings: {
 commandToExecute: 'echo $HOSTNAME'
 }
 suppressFailures: false
 type: 'CustomScript'
 typeHandlerVersion: '2.0'
 }
}

resource subnet 'Microsoft.Network/virtualNetworks/subnets@2022-07-01' = {
 name: 'internal'
 parent: virtualNetwork
 properties: {
 addressPrefix: '10.0.2.0/24'
 delegations: []
 privateEndpointNetworkPolicies: 'Enabled'
 privateLinkServiceNetworkPolicies: 'Enabled'
 serviceEndpointPolicies: []
 serviceEndpoints: []
 }
}

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

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": "2025-11-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

Microsoft.Compute/virtualMachineScaleSets/extensions

KeyVaultSecretReference

SubResource

VirtualMachineScaleSetExtensionProperties

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

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@2025-11-01"
 name = "string"
 parent_id = "string"
 body = {
 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

Microsoft.Compute/virtualMachineScaleSets/extensions

KeyVaultSecretReference

SubResource

VirtualMachineScaleSetExtensionProperties

Usage Examples

Terraform Samples

A basic example of deploying Extension for a Virtual Machine Scale Set.

terraform {
 required_providers {
 azapi = {
 source = "Azure/azapi"
 }
 }
}

provider "azapi" {
 skip_provider_registration = false
}

variable "resource_name" {
 type = string
 default = "acctest0001"
}

variable "location" {
 type = string
 default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
 type = "Microsoft.Resources/resourceGroups@2020-06-01"
 name = var.resource_name
 location = var.location
}

resource "azapi_resource" "virtualNetwork" {
 type = "Microsoft.Network/virtualNetworks@2022-07-01"
 parent_id = azapi_resource.resourceGroup.id
 name = var.resource_name
 location = var.location
 body = {
 properties = {
 addressSpace = {
 addressPrefixes = [
 "10.0.0.0/16",
 ]
 }
 dhcpOptions = {
 dnsServers = [
 ]
 }
 subnets = [
 ]
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
 lifecycle {
 ignore_changes = [body.properties.subnets]
 }
}

resource "azapi_resource" "subnet" {
 type = "Microsoft.Network/virtualNetworks/subnets@2022-07-01"
 parent_id = azapi_resource.virtualNetwork.id
 name = "internal"
 body = {
 properties = {
 addressPrefix = "10.0.2.0/24"
 delegations = [
 ]
 privateEndpointNetworkPolicies = "Enabled"
 privateLinkServiceNetworkPolicies = "Enabled"
 serviceEndpointPolicies = [
 ]
 serviceEndpoints = [
 ]
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}

resource "azapi_resource" "virtualMachineScaleSet" {
 type = "Microsoft.Compute/virtualMachineScaleSets@2023-03-01"
 parent_id = azapi_resource.resourceGroup.id
 name = var.resource_name
 location = var.location
 body = {
 properties = {
 additionalCapabilities = {
 }
 doNotRunExtensionsOnOverprovisionedVMs = false
 orchestrationMode = "Uniform"
 overprovision = true
 scaleInPolicy = {
 forceDeletion = false
 rules = [
 "Default",
 ]
 }
 singlePlacementGroup = true
 upgradePolicy = {
 mode = "Manual"
 }
 virtualMachineProfile = {
 diagnosticsProfile = {
 bootDiagnostics = {
 enabled = false
 storageUri = ""
 }
 }
 extensionProfile = {
 extensionsTimeBudget = "PT1H30M"
 }
 networkProfile = {
 networkInterfaceConfigurations = [
 {
 name = "example"
 properties = {
 dnsSettings = {
 dnsServers = [
 ]
 }
 enableAcceleratedNetworking = false
 enableIPForwarding = false
 ipConfigurations = [
 {
 name = "internal"
 properties = {
 applicationGatewayBackendAddressPools = [
 ]
 applicationSecurityGroups = [
 ]
 loadBalancerBackendAddressPools = [
 ]
 loadBalancerInboundNatPools = [
 ]
 primary = true
 privateIPAddressVersion = "IPv4"
 subnet = {
 id = azapi_resource.subnet.id
 }
 }
 },
 ]
 primary = true
 }
 },
 ]
 }
 osProfile = {
 adminUsername = "adminuser"
 computerNamePrefix = var.resource_name
 linuxConfiguration = {
 disablePasswordAuthentication = true
 provisionVMAgent = true
 ssh = {
 publicKeys = [
 {
 keyData = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC+wWK73dCr+jgQOAxNsHAnNNNMEMWOHYEccp6wJm2gotpr9katuF/ZAdou5AaW1C61slRkHRkpRRX9FA9CYBiitZgvCCz+3nWNN7l/Up54Zps/pHWGZLHNJZRYyAB6j5yVLMVHIHriY49d/GZTZVNB8GoJv9Gakwc/fuEZYYl4YDFiGMBP///TzlI4jhiJzjKnEvqPFki5p2ZRJqcbCiF4pJrxUQR/RXqVFQdbRLZgYfJ8xGB878RENq3yQ39d8dVOkq4edbkzwcUmwwwkYVPIoDGsYLaRHnG+To7FvMeyO7xDVQkMKzopTQV8AuKpyvpqu0a9pWOMaiCyDytO7GGN you@me.com"
 path = "/home/adminuser/.ssh/authorized_keys"
 },
 ]
 }
 }
 secrets = [
 ]
 }
 priority = "Regular"
 storageProfile = {
 dataDisks = [
 ]
 imageReference = {
 offer = "UbuntuServer"
 publisher = "Canonical"
 sku = "16.04-LTS"
 version = "latest"
 }
 osDisk = {
 caching = "ReadWrite"
 createOption = "FromImage"
 managedDisk = {
 storageAccountType = "Standard_LRS"
 }
 osType = "Linux"
 writeAcceleratorEnabled = false
 }
 }
 }
 }
 sku = {
 capacity = 1
 name = "Standard_F2"
 tier = "Standard"
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}

resource "azapi_resource" "extension" {
 type = "Microsoft.Compute/virtualMachineScaleSets/extensions@2023-03-01"
 parent_id = azapi_resource.virtualMachineScaleSet.id
 name = var.resource_name
 body = {
 properties = {
 autoUpgradeMinorVersion = true
 enableAutomaticUpgrade = false
 provisionAfterExtensions = [
 ]
 publisher = "Microsoft.Azure.Extensions"
 settings = {
 commandToExecute = "echo $HOSTNAME"
 }
 suppressFailures = false
 type = "CustomScript"
 typeHandlerVersion = "2.0"
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}