VirtualMachineScaleSetUpdate (Microsoft Azure Management Libraries for Java 1.31.1)

java.lang.Object
- com.microsoft.azure.ProxyResource
- - com.microsoft.azure.management.compute.UpdateResource
  - - com.microsoft.azure.management.compute.VirtualMachineScaleSetUpdate

public class VirtualMachineScaleSetUpdate
extends UpdateResource

Describes a Virtual Machine Scale Set.

Constructor Summary

Constructors
Constructor and Description

VirtualMachineScaleSetUpdate()

Constructors
Constructor and Description
`VirtualMachineScaleSetUpdate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdditionalCapabilities`	`additionalCapabilities()` Get specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set.
`AutomaticRepairsPolicy`	`automaticRepairsPolicy()` Get policy for automatic repairs.
`Boolean`	`doNotRunExtensionsOnOverprovisionedVMs()` Get when Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept.
`VirtualMachineScaleSetIdentity`	`identity()` Get the identity of the virtual machine scale set, if configured.
`Boolean`	`overprovision()` Get specifies whether the Virtual Machine Scale Set should be overprovisioned.
`Plan`	`plan()` Get the purchase plan when deploying a virtual machine scale set from VM Marketplace images.
`com.microsoft.azure.SubResource`	`proximityPlacementGroup()` Get specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
`ScaleInPolicy`	`scaleInPolicy()` Get 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 when true this limits the scale set to a single placement group, of max size 100 virtual machines.
`Sku`	`sku()` Get the virtual machine scale set sku.
`UpgradePolicy`	`upgradePolicy()` Get the upgrade policy.
`VirtualMachineScaleSetUpdateVMProfile`	`virtualMachineProfile()` Get the virtual machine profile.
`VirtualMachineScaleSetUpdate`	`withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities)` Set specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set.
`VirtualMachineScaleSetUpdate`	`withAutomaticRepairsPolicy(AutomaticRepairsPolicy automaticRepairsPolicy)` Set policy for automatic repairs.
`VirtualMachineScaleSetUpdate`	`withDoNotRunExtensionsOnOverprovisionedVMs(Boolean doNotRunExtensionsOnOverprovisionedVMs)` Set 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 of the virtual machine scale set, if configured.
`VirtualMachineScaleSetUpdate`	`withOverprovision(Boolean overprovision)` Set specifies whether the Virtual Machine Scale Set should be overprovisioned.
`VirtualMachineScaleSetUpdate`	`withPlan(Plan plan)` Set the purchase plan when deploying a virtual machine scale set from VM Marketplace images.
`VirtualMachineScaleSetUpdate`	`withProximityPlacementGroup(com.microsoft.azure.SubResource proximityPlacementGroup)` Set specifies information about the proximity placement group that the virtual machine scale set should be assigned to.
`VirtualMachineScaleSetUpdate`	`withScaleInPolicy(ScaleInPolicy scaleInPolicy)` Set 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 when true this limits the scale set to a single placement group, of max size 100 virtual machines.
`VirtualMachineScaleSetUpdate`	`withSku(Sku sku)` Set the virtual machine scale set sku.
`VirtualMachineScaleSetUpdate`	`withUpgradePolicy(UpgradePolicy upgradePolicy)` Set the upgrade policy.
`VirtualMachineScaleSetUpdate`	`withVirtualMachineProfile(VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile)` Set the virtual machine profile.

Methods inherited from class com.microsoft.azure.management.compute.UpdateResource
tags, withTags

Methods inherited from class com.microsoft.azure.ProxyResource
id, name, type

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 virtual machine scale set sku.
    
    Returns:
    
    the sku value
  - withSku
```
public VirtualMachineScaleSetUpdate withSku(Sku sku)
```
    Set the virtual machine scale set sku.
    
    Parameters:
    
    sku - the sku value to set
    
    Returns:
    
    the VirtualMachineScaleSetUpdate object itself.
  - plan
```
public Plan plan()
```
    Get 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 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.
  - upgradePolicy
```
public UpgradePolicy upgradePolicy()
```
    Get the upgrade policy.
    
    Returns:
    
    the upgradePolicy value
  - withUpgradePolicy
