VirtualMachineScaleSetUpdate Class

Package:

com.azure.resourcemanager.compute.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.38.0

• java.lang.Object
• • com.azure.resourcemanager.compute.models.UpdateResource
  • • com.azure.resourcemanager.compute.models.VirtualMachineScaleSetUpdate

public final class VirtualMachineScaleSetUpdate
extends UpdateResource

Describes a Virtual Machine Scale Set.

Constructor Summary

Constructor	Description
VirtualMachineScaleSetUpdate()	Creates an instance of VirtualMachineScaleSetUpdate class.

Method Summary

Modifier and Type	Method and Description
AdditionalCapabilities	additionalCapabilities() Get the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set.
AutomaticRepairsPolicy	automaticRepairsPolicy() Get the automaticRepairsPolicy property: Policy for automatic repairs.
Boolean	doNotRunExtensionsOnOverprovisionedVMs() Get the doNotRunExtensionsOnOverprovisionedVMs property: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept.
VirtualMachineScaleSetIdentity	identity() Get the identity property: The identity of the virtual machine scale set, if configured.
Boolean	overprovision() Get the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
Plan	plan() Get the plan property: The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
PriorityMixPolicy	priorityMixPolicy() Get the priorityMixPolicy property: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
SubResource	proximityPlacementGroup() Get the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
ResiliencyPolicy	resiliencyPolicy() Get the resiliencyPolicy property: Policy for Resiliency.
ScaleInPolicy	scaleInPolicy() Get the scaleInPolicy property: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
Boolean	singlePlacementGroup() Get the singlePlacementGroup property: When true this limits the scale set to a single placement group, of max size 100 virtual machines.
Sku	sku() Get the sku property: The virtual machine scale set sku.
SpotRestorePolicy	spotRestorePolicy() Get the spotRestorePolicy property: Specifies the Spot Restore properties for the virtual machine scale set.
UpgradePolicy	upgradePolicy() Get the upgradePolicy property: The upgrade policy.
void	validate() Validates the instance.
VirtualMachineScaleSetUpdateVMProfile	virtualMachineProfile() Get the virtualMachineProfile property: The virtual machine profile.
VirtualMachineScaleSetUpdate	withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities) Set the additionalCapabilities property: Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set.
VirtualMachineScaleSetUpdate	withAutomaticRepairsPolicy(AutomaticRepairsPolicy automaticRepairsPolicy) Set the automaticRepairsPolicy property: Policy for automatic repairs.
VirtualMachineScaleSetUpdate	withDoNotRunExtensionsOnOverprovisionedVMs(Boolean doNotRunExtensionsOnOverprovisionedVMs) Set the doNotRunExtensionsOnOverprovisionedVMs property: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept.
VirtualMachineScaleSetUpdate	withIdentity(VirtualMachineScaleSetIdentity identity) Set the identity property: The identity of the virtual machine scale set, if configured.
VirtualMachineScaleSetUpdate	withOverprovision(Boolean overprovision) Set the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
VirtualMachineScaleSetUpdate	withPlan(Plan plan) Set the plan property: The purchase plan when deploying a virtual machine scale set from VM Marketplace images.
VirtualMachineScaleSetUpdate	withPriorityMixPolicy(PriorityMixPolicy priorityMixPolicy) Set the priorityMixPolicy property: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
VirtualMachineScaleSetUpdate	withProximityPlacementGroup(SubResource proximityPlacementGroup) Set the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
VirtualMachineScaleSetUpdate	withResiliencyPolicy(ResiliencyPolicy resiliencyPolicy) Set the resiliencyPolicy property: Policy for Resiliency.
VirtualMachineScaleSetUpdate	withScaleInPolicy(ScaleInPolicy scaleInPolicy) Set the scaleInPolicy property: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
VirtualMachineScaleSetUpdate	withSinglePlacementGroup(Boolean singlePlacementGroup) Set the singlePlacementGroup property: When true this limits the scale set to a single placement group, of max size 100 virtual machines.
VirtualMachineScaleSetUpdate	withSku(Sku sku) Set the sku property: The virtual machine scale set sku.
VirtualMachineScaleSetUpdate	withSpotRestorePolicy(SpotRestorePolicy spotRestorePolicy) Set the spotRestorePolicy property: Specifies the Spot Restore properties for the virtual machine scale set.
VirtualMachineScaleSetUpdate	withTags(Map<String,String> tags) Set the tags property: Resource tags.
VirtualMachineScaleSetUpdate	withUpgradePolicy(UpgradePolicy upgradePolicy) Set the upgradePolicy property: The upgrade policy.
VirtualMachineScaleSetUpdate	withVirtualMachineProfile(VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile) Set the virtualMachineProfile property: The virtual machine profile.

