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. |
| proximity |
Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. |
| scale |
Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in. |
| 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. |
| upgrade |
The upgrade policy. |
| virtual |
The virtual machine profile. |
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?: AdditionalCapabilitiesProperty Value
automaticRepairsPolicy
Policy for automatic repairs.
automaticRepairsPolicy?: AutomaticRepairsPolicyProperty 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?: booleanProperty Value
boolean
identity
The identity of the virtual machine scale set, if configured.
identity?: VirtualMachineScaleSetIdentityProperty Value
overprovision
Specifies whether the Virtual Machine Scale Set should be overprovisioned.
overprovision?: booleanProperty Value
boolean
plan
The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
plan?: PlanProperty 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?: SubResourceProperty Value
scaleInPolicy
Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.
scaleInPolicy?: ScaleInPolicyProperty 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?: booleanProperty Value
boolean
sku
upgradePolicy
virtualMachineProfile
The virtual machine profile.
virtualMachineProfile?: VirtualMachineScaleSetUpdateVMProfileProperty Value
Inherited Property Details
tags
Resource tags
tags?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}
Inherited From UpdateResource.tags