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

This article describes the properties that changed in each API version for microsoft.compute/virtualmachinescalesets. It only covers properties that are available during deployments.

2024-11-01

Added:

• AutomaticZoneRebalancingPolicy
• HostEndpointSettings

Updated:

• ProxyAgentSettings: Added property 'imds'
• ProxyAgentSettings: Added property 'wireServer'
• ResiliencyPolicy: Added property 'automaticZoneRebalancingPolicy'
• ScaleInPolicy: Added property 'prioritizeUnhealthyVMs'
• SkuProfileVMSize: Added property 'rank'

2024-07-01

Added:

• SkuProfile
• SkuProfileVMSize

Updated:

• VirtualMachineScaleSetProperties: Added property 'skuProfile'
• VirtualMachineScaleSetProperties: Added property 'zonalPlatformFaultDomainAlignMode'

2024-03-01

Added:

• EventGridAndResourceGraph
• ScheduledEventsAdditionalPublishingTargets
• ScheduledEventsPolicy
• UserInitiatedReboot
• UserInitiatedRedeploy

Removed:

• VirtualMachineExtension

Updated:

• SecurityPostureReference: Added property 'isOverridable'
• VirtualMachineScaleSetProperties: Added property 'scheduledEventsPolicy'

2023-09-01

Added:

• EncryptionIdentity
• ProxyAgentSettings
• ResiliencyPolicy
• ResilientVMCreationPolicy
• ResilientVMDeletionPolicy

Updated:

• AutomaticOSUpgradePolicy: Added property 'osRollingUpgradeDeferral'
• Microsoft.Compute/virtualMachineScaleSets: Added property 'etag'
• SecurityProfile: Added property 'encryptionIdentity'
• SecurityProfile: Added property 'proxyAgentSettings'
• VirtualMachineScaleSetProperties: Added property 'resiliencyPolicy'
• VirtualMachineScaleSetVMProfile: Added property 'timeCreated'

2023-07-01

No properties added, updated or removed.

2023-03-01

Added:

• SecurityPostureReference
• VirtualMachineExtension

Updated:

• LinuxVMGuestPatchAutomaticByPlatformSettings: Added property 'bypassPlatformSafetyChecksOnUserSchedule'
• VirtualMachineScaleSetVMProfile: Added property 'securityPostureReference'
• WindowsVMGuestPatchAutomaticByPlatformSettings: Added property 'bypassPlatformSafetyChecksOnUserSchedule'

2022-11-01

Added:

• OSImageNotificationProfile
• ServiceArtifactReference

Updated:

• RollingUpgradePolicy: Added property 'maxSurge'
• RollingUpgradePolicy: Added property 'rollbackFailedInstancesOnPolicyBreach'
• ScheduledEventsProfile: Added property 'osImageNotificationProfile'
• VirtualMachineScaleSetNetworkConfiguration: Removed property 'id'
• VirtualMachineScaleSetOSProfile: Added property 'requireGuestProvisionSignal'
• VirtualMachineScaleSetProperties: Added property 'constrainedMaximumCapacity'
• VirtualMachineScaleSetVMProfile: Added property 'serviceArtifactReference'

2022-08-01

Added:

• PriorityMixPolicy

Updated:

• LinuxConfiguration: Added property 'enableVMAgentPlatformUpdates'
• VirtualMachineScaleSetProperties: Added property 'priorityMixPolicy'
• VirtualMachineScaleSetStorageProfile: Added property 'diskControllerType'
• WindowsConfiguration: Added property 'enableVMAgentPlatformUpdates'

2022-03-01

Added:

• LinuxVMGuestPatchAutomaticByPlatformSettings
• UserAssignedIdentities
• UserAssignedIdentitiesValue
• WindowsVMGuestPatchAutomaticByPlatformSettings

Removed:

• VirtualMachineScaleSetIdentityUserAssignedIdentities
• VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue

Updated:

