OSDisk Class

Specifies information about the operating system disk used by the virtual machine. <br>``<br> For more information about disks, see About disks and VHDs for Azure virtual machines.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

OSDisk

Constructor

OSDisk(*, create_option: Union[str, azure.mgmt.compute.v2018_04_01.models._compute_management_client_enums.DiskCreateOptionTypes], os_type: Optional[Union[str, azure.mgmt.compute.v2018_04_01.models._compute_management_client_enums.OperatingSystemTypes]] = None, encryption_settings: Optional[azure.mgmt.compute.v2018_04_01.models._models_py3.DiskEncryptionSettings] = None, name: Optional[str] = None, vhd: Optional[azure.mgmt.compute.v2018_04_01.models._models_py3.VirtualHardDisk] = None, image: Optional[azure.mgmt.compute.v2018_04_01.models._models_py3.VirtualHardDisk] = None, caching: Optional[Union[str, azure.mgmt.compute.v2018_04_01.models._compute_management_client_enums.CachingTypes]] = None, write_accelerator_enabled: Optional[bool] = None, disk_size_gb: Optional[int] = None, managed_disk: Optional[azure.mgmt.compute.v2018_04_01.models._models_py3.ManagedDiskParameters] = None, **kwargs)

Parameters

os_type

str or OperatingSystemTypes

Required

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. <br>``<br> Possible values are: <br>``<br> Windows <br>``<br> Linux. Possible values include: "Windows", "Linux".

encryption_settings

DiskEncryptionSettings

Required

Specifies the encryption settings for the OS Disk. <br>``<br> Minimum api-version: 2015-06-15.

name

str

Required

The disk name.

vhd

VirtualHardDisk

Required

The virtual hard disk.

image

VirtualHardDisk

Required

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.

caching

str or CachingTypes

Required

Specifies the caching requirements. <br>``<br> Possible values are: <br>``<br> None <br>``<br> ReadOnly <br>``<br> ReadWrite <br>``<br> Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: "None", "ReadOnly", "ReadWrite".

write_accelerator_enabled

bool

Required

Specifies whether writeAccelerator should be enabled or disabled on the disk.

create_option

str or DiskCreateOptionTypes

Required

Required. Specifies how the virtual machine should be created.:code:
<br> Possible values are:<br>``<br> Attach – This value is used when you are using a specialized disk to create the virtual machine.:code:
<br> 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. Possible values include: "FromImage", "Empty", "Attach".

disk_size_gb

int

Required

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. <br>``<br> This value cannot be larger than 1023 GB.

managed_disk

ManagedDiskParameters

Required

The managed disk parameters.