OSDisk Class

Package:

com.azure.resourcemanager.compute.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.44.0

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

Implements

JsonSerializable<OSDisk>

public final class OSDisk
implements JsonSerializable<OSDisk>

Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).

Constructor Summary

Constructor	Description
OSDisk()	Creates an instance of OSDisk 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 OS Disk should be deleted or detached upon VM deletion.
DiffDiskSettings	diffDiskSettings() Get the diffDiskSettings property: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
Integer	diskSizeGB() Get the diskSizeGB property: Specifies the size of an empty data disk in gigabytes.
DiskEncryptionSettings	encryptionSettings() Get the encryptionSettings property: Specifies the encryption settings for the OS Disk.
static OSDisk	fromJson(JsonReader jsonReader) Reads an instance of OSDisk from the JsonReader.
VirtualHardDisk	image() Get the image property: The source user image virtual hard disk.
ManagedDiskParameters	managedDisk() Get the managedDisk property: The managed disk parameters.
String	name() Get the name property: The disk name.
OperatingSystemTypes	osType() Get the osType property: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
VirtualHardDisk	vhd() Get the vhd property: The virtual hard disk.
OSDisk	withCaching(CachingTypes caching) Set the caching property: Specifies the caching requirements.
OSDisk	withCreateOption(DiskCreateOptionTypes createOption) Set the createOption property: Specifies how the virtual machine disk should be created.
OSDisk	withDeleteOption(DiskDeleteOptionTypes deleteOption) Set the deleteOption property: Specifies whether OS Disk should be deleted or detached upon VM deletion.
OSDisk	withDiffDiskSettings(DiffDiskSettings diffDiskSettings) Set the diffDiskSettings property: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
OSDisk	withDiskSizeGB(Integer diskSizeGB) Set the diskSizeGB property: Specifies the size of an empty data disk in gigabytes.
OSDisk	withEncryptionSettings(DiskEncryptionSettings encryptionSettings) Set the encryptionSettings property: Specifies the encryption settings for the OS Disk.
OSDisk	withImage(VirtualHardDisk image) Set the image property: The source user image virtual hard disk.
OSDisk	withManagedDisk(ManagedDiskParameters managedDisk) Set the managedDisk property: The managed disk parameters.
OSDisk	withName(String name) Set the name property: The disk name.
OSDisk	withOsType(OperatingSystemTypes osType) Set the osType property: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.
OSDisk	withVhd(VirtualHardDisk vhd) Set the vhd property: The virtual hard disk.
OSDisk	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

OSDisk

public OSDisk()

Creates an instance of OSDisk 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. 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.

Returns:

the createOption value.

deleteOption

public DiskDeleteOptionTypes deleteOption()

Get the deleteOption property: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk.

Returns:

the deleteOption value.

diffDiskSettings

public DiffDiskSettings diffDiskSettings()

Get the diffDiskSettings property: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

Returns:

the diffDiskSettings 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.

encryptionSettings

public DiskEncryptionSettings encryptionSettings()

Get the encryptionSettings property: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.

Returns:

the encryptionSettings value.

fromJson

public static OSDisk fromJson(JsonReader jsonReader)

Reads an instance of OSDisk from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OSDisk 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.

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.

osType

public OperatingSystemTypes osType()

Get the osType property: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.**.

Returns:

the osType 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 OSDisk 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 OSDisk object itself.

withCreateOption

public OSDisk 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. 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.

Parameters:

createOption - the createOption value to set.

Returns:

the OSDisk object itself.

withDeleteOption

public OSDisk withDeleteOption(DiskDeleteOptionTypes deleteOption)

Set the deleteOption property: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk.

Parameters:

deleteOption - the deleteOption value to set.

Returns:

the OSDisk object itself.

withDiffDiskSettings

public OSDisk withDiffDiskSettings(DiffDiskSettings diffDiskSettings)

Set the diffDiskSettings property: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

Parameters:

diffDiskSettings - the diffDiskSettings value to set.

Returns:

the OSDisk object itself.

withDiskSizeGB

public OSDisk 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 OSDisk object itself.

withEncryptionSettings

public OSDisk withEncryptionSettings(DiskEncryptionSettings encryptionSettings)

Set the encryptionSettings property: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.

Parameters:

encryptionSettings - the encryptionSettings value to set.

Returns:

the OSDisk object itself.

withImage

public OSDisk 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 OSDisk object itself.

withManagedDisk

public OSDisk withManagedDisk(ManagedDiskParameters managedDisk)

Set the managedDisk property: The managed disk parameters.

Parameters:

managedDisk - the managedDisk value to set.

Returns:

the OSDisk object itself.

withName

public OSDisk withName(String name)

Set the name property: The disk name.

Parameters:

name - the name value to set.

Returns:

the OSDisk object itself.

withOsType

public OSDisk withOsType(OperatingSystemTypes osType)

Set the osType property: This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.**.

Parameters:

osType - the osType value to set.

Returns:

the OSDisk object itself.

withVhd

public OSDisk withVhd(VirtualHardDisk vhd)

Set the vhd property: The virtual hard disk.

Parameters:

vhd - the vhd value to set.

Returns:

the OSDisk object itself.

withWriteAcceleratorEnabled

public OSDisk 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 OSDisk 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.