DataDisk Class

Package:

com.azure.resourcemanager.compute.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.45.0

• java.lang.Object
• • com.azure.resourcemanager.compute.models.DataDisk

Implements

JsonSerializable<DataDisk>

public final class DataDisk
implements JsonSerializable<DataDisk>

Describes a data disk.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
CachingTypes	caching() Get the caching property: Specifies the caching requirements.
DiskCreateOptionTypes	createOption() Get the createOption property: Specifies how the virtual machine disk should be created.
DiskDeleteOptionTypes	deleteOption() Get the deleteOption property: Specifies whether data disk should be deleted or detached upon VM deletion.
DiskDetachOptionTypes	detachOption() Get the detachOption property: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine.
Long	diskIopsReadWrite() Get the diskIopsReadWrite property: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS.
Long	diskMBpsReadWrite() Get the diskMBpsReadWrite property: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS.
Integer	diskSizeGB() Get the diskSizeGB property: Specifies the size of an empty data disk in gigabytes.
static DataDisk	fromJson(JsonReader jsonReader) Reads an instance of DataDisk from the JsonReader.
VirtualHardDisk	image() Get the image property: The source user image virtual hard disk.
int	lun() Get the lun property: Specifies the logical unit number of the data disk.
ManagedDiskParameters	managedDisk() Get the managedDisk property: The managed disk parameters.
String	name() Get the name property: The disk name.
ApiEntityReference	sourceResource() Get the sourceResource property: The source resource identifier.
Boolean	toBeDetached() Get the toBeDetached property: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
VirtualHardDisk	vhd() Get the vhd property: The virtual hard disk.
DataDisk	withCaching(CachingTypes caching) Set the caching property: Specifies the caching requirements.
DataDisk	withCreateOption(DiskCreateOptionTypes createOption) Set the createOption property: Specifies how the virtual machine disk should be created.
DataDisk	withDeleteOption(DiskDeleteOptionTypes deleteOption) Set the deleteOption property: Specifies whether data disk should be deleted or detached upon VM deletion.
DataDisk	withDetachOption(DiskDetachOptionTypes detachOption) Set the detachOption property: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine.
DataDisk	withDiskSizeGB(Integer diskSizeGB) Set the diskSizeGB property: Specifies the size of an empty data disk in gigabytes.
DataDisk	withImage(VirtualHardDisk image) Set the image property: The source user image virtual hard disk.
DataDisk	withLun(int lun) Set the lun property: Specifies the logical unit number of the data disk.
DataDisk	withManagedDisk(ManagedDiskParameters managedDisk) Set the managedDisk property: The managed disk parameters.
DataDisk	withName(String name) Set the name property: The disk name.
DataDisk	withSourceResource(ApiEntityReference sourceResource) Set the sourceResource property: The source resource identifier.
DataDisk	withToBeDetached(Boolean toBeDetached) Set the toBeDetached property: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.
DataDisk	withVhd(VirtualHardDisk vhd) Set the vhd property: The virtual hard disk.
DataDisk	withWriteAcceleratorEnabled(Boolean writeAcceleratorEnabled) Set the writeAcceleratorEnabled property: Specifies whether writeAccelerator should be enabled or disabled on the disk.
Boolean	writeAcceleratorEnabled() Get the writeAcceleratorEnabled property: Specifies whether writeAccelerator should be enabled or disabled on the disk.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataDisk

public DataDisk()

Creates an instance of DataDisk class.

Method Details

caching

public CachingTypes caching()

Get the caching property: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**.

Returns:

the caching value.

createOption

public DiskCreateOptionTypes createOption()

Get the createOption property: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point.

Returns:

the createOption value.

deleteOption

public DiskDeleteOptionTypes deleteOption()

Get the deleteOption property: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**.

Returns:

the deleteOption value.

detachOption

public DiskDetachOptionTypes detachOption()

Get the detachOption property: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. **This feature is still in preview**. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

Returns:

the detachOption value.

diskIopsReadWrite

public Long diskIopsReadWrite()

Get the diskIopsReadWrite property: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.

Returns:

the diskIopsReadWrite value.

diskMBpsReadWrite

public Long diskMBpsReadWrite()