```
public VirtualMachineScaleSetUpdate withUpgradePolicy(UpgradePolicy upgradePolicy)
```
    Set the upgrade policy.
    
    Parameters:
    
    upgradePolicy - the upgradePolicy value to set
    
    Returns:
    
    the VirtualMachineScaleSetUpdate object itself.
  - automaticRepairsPolicy
```
public AutomaticRepairsPolicy automaticRepairsPolicy()
```
    Get policy for automatic repairs.
    
    Returns:
    
    the automaticRepairsPolicy value
  - withAutomaticRepairsPolicy
```
public VirtualMachineScaleSetUpdate withAutomaticRepairsPolicy(AutomaticRepairsPolicy automaticRepairsPolicy)
```
    Set policy for automatic repairs.
    
    Parameters:
    
    automaticRepairsPolicy - the automaticRepairsPolicy value to set
    
    Returns:
    
    the VirtualMachineScaleSetUpdate object itself.
  - virtualMachineProfile
```
public VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile()
```
    Get the virtual machine profile.
    
    Returns:
    
    the virtualMachineProfile value
  - withVirtualMachineProfile
```
public VirtualMachineScaleSetUpdate withVirtualMachineProfile(VirtualMachineScaleSetUpdateVMProfile virtualMachineProfile)
```
    Set the virtual machine profile.
    
    Parameters:
    
    virtualMachineProfile - the virtualMachineProfile value to set
    
    Returns:
    
    the VirtualMachineScaleSetUpdate object itself.
  - overprovision
```
public Boolean overprovision()
```
    Get specifies whether the Virtual Machine Scale Set should be overprovisioned.
    
    Returns:
    
    the overprovision value
  - withOverprovision
```
public VirtualMachineScaleSetUpdate withOverprovision(Boolean overprovision)
```
    Set 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 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 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 when true this limits the scale set to a single placement group, of max size 100 virtual machines.
    
    Returns:
    
    the singlePlacementGroup value
  - withSinglePlacementGroup
```
public VirtualMachineScaleSetUpdate withSinglePlacementGroup(Boolean singlePlacementGroup)
```
    Set when true this limits the scale set to a single placement group, of max size 100 virtual machines.
    
    Parameters:
    
    singlePlacementGroup - the singlePlacementGroup value to set
    
    Returns:
    
    the VirtualMachineScaleSetUpdate object itself.
  - additionalCapabilities
```
public AdditionalCapabilities additionalCapabilities()
```
    Get 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 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 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 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.microsoft.azure.SubResource proximityPlacementGroup()
```
    Get 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.microsoft.azure.SubResource proximityPlacementGroup)
```
    Set 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.
  - identity
```
public VirtualMachineScaleSetIdentity identity()
```
    Get the identity of the virtual machine scale set, if configured.
    
    Returns:
    
    the identity value
  - withIdentity
```
public VirtualMachineScaleSetUpdate withIdentity(VirtualMachineScaleSetIdentity identity)
```
    Set the identity of the virtual machine scale set, if configured.
    
    Parameters:
    
    identity - the identity value to set
    
    Returns:
    
    the VirtualMachineScaleSetUpdate object itself.

/** 
* Copyright (c) Microsoft Corporation. All rights reserved. 
* Licensed under the MIT License. See License.txt in the project root for 
* license information. 
*/

Class VirtualMachineScaleSetUpdate

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.azure.management.compute.UpdateResource

Methods inherited from class com.microsoft.azure.ProxyResource

Methods inherited from class java.lang.Object

Constructor Detail

VirtualMachineScaleSetUpdate

Method Detail

sku

withSku

plan

withPlan

upgradePolicy

withUpgradePolicy

automaticRepairsPolicy

withAutomaticRepairsPolicy

virtualMachineProfile

withVirtualMachineProfile

overprovision

withOverprovision

doNotRunExtensionsOnOverprovisionedVMs

withDoNotRunExtensionsOnOverprovisionedVMs

singlePlacementGroup

withSinglePlacementGroup

additionalCapabilities

withAdditionalCapabilities

scaleInPolicy

withScaleInPolicy

proximityPlacementGroup

withProximityPlacementGroup

identity

withIdentity