Methods inherited from UpdateResource

tags validate withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VirtualMachineScaleSetUpdate

public VirtualMachineScaleSetUpdate()

Creates an instance of VirtualMachineScaleSetUpdate class.

Method Details

additionalCapabilities

public AdditionalCapabilities additionalCapabilities()

Get the additionalCapabilities property: 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.

Returns:

the additionalCapabilities value.

automaticRepairsPolicy

public AutomaticRepairsPolicy automaticRepairsPolicy()

Get the automaticRepairsPolicy property: Policy for automatic repairs.

Returns:

the automaticRepairsPolicy value.

doNotRunExtensionsOnOverprovisionedVMs

public Boolean doNotRunExtensionsOnOverprovisionedVMs()

Get the doNotRunExtensionsOnOverprovisionedVMs property: 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.

Returns:

the doNotRunExtensionsOnOverprovisionedVMs value.

identity

public VirtualMachineScaleSetIdentity identity()

Get the identity property: The identity of the virtual machine scale set, if configured.

Returns:

the identity value.

overprovision

public Boolean overprovision()

Get the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned.

Returns:

the overprovision value.

plan

public Plan plan()

Get the plan property: The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

Returns:

the plan value.

priorityMixPolicy

public PriorityMixPolicy priorityMixPolicy()

Get the priorityMixPolicy property: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.

Returns:

the priorityMixPolicy value.

proximityPlacementGroup

public SubResource proximityPlacementGroup()

Get the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01.

Returns:

the proximityPlacementGroup value.

resiliencyPolicy

public ResiliencyPolicy resiliencyPolicy()

Get the resiliencyPolicy property: Policy for Resiliency.

Returns:

the resiliencyPolicy value.

scaleInPolicy

public ScaleInPolicy scaleInPolicy()

Get the scaleInPolicy property: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.

Returns:

the scaleInPolicy value.

singlePlacementGroup

public Boolean singlePlacementGroup()

Get the singlePlacementGroup property: 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.

Returns:

the singlePlacementGroup value.

sku

public Sku sku()

Get the sku property: The virtual machine scale set sku.

Returns:

the sku value.

spotRestorePolicy

public SpotRestorePolicy spotRestorePolicy()

Get the spotRestorePolicy property: Specifies the Spot Restore properties for the virtual machine scale set.

Returns:

the spotRestorePolicy value.

upgradePolicy

public UpgradePolicy upgradePolicy()

Get the upgradePolicy property: The upgrade policy.

Returns:

the upgradePolicy value.

validate

public void validate()

Validates the instance.

Overrides:

VirtualMachineScaleSetUpdate.validate()

virtualMachineProfile

public VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile()

Get the virtualMachineProfile property: The virtual machine profile.

Returns:

the virtualMachineProfile value.

withAdditionalCapabilities

public VirtualMachineScaleSetUpdate withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities)

Set the additionalCapabilities property: 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.

Parameters:

additionalCapabilities - the additionalCapabilities value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withAutomaticRepairsPolicy

