DataDisk Class

Describes a data disk.

Constructor

DataDisk()

Variables

Name	Description
lun	int Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Required.
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.
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 data disk. 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. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. 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.
source_resource	<xref:<xref:"ApiEntityReference">> The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.
to_be_detached	bool Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.
disk_iops_read_write	int Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS.
disk_m_bps_read_write	int Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS.
detach_option	Union[str, <xref:"DiskDetachOptionTypes">] Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. "ForceDetach"
delete_option	Union[str, <xref:"DiskDeleteOptionTypes">] Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the data disk is deleted when VM is deleted. Detach. If this value is used, the data disk is retained after VM is deleted. The default value is set to Detach. 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 data disk. 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. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. Required. Known values are: "FromImage", "Empty", "Attach", "Copy", and "Restore".

createOption: Required[str | DiskCreateOptionTypes]

deleteOption

Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the data disk is deleted when VM is deleted. Detach. If this value is used, the data disk is retained after VM is deleted. The default value is set to Detach. Known values are: "Delete" and "Detach".

deleteOption: str | DiskDeleteOptionTypes

detachOption

Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. "ForceDetach"

detachOption: str | DiskDetachOptionTypes

diskIOPSReadWrite

Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS.

diskIOPSReadWrite: int

diskMBpsReadWrite

Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS.

diskMBpsReadWrite: int

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

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

lun

Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Required.

lun: Required[int]

managedDisk

The managed disk parameters.

managedDisk: ManagedDiskParameters

name

The disk name.

name: str

sourceResource

The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.

sourceResource: ApiEntityReference

storageFaultDomainAlignment

"Aligned" and "BestEffortAligned".

storageFaultDomainAlignment: str | StorageFaultDomainAlignmentType

toBeDetached

Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset.

toBeDetached: bool

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?