VirtualMachine.Update Interface

Implements

public static interface VirtualMachine.Update
extends Appliable<VirtualMachine>, UpdateWithTags<Update>, WithProximityPlacementGroup, WithUnmanagedDataDisk, WithManagedDataDisk, WithSecondaryNetworkInterface, WithExtension, WithBootDiagnostics, WithBillingProfile, WithSystemAssignedManagedServiceIdentity, WithUserAssignedManagedServiceIdentity, WithLicenseType, WithAdditionalCapacities, WithOSDisk, WithSecurityFeatures, WithDeleteOptions, WithSecurityProfile, WithUserData, WithCapacityReservation

The template for an update operation, containing all the settings that can be modified.

Method Summary

Modifier and Type Method and Description
abstract Update withDataDiskDefaultCachingType(CachingTypes cachingType)

Specifies the default caching type for the managed data disks.

abstract Update withDataDiskDefaultDeleteOptions(DeleteOptions deleteOptions)

Specifies the delete options for managed data disks.

abstract Update withDataDiskDefaultDiskEncryptionSet(String diskEncryptionSetId)

Specifies the disk encryption set for the managed data disk.

abstract Update withDataDiskDefaultStorageAccountType(StorageAccountTypes storageAccountType)

Specifies a storage account type.

abstract Update withDataDiskDefaultWriteAcceleratorEnabled(boolean writeAcceleratorEnabled)

Specifies the write accelerator for managed data disks.

abstract Update withOSDiskCaching(CachingTypes cachingType)

Specifies the caching type for the OS disk.

abstract Update withOSDiskEncryptionSettings(DiskEncryptionSettings settings)

Specifies the encryption settings for the OS Disk.

abstract Update withOSDiskSizeInGB(int size)

Specifies the size of the OS disk in GB.

abstract Update withOSDiskWriteAcceleratorEnabled(boolean writeAcceleratorEnabled)

Specifies the write accelerator for the OS disks.

abstract Update withPriority(VirtualMachinePriorityTypes priority)

Specifies a new priority for the virtual machine.

abstract Update withSize(VirtualMachineSizeTypes size)

Specifies a new size for the virtual machine.

abstract Update withSize(String sizeName)

Specifies a new size for the virtual machine.

Method Details

withDataDiskDefaultCachingType

public abstract VirtualMachine.Update withDataDiskDefaultCachingType(CachingTypes cachingType)

Specifies the default caching type for the managed data disks.

Parameters:

cachingType - a caching type

Returns:

the next stage of the update

withDataDiskDefaultDeleteOptions

public abstract VirtualMachine.Update withDataDiskDefaultDeleteOptions(DeleteOptions deleteOptions)

Specifies the delete options for managed data disks.

Parameters:

deleteOptions - the delete options for managed data disks

Returns:

the next stage of the definition

withDataDiskDefaultDiskEncryptionSet

public abstract VirtualMachine.Update withDataDiskDefaultDiskEncryptionSet(String diskEncryptionSetId)

Specifies the disk encryption set for the managed data disk.

Parameters:

diskEncryptionSetId - the ID of disk encryption set.

Returns:

the next stage of the definition

withDataDiskDefaultStorageAccountType

public abstract VirtualMachine.Update withDataDiskDefaultStorageAccountType(StorageAccountTypes storageAccountType)

Specifies a storage account type.

Parameters:

storageAccountType - a storage account type

Returns:

the next stage of the update

withDataDiskDefaultWriteAcceleratorEnabled

public abstract VirtualMachine.Update withDataDiskDefaultWriteAcceleratorEnabled(boolean writeAcceleratorEnabled)

Specifies the write accelerator for managed data disks.

Parameters:

writeAcceleratorEnabled - whether to enable the write accelerator

Returns:

the next stage of the definition

withOSDiskCaching

public abstract VirtualMachine.Update withOSDiskCaching(CachingTypes cachingType)

Specifies the caching type for the OS disk.

Parameters:

cachingType - a caching type.

Returns:

the next stage of the update

withOSDiskEncryptionSettings

public abstract VirtualMachine.Update withOSDiskEncryptionSettings(DiskEncryptionSettings settings)

Specifies the encryption settings for the OS Disk.

Parameters:

settings - the encryption settings.

Returns:

the stage representing creatable VM update

withOSDiskSizeInGB

public abstract VirtualMachine.Update withOSDiskSizeInGB(int size)

Specifies the size of the OS disk in GB.

Only unmanaged disks may be resized as part of a VM update. Managed disks must be resized separately, using managed disk API.

Parameters:

size - a disk size.

Returns:

the next stage of the update

withOSDiskWriteAcceleratorEnabled

public abstract VirtualMachine.Update withOSDiskWriteAcceleratorEnabled(boolean writeAcceleratorEnabled)

Specifies the write accelerator for the OS disks.

Write Accelerator is generally available for M-series VMs in the Public Cloud. Enabling write accelerator for the operating system disk of the VM will reboot the VM. The Premium disk caching must be set to 'None' or 'Read Only'. All other caching modes are not supported.

Parameters:

writeAcceleratorEnabled - whether to enable the write accelerator

Returns:

the next stage of the update

withPriority

public abstract VirtualMachine.Update withPriority(VirtualMachinePriorityTypes priority)

Specifies a new priority for the virtual machine.

Parameters:

priority - a priority from the list of available priority types

Returns:

the next stage of the update

withSize

public abstract VirtualMachine.Update withSize(VirtualMachineSizeTypes size)

Specifies a new size for the virtual machine.

VirtualMachineSizeTypes is not the complete list of virtual machine sizes. See availableSizes() for resizing.

Parameters:

size - a size from the list of available sizes for the virtual machine

Returns:

the next stage of the definition

withSize

public abstract VirtualMachine.Update withSize(String sizeName)

Specifies a new size for the virtual machine.

See availableSizes() for resizing.

Parameters:

sizeName - the name of a size for the virtual machine as text

Returns:

the next stage of the update

Applies to