• AutomaticOSUpgradePolicy: Added property 'useRollingUpgradePolicy'
• LinuxPatchSettings: Added property 'automaticByPlatformSettings'
• PatchSettings: Added property 'automaticByPlatformSettings'
• VirtualMachineScaleSetDataDisk: Added property 'deleteOption'
• VirtualMachineScaleSetOSDisk: Added property 'deleteOption'
• VMGalleryApplication: Added property 'enableAutomaticUpgrade'
• VMGalleryApplication: Added property 'treatFailureAsDeploymentFailure'

2021-11-01

Added:

• VirtualMachineScaleSetHardwareProfile
• VMDiskSecurityProfile
• VMSizeProperties

Updated:

• AutomaticRepairsPolicy: Added property 'repairAction'
• ImageReference: Added property 'communityGalleryImageId'
• VirtualMachineScaleSetManagedDiskParameters: Added property 'securityProfile'
• VirtualMachineScaleSetOSProfile: Added property 'allowExtensionOperations'
• VirtualMachineScaleSetProperties: Added property 'timeCreated'
• VirtualMachineScaleSetVMProfile: Added property 'hardwareProfile'

2021-07-01

Added:

• ApplicationProfile
• VMGalleryApplication

Updated:

• AdditionalCapabilities: Added property 'hibernationEnabled'
• ImageReference: Added property 'sharedGalleryImageId'
• ScaleInPolicy: Added property 'forceDeletion'
• VirtualMachineScaleSetVMProfile: Added property 'applicationProfile'

2021-04-01

Added:

• CapacityReservationProfile
• SpotRestorePolicy

Updated:

• VirtualMachineScaleSetProperties: Added property 'spotRestorePolicy'
• VirtualMachineScaleSetVMProfile: Added property 'capacityReservation'

2021-03-01

Updated:

• LinuxPatchSettings: Added property 'assessmentMode'
• PatchSettings: Added property 'assessmentMode'
• VirtualMachineScaleSetNetworkProfile: Added property 'networkApiVersion'
• VirtualMachineScaleSetVMProfile: Added property 'userData'

2020-12-01

Added:

• ExtendedLocation
• LinuxPatchSettings
• UefiSettings

Updated:

• LinuxConfiguration: Added property 'patchSettings'
• Microsoft.Compute/virtualMachineScaleSets: Added property 'extendedLocation'
• PatchSettings: Added property 'enableHotpatching'
• RollingUpgradePolicy: Added property 'enableCrossZoneUpgrade'
• RollingUpgradePolicy: Added property 'prioritizeUnhealthyInstances'
• SecurityProfile: Added property 'securityType'
• SecurityProfile: Added property 'uefiSettings'
• VirtualMachineScaleSetProperties: Added property 'orchestrationMode'

2020-06-01

Added:

• PatchSettings
• SecurityProfile

Updated:

• VirtualMachineScaleSetExtensionProfile: Added property 'extensionsTimeBudget'
• VirtualMachineScaleSetProperties: Added property 'hostGroup'
• VirtualMachineScaleSetVMProfile: Added property 'securityProfile'
• WindowsConfiguration: Added property 'patchSettings'

2019-12-01

Updated:

• DiffDiskSettings: Added property 'placement'

2019-07-01

Added:

• DiskEncryptionSetParameters

Updated:

• ImageReference: Added property 'exactVersion'
• VirtualMachineScaleSetDataDisk: Added property 'diskIOPSReadWrite'
• VirtualMachineScaleSetDataDisk: Added property 'diskMBpsReadWrite'
• VirtualMachineScaleSetExtension: Added property 'type'
• VirtualMachineScaleSetManagedDiskParameters: Added property 'diskEncryptionSet'

2019-03-01

Added:

• BillingProfile
• ScaleInPolicy
• ScheduledEventsProfile
• TerminateNotificationProfile

Updated:

• VirtualMachineScaleSetProperties: Added property 'additionalCapabilities'
• VirtualMachineScaleSetProperties: Added property 'scaleInPolicy'
• VirtualMachineScaleSetVMProfile: Added property 'billingProfile'
• VirtualMachineScaleSetVMProfile: Added property 'scheduledEventsProfile'
• VirtualMachineScaleSetVMProfile: Removed property 'additionalCapabilities'

