com.azure.resourcemanager.compute.models

Class VirtualMachineScaleSetUpdate

java.lang.Object

com.azure.resourcemanager.compute.models.UpdateResource

com.azure.resourcemanager.compute.models.VirtualMachineScaleSetUpdate

public class VirtualMachineScaleSetUpdate
extends UpdateResource

Describes a Virtual Machine Scale Set.

Constructor Summary

Constructors

Constructor and Description
VirtualMachineScaleSetUpdate()

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.
com.azure.core.management.SubResource	proximityPlacementGroup() Get the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
ScaleInPolicy	scaleInPolicy() Get the scaleInPolicy property: Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.
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.
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	withProximityPlacementGroup(com.azure.core.management.SubResource proximityPlacementGroup) Set the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
VirtualMachineScaleSetUpdate	withScaleInPolicy(ScaleInPolicy scaleInPolicy) Set the scaleInPolicy property: Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.
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	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 class com.azure.resourcemanager.compute.models.UpdateResource

tags, withTags

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VirtualMachineScaleSetUpdate

public VirtualMachineScaleSetUpdate()

Method Detail

sku

public Sku sku()

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

Returns:

the sku value.

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.

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.

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.

identity

public VirtualMachineScaleSetIdentity identity()

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

Returns:

the identity value.

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.

upgradePolicy

public UpgradePolicy upgradePolicy()

Get the upgradePolicy property: The upgrade policy.

Returns:

the upgradePolicy value.

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.

automaticRepairsPolicy

public AutomaticRepairsPolicy automaticRepairsPolicy()

Get the automaticRepairsPolicy property: Policy for automatic repairs.

Returns:

the automaticRepairsPolicy value.

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.

virtualMachineProfile

public VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile()

Get the virtualMachineProfile property: The virtual machine profile.

Returns:

the virtualMachineProfile value.

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.

overprovision

public Boolean overprovision()

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

Returns:

the overprovision value.

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.

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.

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.

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.

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.

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.

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.

scaleInPolicy

public ScaleInPolicy scaleInPolicy()

Get the scaleInPolicy property: Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.

Returns:

the scaleInPolicy value.

withScaleInPolicy

public VirtualMachineScaleSetUpdate withScaleInPolicy(ScaleInPolicy scaleInPolicy)

Set the scaleInPolicy property: Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.

Parameters:

scaleInPolicy - the scaleInPolicy value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

proximityPlacementGroup

public com.azure.core.management.SubResource proximityPlacementGroup()

Get the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01.

Returns:

the proximityPlacementGroup value.

withProximityPlacementGroup

public VirtualMachineScaleSetUpdate withProximityPlacementGroup(com.azure.core.management.SubResource proximityPlacementGroup)

Set the proximityPlacementGroup property: Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. <br><br>Minimum api-version: 2018-04-01.

Parameters:

proximityPlacementGroup - the proximityPlacementGroup value to set.

Returns:

the VirtualMachineScaleSetUpdate object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class UpdateResource

Throws:

IllegalArgumentException - thrown if the instance is not valid.