com.microsoft.azure.management.compute

Class VirtualMachineUpdate

java.lang.Object

com.microsoft.azure.management.compute.UpdateResource

com.microsoft.azure.management.compute.VirtualMachineUpdate

public class VirtualMachineUpdate
extends UpdateResource

Describes a Virtual Machine Update.

Constructor Summary

Constructors

Constructor and Description
VirtualMachineUpdate()

Method Summary

Modifier and Type	Method and Description
AdditionalCapabilities	additionalCapabilities() Get specifies additional capabilities enabled or disabled on the virtual machine.
SubResource	availabilitySet() Get specifies information about the availability set that the virtual machine should be assigned to.
DiagnosticsProfile	diagnosticsProfile() Get specifies the boot diagnostic settings state.
HardwareProfile	hardwareProfile() Get specifies the hardware settings for the virtual machine.
VirtualMachineIdentity	identity() Get the identity of the virtual machine, if configured.
com.microsoft.azure.management.compute.implementation.VirtualMachineInstanceViewInner	instanceView() Get the virtual machine instance view.
String	licenseType() Get specifies that the image or disk that is being used was licensed on-premises.
NetworkProfile	networkProfile() Get specifies the network interfaces of the virtual machine.
OSProfile	osProfile() Get specifies the operating system settings for the virtual machine.
Plan	plan() Get specifies information about the marketplace image used to create the virtual machine.
String	provisioningState() Get the provisioning state, which only appears in the response.
SubResource	proximityPlacementGroup() Get specifies information about the proximity placement group that the virtual machine should be assigned to.
StorageProfile	storageProfile() Get specifies the storage settings for the virtual machine disks.
String	vmId() Get specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.
VirtualMachineUpdate	withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities) Set specifies additional capabilities enabled or disabled on the virtual machine.
VirtualMachineUpdate	withAvailabilitySet(SubResource availabilitySet) Set specifies information about the availability set that the virtual machine should be assigned to.
VirtualMachineUpdate	withDiagnosticsProfile(DiagnosticsProfile diagnosticsProfile) Set specifies the boot diagnostic settings state.
VirtualMachineUpdate	withHardwareProfile(HardwareProfile hardwareProfile) Set specifies the hardware settings for the virtual machine.
VirtualMachineUpdate	withIdentity(VirtualMachineIdentity identity) Set the identity of the virtual machine, if configured.
VirtualMachineUpdate	withLicenseType(String licenseType) Set specifies that the image or disk that is being used was licensed on-premises.
VirtualMachineUpdate	withNetworkProfile(NetworkProfile networkProfile) Set specifies the network interfaces of the virtual machine.
VirtualMachineUpdate	withOsProfile(OSProfile osProfile) Set specifies the operating system settings for the virtual machine.
VirtualMachineUpdate	withPlan(Plan plan) Set specifies information about the marketplace image used to create the virtual machine.
VirtualMachineUpdate	withProximityPlacementGroup(SubResource proximityPlacementGroup) Set specifies information about the proximity placement group that the virtual machine should be assigned to.
VirtualMachineUpdate	withStorageProfile(StorageProfile storageProfile) Set specifies the storage settings for the virtual machine disks.
VirtualMachineUpdate	withZones(List<String> zones) Set the virtual machine zones.
List<String>	zones() Get the virtual machine zones.

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

tags, withTags

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualMachineUpdate

public VirtualMachineUpdate()

Method Detail

plan

public Plan plan()

Get specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.

Returns:

the plan value

withPlan

public VirtualMachineUpdate withPlan(Plan plan)

Set specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**.

Parameters:

plan - the plan value to set

Returns:

the VirtualMachineUpdate object itself.

hardwareProfile

public HardwareProfile hardwareProfile()

Get specifies the hardware settings for the virtual machine.

Returns:

the hardwareProfile value

withHardwareProfile

public VirtualMachineUpdate withHardwareProfile(HardwareProfile hardwareProfile)

Set specifies the hardware settings for the virtual machine.

Parameters:

hardwareProfile - the hardwareProfile value to set

Returns:

the VirtualMachineUpdate object itself.

storageProfile

public StorageProfile storageProfile()

Get specifies the storage settings for the virtual machine disks.

Returns:

the storageProfile value

withStorageProfile