Get the diskMBpsReadWrite property: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.

Returns:

the diskMBpsReadWrite value.

diskSizeGB

public Integer diskSizeGB()

Get the diskSizeGB property: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.

Returns:

the diskSizeGB value.

fromJson

public static DataDisk fromJson(JsonReader jsonReader)

Reads an instance of DataDisk from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DataDisk if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

image

public VirtualHardDisk image()

Get the image property: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

Returns:

the image value.

lun

public int lun()

Get the lun property: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

Returns:

the lun value.

managedDisk

public ManagedDiskParameters managedDisk()

Get the managedDisk property: The managed disk parameters.

Returns:

the managedDisk value.

name

public String name()

Get the name property: The disk name.

Returns:

the name value.

sourceResource

public ApiEntityReference sourceResource()

Get the sourceResource property: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.

Returns:

the sourceResource value.

toBeDetached

public Boolean toBeDetached()

Get the toBeDetached property: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.

Returns:

the toBeDetached value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

vhd

public VirtualHardDisk vhd()

Get the vhd property: The virtual hard disk.

Returns:

the vhd value.

withCaching

public DataDisk withCaching(CachingTypes caching)

Set the caching property: Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.**.

Parameters:

caching - the caching value to set.

Returns:

the DataDisk object itself.

withCreateOption

public DataDisk withCreateOption(DiskCreateOptionTypes createOption)

Set the createOption property: Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point.

Parameters:

createOption - the createOption value to set.

Returns:

the DataDisk object itself.

withDeleteOption

public DataDisk withDeleteOption(DiskDeleteOptionTypes deleteOption)

Set the deleteOption property: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**.

Parameters:

deleteOption - the deleteOption value to set.

Returns:

the DataDisk object itself.

withDetachOption

public DataDisk withDetachOption(DiskDetachOptionTypes detachOption)

Set the detachOption property: Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. **This feature is still in preview**. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

Parameters:

detachOption - the detachOption value to set.

Returns:

the DataDisk object itself.

withDiskSizeGB

public DataDisk withDiskSizeGB(Integer diskSizeGB)

Set the diskSizeGB property: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.

Parameters:

diskSizeGB - the diskSizeGB value to set.

Returns:

the DataDisk object itself.

withImage

public DataDisk withImage(VirtualHardDisk image)

Set the image property: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

Parameters:

image - the image value to set.

Returns:

the DataDisk object itself.

withLun

public DataDisk withLun(int lun)

Set the lun property: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

Parameters:

lun - the lun value to set.

Returns:

the DataDisk object itself.

withManagedDisk

public DataDisk withManagedDisk(ManagedDiskParameters managedDisk)

Set the managedDisk property: The managed disk parameters.

Parameters:

managedDisk - the managedDisk value to set.

Returns:

the DataDisk object itself.

withName

public DataDisk withName(String name)

Set the name property: The disk name.

Parameters:

name - the name value to set.

Returns:

the DataDisk object itself.

withSourceResource

public DataDisk withSourceResource(ApiEntityReference sourceResource)

Set the sourceResource property: The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.

Parameters:

sourceResource - the sourceResource value to set.

Returns:

the DataDisk object itself.

withToBeDetached

public DataDisk withToBeDetached(Boolean toBeDetached)

Set the toBeDetached property: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.

Parameters:

toBeDetached - the toBeDetached value to set.

Returns:

the DataDisk object itself.

withVhd

public DataDisk withVhd(VirtualHardDisk vhd)

Set the vhd property: The virtual hard disk.

Parameters:

vhd - the vhd value to set.

Returns:

the DataDisk object itself.

withWriteAcceleratorEnabled

public DataDisk withWriteAcceleratorEnabled(Boolean writeAcceleratorEnabled)

Set the writeAcceleratorEnabled property: Specifies whether writeAccelerator should be enabled or disabled on the disk.

Parameters:

writeAcceleratorEnabled - the writeAcceleratorEnabled value to set.

Returns:

the DataDisk object itself.

writeAcceleratorEnabled

public Boolean writeAcceleratorEnabled()

Get the writeAcceleratorEnabled property: Specifies whether writeAccelerator should be enabled or disabled on the disk.

Returns:

the writeAcceleratorEnabled value.