Share via


PSVirtualMachineDataDisk Class

Definition

public class PSVirtualMachineDataDisk : Microsoft.Azure.Management.Compute.Models.DataDisk
type PSVirtualMachineDataDisk = class
    inherit DataDisk
Public Class PSVirtualMachineDataDisk
Inherits DataDisk
Inheritance
PSVirtualMachineDataDisk

Constructors

PSVirtualMachineDataDisk()

Properties

Caching

Gets or sets specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

(Inherited from DataDisk)
CreateOption

Gets or sets 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. Possible values include: 'FromImage', 'Empty', 'Attach', 'Copy', 'Restore'

(Inherited from DataDisk)
DeleteOption

Gets or sets 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. Possible values include: 'Delete', 'Detach'

(Inherited from DataDisk)
DetachOption

Gets or sets 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 mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. Possible values include: 'ForceDetach'

(Inherited from DataDisk)
DiskIOPSReadWrite

Gets specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.

(Inherited from DataDisk)
DiskMBpsReadWrite

Gets specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.

(Inherited from DataDisk)
DiskSizeGB

Gets or sets 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.

(Inherited from DataDisk)
Image

Gets or sets 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.

(Inherited from DataDisk)
Lun

Gets or sets 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.

(Inherited from DataDisk)
ManagedDisk

Gets or sets the managed disk parameters.

(Inherited from DataDisk)
Name

Gets or sets the disk name.

(Inherited from DataDisk)
SourceResource

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

(Inherited from DataDisk)
ToBeDetached

Gets or sets specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

(Inherited from DataDisk)
Vhd

Gets or sets the virtual hard disk.

(Inherited from DataDisk)
WriteAcceleratorEnabled

Gets or sets specifies whether writeAccelerator should be enabled or disabled on the disk.

(Inherited from DataDisk)

Methods

Validate()

Validate the object.

(Inherited from DataDisk)

Applies to