public VirtualMachineUpdate withStorageProfile(StorageProfile storageProfile)

Set specifies the storage settings for the virtual machine disks.

Parameters:

storageProfile - the storageProfile value to set

Returns:

the VirtualMachineUpdate object itself.

additionalCapabilities

public AdditionalCapabilities additionalCapabilities()

Get specifies additional capabilities enabled or disabled on the virtual machine.

Returns:

the additionalCapabilities value

withAdditionalCapabilities

public VirtualMachineUpdate withAdditionalCapabilities(AdditionalCapabilities additionalCapabilities)

Set specifies additional capabilities enabled or disabled on the virtual machine.

Parameters:

additionalCapabilities - the additionalCapabilities value to set

Returns:

the VirtualMachineUpdate object itself.

osProfile

public OSProfile osProfile()

Get specifies the operating system settings for the virtual machine.

Returns:

the osProfile value

withOsProfile

public VirtualMachineUpdate withOsProfile(OSProfile osProfile)

Set specifies the operating system settings for the virtual machine.

Parameters:

osProfile - the osProfile value to set

Returns:

the VirtualMachineUpdate object itself.

networkProfile

public NetworkProfile networkProfile()

Get specifies the network interfaces of the virtual machine.

Returns:

the networkProfile value

withNetworkProfile

public VirtualMachineUpdate withNetworkProfile(NetworkProfile networkProfile)

Set specifies the network interfaces of the virtual machine.

Parameters:

networkProfile - the networkProfile value to set

Returns:

the VirtualMachineUpdate object itself.

diagnosticsProfile

public DiagnosticsProfile diagnosticsProfile()

Get specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

Returns:

the diagnosticsProfile value

withDiagnosticsProfile

public VirtualMachineUpdate withDiagnosticsProfile(DiagnosticsProfile diagnosticsProfile)

Set specifies the boot diagnostic settings state. <br><br>Minimum api-version: 2015-06-15.

Parameters:

diagnosticsProfile - the diagnosticsProfile value to set

Returns:

the VirtualMachineUpdate object itself.

availabilitySet

public SubResource availabilitySet()

Get specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

Returns:

the availabilitySet value

withAvailabilitySet

public VirtualMachineUpdate withAvailabilitySet(SubResource availabilitySet)

Set specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). <br><br> For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.

Parameters:

availabilitySet - the availabilitySet value to set

Returns:

the VirtualMachineUpdate object itself.

proximityPlacementGroup

public SubResource proximityPlacementGroup()

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

Returns:

the proximityPlacementGroup value

withProximityPlacementGroup

public VirtualMachineUpdate withProximityPlacementGroup(SubResource proximityPlacementGroup)

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

Parameters:

proximityPlacementGroup - the proximityPlacementGroup value to set

Returns:

the VirtualMachineUpdate object itself.

provisioningState

public String provisioningState()

Get the provisioning state, which only appears in the response.

Returns:

the provisioningState value

instanceView

public com.microsoft.azure.management.compute.implementation.VirtualMachineInstanceViewInner instanceView()

Get the virtual machine instance view.

Returns:

the instanceView value

licenseType

public String licenseType()

Get specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15.

Returns:

the licenseType value

withLicenseType

public VirtualMachineUpdate withLicenseType(String licenseType)

Set specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. <br><br> Possible values are: <br><br> Windows_Client <br><br> Windows_Server <br><br> If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. <br><br> For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) <br><br> Minimum api-version: 2015-06-15.

Parameters:

licenseType - the licenseType value to set

Returns:

the VirtualMachineUpdate object itself.

vmId

public String vmId()

Get specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

Returns:

the vmId value

identity

public VirtualMachineIdentity identity()

Get the identity of the virtual machine, if configured.

Returns:

the identity value

withIdentity

public VirtualMachineUpdate withIdentity(VirtualMachineIdentity identity)

Set the identity of the virtual machine, if configured.

Parameters:

identity - the identity value to set

Returns:

the VirtualMachineUpdate object itself.

zones

public List<String> zones()

Get the virtual machine zones.

Returns:

the zones value

withZones

public VirtualMachineUpdate withZones(List<String> zones)

Set the virtual machine zones.

Parameters:

zones - the zones value to set

Returns:

the VirtualMachineUpdate object itself.