2018-10-01

Added:

• AutomaticOSUpgradePolicy
• AutomaticRepairsPolicy

Removed:

• AutoOSUpgradePolicy

Updated:

• UpgradePolicy: Added property 'automaticOSUpgradePolicy'
• UpgradePolicy: Removed property 'automaticOSUpgrade'
• UpgradePolicy: Removed property 'autoOSUpgradePolicy'
• VirtualMachineScaleSetProperties: Added property 'automaticRepairsPolicy'
• VirtualMachineScaleSetProperties: Added property 'doNotRunExtensionsOnOverprovisionedVMs'

2018-06-01

Added:

• AdditionalCapabilities
• DiffDiskSettings
• VirtualMachineScaleSetIdentityUserAssignedIdentities
• VirtualMachineScaleSetIdentityUserAssignedIdentitiesValue

Updated:

• LinuxConfiguration: Added property 'provisionVMAgent'
• VirtualMachineScaleSetIdentity: Added property 'userAssignedIdentities'
• VirtualMachineScaleSetIdentity: Removed property 'identityIds'
• VirtualMachineScaleSetOSDisk: Added property 'diffDiskSettings'
• VirtualMachineScaleSetVMProfile: Added property 'additionalCapabilities'

2018-04-01

Added:

• SubResource

Updated:

• VirtualMachineScaleSetOSDisk: Added property 'diskSizeGB'
• VirtualMachineScaleSetProperties: Added property 'proximityPlacementGroup'

2017-12-01

Added:

• AutoOSUpgradePolicy

Updated:

• UpgradePolicy: Added property 'autoOSUpgradePolicy'
• VirtualMachineScaleSetDataDisk: Added property 'writeAcceleratorEnabled'
• VirtualMachineScaleSetIdentity: Added property 'identityIds'
• VirtualMachineScaleSetOSDisk: Added property 'writeAcceleratorEnabled'
• VirtualMachineScaleSetProperties: Added property 'platformFaultDomainCount'
• VirtualMachineScaleSetProperties: Added property 'zoneBalance'
• VirtualMachineScaleSetVMProfile: Added property 'evictionPolicy'
• VirtualMachineScaleSetVMProfile: Added property 'priority'

2017-03-30

Added:

• ApiEntityReference
• BootDiagnostics
• DiagnosticsProfile
• RollingUpgradePolicy

Updated:

• Microsoft.Compute/virtualMachineScaleSets: Added property 'zones'
• UpgradePolicy: Added property 'automaticOSUpgrade'
• UpgradePolicy: Added property 'rollingUpgradePolicy'
• VirtualMachineScaleSetNetworkProfile: Added property 'healthProbe'
• VirtualMachineScaleSetProperties: Added property 'overprovision'
• VirtualMachineScaleSetProperties: Added property 'uniqueId'
• VirtualMachineScaleSetProperties: Removed property 'overProvision'
• VirtualMachineScaleSetVMProfile: Added property 'diagnosticsProfile'
• VirtualMachineScaleSetVMProfile: Added property 'licenseType'

2016-04-30-preview

Added:

• Plan
• VirtualMachineScaleSetDataDisk
• VirtualMachineScaleSetManagedDiskParameters

Updated:

• ImageReference: Added property 'id'
• Microsoft.Compute/virtualMachineScaleSets: Added property 'plan'
• VirtualMachineScaleSetOSDisk: Added property 'managedDisk'
• VirtualMachineScaleSetProperties: Added property 'singlePlacementGroup'
• VirtualMachineScaleSetStorageProfile: Added property 'dataDisks'

2016-03-30

Added:

• VirtualMachineScaleSetIdentity

Updated:

• Microsoft.Compute/virtualMachineScaleSets: Added property 'identity'

2015-06-15

Oldest version tracked in change log