VirtualMachineScaleSetUpdate interface
Describes a Virtual Machine Scale Set.
- Extends
Properties
additional |
Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type. |
automatic |
Policy for automatic repairs. |
do |
When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs. |
identity | The identity of the virtual machine scale set, if configured. |
overprovision | Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
plan | The purchase plan when deploying a virtual machine scale set from VM Marketplace images. |
priority |
Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. |
proximity |
Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. |
resiliency |
Policy for Resiliency |
scale |
Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. |
single |
When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true. |
sku | The virtual machine scale set sku. |
sku |
Specifies the sku profile for the virtual machine scale set. |
spot |
Specifies the Spot Restore properties for the virtual machine scale set. |
upgrade |
The upgrade policy. |
virtual |
The virtual machine profile. |
zonal |
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. |
zones | The virtual machine scale set zones. |
Inherited Properties
tags | Resource tags |
Property Details
additionalCapabilities
Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
additionalCapabilities?: AdditionalCapabilities
Property Value
automaticRepairsPolicy
Policy for automatic repairs.
automaticRepairsPolicy?: AutomaticRepairsPolicy
Property Value
doNotRunExtensionsOnOverprovisionedVMs
When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
doNotRunExtensionsOnOverprovisionedVMs?: boolean
Property Value
boolean
identity
The identity of the virtual machine scale set, if configured.
identity?: VirtualMachineScaleSetIdentity
Property Value
overprovision
Specifies whether the Virtual Machine Scale Set should be overprovisioned.
overprovision?: boolean
Property Value
boolean
plan
The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
plan?: Plan
Property Value
priorityMixPolicy
Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
priorityMixPolicy?: PriorityMixPolicy
Property Value
proximityPlacementGroup
Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
Minimum api-version: 2018-04-01.
proximityPlacementGroup?: SubResource
Property Value
resiliencyPolicy
scaleInPolicy
Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
scaleInPolicy?: ScaleInPolicy
Property Value
singlePlacementGroup
When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
singlePlacementGroup?: boolean
Property Value
boolean
sku
skuProfile
Specifies the sku profile for the virtual machine scale set.
skuProfile?: SkuProfile
Property Value
spotRestorePolicy
Specifies the Spot Restore properties for the virtual machine scale set.
spotRestorePolicy?: SpotRestorePolicy
Property Value
upgradePolicy
virtualMachineProfile
The virtual machine profile.
virtualMachineProfile?: VirtualMachineScaleSetUpdateVMProfile
Property Value
zonalPlatformFaultDomainAlignMode
Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.
zonalPlatformFaultDomainAlignMode?: string
Property Value
string
zones
The virtual machine scale set zones.
zones?: string[]
Property Value
string[]
Inherited Property Details
tags
Resource tags
tags?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From UpdateResource.tags