API version change log for deployment of Microsoft.Compute/virtualMachines

This article describes the properties that changed in each API version for Microsoft.Compute/virtualMachines. It only covers properties that are available during deployments.

2024-07-01

Removed:

• enableVMAgentPlatformUpdates

2024-03-01

Added:

• scheduledEventsPolicy
• scheduledEventsPolicy.scheduledEventsAdditionalPublishingTargets
• scheduledEventsPolicy.scheduledEventsAdditionalPublishingTargets.eventGridAndResourceGraph
• scheduledEventsPolicy.scheduledEventsAdditionalPublishingTargets.eventGridAndResourceGraph.enable
• scheduledEventsPolicy.userInitiatedReboot
• scheduledEventsPolicy.userInitiatedReboot.automaticallyApprove
• scheduledEventsPolicy.userInitiatedRedeploy
• scheduledEventsPolicy.userInitiatedRedeploy.automaticallyApprove
• storageProfile.dataDisks.sourceResource
• storageProfile.dataDisks.sourceResource.id

Updated:

• properties.storageProfile.dataDisks.createOption - Added values: 'Copy' 'FromImage' 'Restore' (required) - Removed values: 'FromImage' (required)
• properties.storageProfile.osDisk.createOption - Added values: 'Copy' 'FromImage' 'Restore' (required) - Removed values: 'FromImage' (required)
• properties.storageProfile.osDisk.diffDiskSettings.placement - Added values: 'NvmeDisk'

2023-09-01

Added:

• securityProfile.encryptionIdentity
• securityProfile.encryptionIdentity.userAssignedIdentityResourceId
• securityProfile.proxyAgentSettings
• securityProfile.proxyAgentSettings.enabled
• securityProfile.proxyAgentSettings.keyIncarnationId
• securityProfile.proxyAgentSettings.mode

Updated:

• properties.storageProfile.dataDisks.managedDisk.securityProfile.securityEncryptionType - Added values: 'NonPersistedTPM'

2023-07-01

Added:

• networkProfile.networkInterfaceConfigurations.properties.auxiliaryMode
• networkProfile.networkInterfaceConfigurations.properties.auxiliarySku
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.dnsSettings.domainNameLabelScope

2023-03-01

Added:

• osProfile.linuxConfiguration.patchSettings.automaticByPlatformSettings.bypassPlatformSafetyChecksOnUserSchedule
• patchSettings.automaticByPlatformSettings.bypassPlatformSafetyChecksOnUserSchedule

2022-11-01

Added:

• scheduledEventsProfile.osImageNotificationProfile
• scheduledEventsProfile.osImageNotificationProfile.enable
• scheduledEventsProfile.osImageNotificationProfile.notBeforeTimeout

2022-08-01

Added:

• networkProfile.networkInterfaceConfigurations.properties.disableTcpStateTracking
• osProfile.linuxConfiguration.enableVMAgentPlatformUpdates
• enableVMAgentPlatformUpdates
• diskControllerType

2022-03-01

Added:

• properties.applicationProfile.galleryApplications.enableAutomaticUpgrade
• properties.applicationProfile.galleryApplications.treatFailureAsDeploymentFailure
• osProfile.linuxConfiguration.patchSettings.automaticByPlatformSettings
• osProfile.linuxConfiguration.patchSettings.automaticByPlatformSettings.rebootSetting
• patchSettings.automaticByPlatformSettings
• patchSettings.automaticByPlatformSettings.rebootSetting

Updated:

• properties.storageProfile.dataDisks.managedDisk.storageAccountType - Added values: 'PremiumV2_LRS'

2021-11-01

Added:

• storageProfile.dataDisks.managedDisk.securityProfile
• storageProfile.dataDisks.managedDisk.securityProfile.diskEncryptionSet
• storageProfile.dataDisks.managedDisk.securityProfile.diskEncryptionSet.id
• storageProfile.dataDisks.managedDisk.securityProfile.securityEncryptionType
• imageReference.communityGalleryImageId
• osDisk.managedDisk.securityProfile
• osDisk.managedDisk.securityProfile.diskEncryptionSet
• osDisk.managedDisk.securityProfile.diskEncryptionSet.id
• osDisk.managedDisk.securityProfile.securityEncryptionType

Updated:

• properties.securityProfile.securityType - Added values: 'ConfidentialVM'

2021-07-01

Added:

• properties.additionalCapabilities.hibernationEnabled
• properties.applicationProfile
• properties.applicationProfile.galleryApplications
• properties.applicationProfile.galleryApplications.configurationReference
• properties.applicationProfile.galleryApplications.order
• properties.applicationProfile.galleryApplications.packageReferenceId
• properties.applicationProfile.galleryApplications.tags
• availabilitySet
• availabilitySet.id
• billingProfile
• billingProfile.maxPrice
• capacityReservation
• capacityReservation.capacityReservationGroup
• capacityReservation.capacityReservationGroup.id
• diagnosticsProfile
• diagnosticsProfile.bootDiagnostics
• diagnosticsProfile.bootDiagnostics.enabled
• diagnosticsProfile.bootDiagnostics.storageUri
• evictionPolicy
• extensionsTimeBudget
• hardwareProfile
• hardwareProfile.vmSize
• hardwareProfile.vmSizeProperties
• hardwareProfile.vmSizeProperties.vCPUsAvailable
• hardwareProfile.vmSizeProperties.vCPUsPerCore
• host
• host.id
• hostGroup
• hostGroup.id
• licenseType
• networkProfile
• networkProfile.networkApiVersion
• networkProfile.networkInterfaceConfigurations
• networkProfile.networkInterfaceConfigurations.name
• networkProfile.networkInterfaceConfigurations.properties
• networkProfile.networkInterfaceConfigurations.properties.deleteOption
• networkProfile.networkInterfaceConfigurations.properties.dnsSettings
• networkProfile.networkInterfaceConfigurations.properties.dnsSettings.dnsServers
• networkProfile.networkInterfaceConfigurations.properties.dscpConfiguration
• networkProfile.networkInterfaceConfigurations.properties.dscpConfiguration.id
• networkProfile.networkInterfaceConfigurations.properties.enableAcceleratedNetworking
• networkProfile.networkInterfaceConfigurations.properties.enableFpga
• networkProfile.networkInterfaceConfigurations.properties.enableIPForwarding
• networkProfile.networkInterfaceConfigurations.properties.ipConfigurations
• networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.name
• networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties
• networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties.applicationGatewayBackendAddressPools
• networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties.applicationGatewayBackendAddressPools.id
• networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.applicationSecurityGroups
• networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.applicationSecurityGroups.id
• networkProfile.networkInterfaceConfigurations.properties.loadBalancerBackendAddressPools
• networkProfile.networkInterfaceConfigurations.properties.loadBalancerBackendAddressPools.id
• networkProfile.networkInterfaceConfigurations.primary
• networkProfile.networkInterfaceConfigurations.privateIPAddressVersion
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.name
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.deleteOption
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.dnsSettings
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.dnsSettings.domainNameLabel
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.idleTimeoutInMinutes
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags.ipTagType
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags.tag
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPAddressVersion
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPAllocationMethod
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPPrefix
• networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPPrefix.id
• networkProfile.networkInterfaceConfigurations.sku
• networkProfile.networkInterfaceConfigurations.sku.name
• networkProfile.networkInterfaceConfigurations.sku.tier
• networkProfile.subnet
• networkProfile.subnet.id
• imageReference.sharedGalleryImageId

Removed:

• properties.availabilitySet
• properties.availabilitySet.id
• properties.billingProfile
• properties.billingProfile.maxPrice
• properties.capacityReservation
• properties.capacityReservation.capacityReservationGroup
• properties.capacityReservation.capacityReservationGroup.id
• properties.diagnosticsProfile
• properties.diagnosticsProfile.bootDiagnostics
• properties.diagnosticsProfile.bootDiagnostics.enabled
• properties.diagnosticsProfile.bootDiagnostics.storageUri
• properties.evictionPolicy
• properties.extensionsTimeBudget
• properties.hardwareProfile
• properties.hardwareProfile.vmSize
• properties.host
• properties.host.id
• properties.hostGroup
• properties.hostGroup.id
• properties.licenseType
• properties.networkProfile
• properties.networkProfile.networkApiVersion
• properties.networkProfile.networkInterfaceConfigurations
• properties.networkProfile.networkInterfaceConfigurations.name
• properties.networkProfile.networkInterfaceConfigurations.properties
• properties.networkProfile.networkInterfaceConfigurations.properties.deleteOption
• properties.networkProfile.networkInterfaceConfigurations.properties.dnsSettings
• properties.networkProfile.networkInterfaceConfigurations.properties.dnsSettings.dnsServers
• properties.networkProfile.networkInterfaceConfigurations.properties.dscpConfiguration
• properties.networkProfile.networkInterfaceConfigurations.properties.dscpConfiguration.id
• properties.networkProfile.networkInterfaceConfigurations.properties.enableAcceleratedNetworking
• properties.networkProfile.networkInterfaceConfigurations.properties.enableFpga
• properties.networkProfile.networkInterfaceConfigurations.properties.enableIPForwarding
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.name
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties.applicationGatewayBackendAddressPools
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties.applicationGatewayBackendAddressPools.id
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.applicationSecurityGroups
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.applicationSecurityGroups.id
• properties.networkProfile.networkInterfaceConfigurations.properties.loadBalancerBackendAddressPools
• properties.networkProfile.networkInterfaceConfigurations.properties.loadBalancerBackendAddressPools.id
• properties.networkProfile.networkInterfaceConfigurations.primary
• properties.networkProfile.networkInterfaceConfigurations.privateIPAddressVersion
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.name
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.deleteOption
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.dnsSettings
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.dnsSettings.domainNameLabel
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.idleTimeoutInMinutes
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags.ipTagType
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags.tag
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPAddressVersion
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPAllocationMethod
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPPrefix
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPPrefix.id
• properties.networkProfile.networkInterfaceConfigurations.sku
• properties.networkProfile.networkInterfaceConfigurations.sku.name
• properties.networkProfile.networkInterfaceConfigurations.sku.tier
• properties.networkProfile.subnet
• properties.networkProfile.subnet.id

