OSDisk Class

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.

Constructor

OSDisk()

Variables

Name	Description
os_type	Union[str, <xref:"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	<xref:<xref:"DiskEncryptionSettings">> Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.
name	str The disk name.
vhd	<xref:<xref:"VirtualHardDisk">> The virtual hard disk.
image	<xref:<xref:"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	Union[str, <xref:"CachingTypes">] Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: 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	<xref:<xref:"DiffDiskSettings">> Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
create_option	Union[str, <xref:"DiskCreateOptionTypes">] 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. Required. Known values are: "FromImage", "Empty", "Attach", "Copy", and "Restore".
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. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.
storage_fault_domain_alignment	Union[str, <xref:"StorageFaultDomainAlignmentType">] Specifies the storage fault domain alignment type for the disk. Known values are: "Aligned" and "BestEffortAligned".
managed_disk	<xref:<xref:"ManagedDiskParameters">> The managed disk parameters.
delete_option	Union[str, <xref:"DiskDeleteOptionTypes">] 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. Known values are: "Delete" and "Detach".

Attributes

caching

None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.. Known values are: "None", "ReadOnly", and "ReadWrite".

caching: str | CachingTypes

createOption

** 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. Required. Known values are: "FromImage", "Empty", "Attach", "Copy", and "Restore".

createOption: Required[str | DiskCreateOptionTypes]

deleteOption

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. Known values are: "Delete" and "Detach".

deleteOption: str | DiskDeleteOptionTypes

diffDiskSettings

Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

diffDiskSettings: DiffDiskSettings

diskSizeGB

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.

diskSizeGB: int

encryptionSettings

2015-06-15.

encryptionSettings: DiskEncryptionSettings

image

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.

image: VirtualHardDisk

managedDisk

The managed disk parameters.

managedDisk: ManagedDiskParameters

name

The disk name.

name: str

osType

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

osType: str | OperatingSystemTypes

storageFaultDomainAlignment

"Aligned" and "BestEffortAligned".

storageFaultDomainAlignment: str | StorageFaultDomainAlignmentType

vhd

The virtual hard disk.

vhd: VirtualHardDisk

writeAcceleratorEnabled

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

writeAcceleratorEnabled: bool

Feedback

Was this page helpful?