OSDisk (Azure SDK for Java Reference Documentation)

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

```
public final class OSDisk
extends Object
```
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/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

Constructor Summary

Constructors
Constructor and Description

OSDisk()

Constructors
Constructor and Description
`OSDisk()`

Method Summary

All Methods Instance Methods Concrete Methods
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 should be created.<br><br> Possible values are:<br><br> Attach – This value is used when you are using a specialized disk to create the virtual machine.<br><br> FromImage – This value is used when you are using an image to create the virtual machine.
`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.
`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.
`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 should be created.<br><br> Possible values are:<br><br> Attach – This value is used when you are using a specialized disk to create the virtual machine.<br><br> FromImage – This value is used when you are using an image to create the virtual machine.
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - OSDisk
```
public OSDisk()
```
- Method Detail
 - 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.
 - 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.
 - 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.
 - 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.
 - name
```
public String name()
```
 Get the name property: The disk name.
 
 Returns:
 
 the name value.
 - 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.
 - vhd
```
public VirtualHardDisk vhd()
```
 Get the vhd property: The virtual hard disk.
 
 Returns:
 
 the vhd value.
 - 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.
 - 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.
 - 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.
 - caching
```
public CachingTypes caching()
```
 Get the caching property: Specifies the caching requirements. Possible values are: **None** **ReadOnly** **ReadWrite** Default: **None** for Standard storage. **ReadOnly** for Premium storage.
 
 Returns:
 
 the caching value.
 - withCaching
```
public OSDisk withCaching(CachingTypes caching)
```
 Set the caching property: Specifies the caching requirements. Possible values are: **None** **ReadOnly** **ReadWrite** Default: **None** for Standard storage. **ReadOnly** for Premium storage.
 
 Parameters:
 
 caching - the caching 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.
 - 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.
 - 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.
 - 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.
 - createOption
```
public DiskCreateOptionTypes createOption()
```
 Get the createOption property: Specifies how the virtual machine 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 also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
 
 Returns:
 
 the createOption value.
 - withCreateOption
```
public OSDisk withCreateOption(DiskCreateOptionTypes createOption)
```
 Set the createOption property: Specifies how the virtual machine 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 also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
 
 Parameters:
 
 createOption - the createOption value to set.
 
 Returns:
 
 the OSDisk object itself.
 - 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. This value cannot be larger than 1023 GB.
 
 Returns:
 
 the diskSizeGB value.
 - 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. This value cannot be larger than 1023 GB.
 
 Parameters:
 
 diskSizeGB - the diskSizeGB value to set.
 
 Returns:
 
 the OSDisk object itself.
 - managedDisk
```
public ManagedDiskParameters managedDisk()
```
 Get the managedDisk property: The managed disk parameters.
 
 Returns:
 
 the managedDisk value.
 - 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.
 - validate
```
public void validate()
```
 Validates the instance.
 
 Throws:
 
 IllegalArgumentException - thrown if the instance is not valid.

Class OSDisk

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OSDisk

Method Detail

osType

withOsType

encryptionSettings

withEncryptionSettings

name

withName

vhd

withVhd

image

withImage

caching

withCaching

writeAcceleratorEnabled

withWriteAcceleratorEnabled

diffDiskSettings

withDiffDiskSettings

createOption

withCreateOption

diskSizeGB

withDiskSizeGB

managedDisk

withManagedDisk

validate