2021-04-01

Added:

• properties.capacityReservation
• properties.capacityReservation.capacityReservationGroup
• properties.capacityReservation.capacityReservationGroup.id

2021-03-01

Added:

• properties.networkProfile.networkApiVersion
• properties.networkProfile.networkInterfaceConfigurations
• properties.networkProfile.networkInterfaceConfigurations.name
• properties.networkProfile.networkInterfaceConfigurations.properties
• properties.networkProfile.networkInterfaceConfigurations.properties.deleteOption
• properties.networkProfile.networkInterfaceConfigurations.properties.dnsSettings
• properties.networkProfile.networkInterfaceConfigurations.properties.dnsSettings.dnsServers
• properties.networkProfile.networkInterfaceConfigurations.properties.dscpConfiguration
• properties.networkProfile.networkInterfaceConfigurations.properties.dscpConfiguration.id
• properties.networkProfile.networkInterfaceConfigurations.properties.enableAcceleratedNetworking
• properties.networkProfile.networkInterfaceConfigurations.properties.enableFpga
• properties.networkProfile.networkInterfaceConfigurations.properties.enableIPForwarding
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.name
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties.applicationGatewayBackendAddressPools
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.properties.applicationGatewayBackendAddressPools.id
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.applicationSecurityGroups
• properties.networkProfile.networkInterfaceConfigurations.properties.ipConfigurations.applicationSecurityGroups.id
• properties.networkProfile.networkInterfaceConfigurations.properties.loadBalancerBackendAddressPools
• properties.networkProfile.networkInterfaceConfigurations.properties.loadBalancerBackendAddressPools.id
• properties.networkProfile.networkInterfaceConfigurations.primary
• properties.networkProfile.networkInterfaceConfigurations.privateIPAddressVersion
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.name
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.deleteOption
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.dnsSettings
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.dnsSettings.domainNameLabel
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.idleTimeoutInMinutes
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags.ipTagType
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.properties.ipTags.tag
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPAddressVersion
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPAllocationMethod
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPPrefix
• properties.networkProfile.networkInterfaceConfigurations.publicIPAddressConfiguration.publicIPPrefix.id
• properties.networkProfile.networkInterfaceConfigurations.sku
• properties.networkProfile.networkInterfaceConfigurations.sku.name
• properties.networkProfile.networkInterfaceConfigurations.sku.tier
• properties.networkProfile.subnet
• properties.networkProfile.subnet.id
• networkSecurityGroup
• networkSecurityGroup.id
• primary
• networkInterfaces
• networkInterfaces.id
• networkInterfaces.properties
• networkInterfaces.properties.deleteOption
• networkInterfaces.properties.primary
• osProfile.linuxConfiguration.patchSettings.assessmentMode
• patchSettings.assessmentMode
• scheduledEventsProfile
• scheduledEventsProfile.terminateNotificationProfile
• scheduledEventsProfile.terminateNotificationProfile.enable
• scheduledEventsProfile.terminateNotificationProfile.notBeforeTimeout
• storageProfile.dataDisks.deleteOption
• osDisk.deleteOption
• userData

Removed:

• properties.networkProfile.networkInterfaces
• properties.networkProfile.networkInterfaces.id
• properties.networkProfile.networkInterfaces.properties
• properties.networkProfile.networkInterfaces.properties.primary

2020-12-01

Oldest version tracked in change log