Share via

OSDisk Class

  • Reference

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 server.

Inheritance
azure.mgmt.compute._serialization.Model
OSDisk

Constructor

OSDisk(*, name: str, vhd: _models.VirtualHardDisk, create_option: str | _models.DiskCreateOptionTypes, os_type: str | _models.OperatingSystemTypes | None = None, encryption_settings: _models.DiskEncryptionSettings | None = None, image: _models.VirtualHardDisk | None = None, caching: str | _models.CachingTypes | None = None, disk_size_gb: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
os_type
str or OperatingSystemTypes

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. Known values are: "Windows" and "Linux".
encryption_settings
DiskEncryptionSettings

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

The disk name. Required.
vhd
VirtualHardDisk

The virtual hard disk. Required.
image
VirtualHardDisk

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

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. Known values are: "None", "ReadOnly", and "ReadWrite".
create_option
str or DiskCreateOptionTypes

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

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.

Variables

Name Description
os_type
str or OperatingSystemTypes

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. Known values are: "Windows" and "Linux".
encryption_settings
DiskEncryptionSettings

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

The disk name. Required.
vhd
VirtualHardDisk

The virtual hard disk. Required.
image
VirtualHardDisk

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

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. Known values are: "None", "ReadOnly", and "ReadWrite".
create_option
str or DiskCreateOptionTypes

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

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.