OSDisk Class

Reference

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.

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

Inheritance: azure.mgmt.compute._serialization.Model

OSDisk

Constructor

OSDisk(*, create_option: str | _models.DiskCreateOptionTypes, os_type: str | _models.OperatingSystemTypes | None = None, encryption_settings: _models.DiskEncryptionSettings | None = None, name: str | None = None, vhd: _models.VirtualHardDisk | None = None, image: _models.VirtualHardDisk | None = None, caching: str | _models.CachingTypes | None = None, write_accelerator_enabled: bool | None = None, diff_disk_settings: _models.DiffDiskSettings | None = None, disk_size_gb: int | None = None, managed_disk: _models.ManagedDiskParameters | None = None, delete_option: str | _models.DiskDeleteOptionTypes | 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. Possible values are: Windows Linux. Known values are: "Windows" and "Linux".
encryption_settings	DiskEncryptionSettings Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.
name	str The disk name.
vhd	VirtualHardDisk The virtual hard disk.
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. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage. Known values are: "None", "ReadOnly", and "ReadWrite".
write_accelerator_enabled	bool Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings	DiffDiskSettings Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
create_option	str or DiskCreateOptionTypes Specifies how the virtual machine should be created. Possible values are: Attach u2013 This value is used when you are using a specialized disk to create the virtual machine. 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. diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk	ManagedDiskParameters The managed disk parameters.
delete_option	str or DiskDeleteOptionTypes Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: 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. User cannot change the delete option for ephemeral OS Disk. Known values are: "Delete" and "Detach".

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. Possible values are: Windows Linux. Known values are: "Windows" and "Linux".
encryption_settings	DiskEncryptionSettings Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.
name	str The disk name.
vhd	VirtualHardDisk The virtual hard disk.
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. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage. Known values are: "None", "ReadOnly", and "ReadWrite".
write_accelerator_enabled	bool Specifies whether writeAccelerator should be enabled or disabled on the disk.
diff_disk_settings	DiffDiskSettings Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
create_option	str or DiskCreateOptionTypes Specifies how the virtual machine should be created. Possible values are: Attach u2013 This value is used when you are using a specialized disk to create the virtual machine. 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. diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
managed_disk	ManagedDiskParameters The managed disk parameters.
delete_option	str or DiskDeleteOptionTypes Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: 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. User cannot change the delete option for ephemeral OS Disk. Known values are: "Delete" and "Detach".

Share via

OSDisk Class

Constructor

Keyword-Only Parameters

Variables

Additional resources