ArmComputeModelFactory.VirtualMachineDataDisk Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute.Models
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.6.0
Package:
Azure.ResourceManager.Compute v1.7.0-beta.1
Source:
ArmComputeModelFactory.cs
Source:
ArmComputeModelFactory.cs

Initializes a new instance of VirtualMachineDataDisk.

public static Azure.ResourceManager.Compute.Models.VirtualMachineDataDisk VirtualMachineDataDisk (int lun = 0, string name = default, Uri vhdUri = default, Uri imageUri = default, Azure.ResourceManager.Compute.Models.CachingType? caching = default, bool? writeAcceleratorEnabled = default, Azure.ResourceManager.Compute.Models.DiskCreateOptionType createOption = default, int? diskSizeGB = default, Azure.ResourceManager.Compute.Models.VirtualMachineManagedDisk managedDisk = default, Azure.Core.ResourceIdentifier sourceResourceId = default, bool? toBeDetached = default, long? diskIopsReadWrite = default, long? diskMBpsReadWrite = default, Azure.ResourceManager.Compute.Models.DiskDetachOptionType? detachOption = default, Azure.ResourceManager.Compute.Models.DiskDeleteOptionType? deleteOption = default);
static member VirtualMachineDataDisk : int * string * Uri * Uri * Nullable<Azure.ResourceManager.Compute.Models.CachingType> * Nullable<bool> * Azure.ResourceManager.Compute.Models.DiskCreateOptionType * Nullable<int> * Azure.ResourceManager.Compute.Models.VirtualMachineManagedDisk * Azure.Core.ResourceIdentifier * Nullable<bool> * Nullable<int64> * Nullable<int64> * Nullable<Azure.ResourceManager.Compute.Models.DiskDetachOptionType> * Nullable<Azure.ResourceManager.Compute.Models.DiskDeleteOptionType> -> Azure.ResourceManager.Compute.Models.VirtualMachineDataDisk
Public Shared Function VirtualMachineDataDisk (Optional lun As Integer = 0, Optional name As String = Nothing, Optional vhdUri As Uri = Nothing, Optional imageUri As Uri = Nothing, Optional caching As Nullable(Of CachingType) = Nothing, Optional writeAcceleratorEnabled As Nullable(Of Boolean) = Nothing, Optional createOption As DiskCreateOptionType = Nothing, Optional diskSizeGB As Nullable(Of Integer) = Nothing, Optional managedDisk As VirtualMachineManagedDisk = Nothing, Optional sourceResourceId As ResourceIdentifier = Nothing, Optional toBeDetached As Nullable(Of Boolean) = Nothing, Optional diskIopsReadWrite As Nullable(Of Long) = Nothing, Optional diskMBpsReadWrite As Nullable(Of Long) = Nothing, Optional detachOption As Nullable(Of DiskDetachOptionType) = Nothing, Optional deleteOption As Nullable(Of DiskDeleteOptionType) = Nothing) As VirtualMachineDataDisk

Parameters

lun
Int32

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.

name
String

The disk name.

vhdUri
Uri

The virtual hard disk.

imageUri
Uri

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
Nullable<CachingType>

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage..

writeAcceleratorEnabled
Nullable<Boolean>

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

createOption
DiskCreateOptionType

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.

diskSizeGB
Nullable<Int32>

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.

managedDisk
VirtualMachineManagedDisk

The managed disk parameters.

sourceResourceId
ResourceIdentifier

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

toBeDetached
Nullable<Boolean>

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

diskIopsReadWrite
Nullable<Int64>

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.

diskMBpsReadWrite
Nullable<Int64>

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.

detachOption
Nullable<DiskDetachOptionType>

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

deleteOption
Nullable<DiskDeleteOptionType>

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.

Returns

VirtualMachineDataDisk

A new VirtualMachineDataDisk instance for mocking.

Applies to