public VirtualMachineScaleSetUpdate withAutomaticRepairsPolicy(AutomaticRepairsPolicy automaticRepairsPolicy)

Set the automaticRepairsPolicy property: Policy for automatic repairs.

Parameters:

automaticRepairsPolicy - the automaticRepairsPolicy value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withDoNotRunExtensionsOnOverprovisionedVMs

public VirtualMachineScaleSetUpdate withDoNotRunExtensionsOnOverprovisionedVMs(Boolean doNotRunExtensionsOnOverprovisionedVMs)

Set the doNotRunExtensionsOnOverprovisionedVMs property: 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.

Parameters:

doNotRunExtensionsOnOverprovisionedVMs - the doNotRunExtensionsOnOverprovisionedVMs value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withIdentity

public VirtualMachineScaleSetUpdate withIdentity(VirtualMachineScaleSetIdentity identity)

Set the identity property: The identity of the virtual machine scale set, if configured.

Parameters:

identity - the identity value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withOverprovision

public VirtualMachineScaleSetUpdate withOverprovision(Boolean overprovision)

Set the overprovision property: Specifies whether the Virtual Machine Scale Set should be overprovisioned.

Parameters:

overprovision - the overprovision value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withPlan

public VirtualMachineScaleSetUpdate withPlan(Plan plan)

Set the plan property: The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

Parameters:

plan - the plan value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withPriorityMixPolicy

public VirtualMachineScaleSetUpdate withPriorityMixPolicy(PriorityMixPolicy priorityMixPolicy)

Set the priorityMixPolicy property: Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.

Parameters:

priorityMixPolicy - the priorityMixPolicy value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withProximityPlacementGroup

public VirtualMachineScaleSetUpdate withProximityPlacementGroup(SubResource proximityPlacementGroup)

Set the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01.

Parameters:

proximityPlacementGroup - the proximityPlacementGroup value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withResiliencyPolicy

public VirtualMachineScaleSetUpdate withResiliencyPolicy(ResiliencyPolicy resiliencyPolicy)

Set the resiliencyPolicy property: Policy for Resiliency.

Parameters:

resiliencyPolicy - the resiliencyPolicy value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withScaleInPolicy

public VirtualMachineScaleSetUpdate withScaleInPolicy(ScaleInPolicy scaleInPolicy)

Set the scaleInPolicy property: Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.

Parameters:

scaleInPolicy - the scaleInPolicy value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withSinglePlacementGroup

public VirtualMachineScaleSetUpdate withSinglePlacementGroup(Boolean singlePlacementGroup)

Set the singlePlacementGroup property: 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.

Parameters:

singlePlacementGroup - the singlePlacementGroup value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withSku

public VirtualMachineScaleSetUpdate withSku(Sku sku)

Set the sku property: The virtual machine scale set sku.

Parameters:

sku - the sku value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withSpotRestorePolicy

public VirtualMachineScaleSetUpdate withSpotRestorePolicy(SpotRestorePolicy spotRestorePolicy)

Set the spotRestorePolicy property: Specifies the Spot Restore properties for the virtual machine scale set.

Parameters:

spotRestorePolicy - the spotRestorePolicy value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withTags

public VirtualMachineScaleSetUpdate withTags(Map tags)

Set the tags property: Resource tags.

Overrides:

VirtualMachineScaleSetUpdate.withTags(Map<String,String> tags)

Parameters:

tags

withUpgradePolicy

public VirtualMachineScaleSetUpdate withUpgradePolicy(UpgradePolicy upgradePolicy)

Set the upgradePolicy property: The upgrade policy.

Parameters:

upgradePolicy - the upgradePolicy value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

withVirtualMachineProfile

public VirtualMachineScaleSetUpdate withVirtualMachineProfile(VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile)

Set the virtualMachineProfile property: The virtual machine profile.

Parameters:

virtualMachineProfile - the virtualMachineProfile value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.