Disk Constructors

Definition

Overloads

Disk()

Initializes a new instance of the Disk class.

Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile)

Initializes a new instance of the Disk class.

Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile, Nullable<Double>, String, String, Nullable<Boolean>)
Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, Nullable<DateTime>, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile, Nullable<Double>, String, String, Nullable<Boolean>)

Initializes a new instance of the Disk class.

Disk()

Initializes a new instance of the Disk class.

public Disk ();
Public Sub New ()

Applies to

Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile)

Initializes a new instance of the Disk class.

public Disk (string location, Microsoft.Azure.Management.Compute.Models.CreationData creationData, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, string managedBy, System.Collections.Generic.IList<string> managedByExtended, Microsoft.Azure.Management.Compute.Models.DiskSku sku, System.Collections.Generic.IList<string> zones, Microsoft.Azure.Management.Compute.Models.ExtendedLocation extendedLocation, DateTime? timeCreated, Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes? osType, string hyperVGeneration, Microsoft.Azure.Management.Compute.Models.PurchasePlan purchasePlan, int? diskSizeGB, long? diskSizeBytes = default, string uniqueId = default, Microsoft.Azure.Management.Compute.Models.EncryptionSettingsCollection encryptionSettingsCollection = default, string provisioningState = default, long? diskIOPSReadWrite = default, long? diskMBpsReadWrite = default, long? diskIOPSReadOnly = default, long? diskMBpsReadOnly = default, string diskState = default, Microsoft.Azure.Management.Compute.Models.Encryption encryption = default, int? maxShares = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.ShareInfoElement> shareInfo = default, string networkAccessPolicy = default, string diskAccessId = default, string tier = default, bool? burstingEnabled = default, Microsoft.Azure.Management.Compute.Models.PropertyUpdatesInProgress propertyUpdatesInProgress = default, bool? supportsHibernation = default, Microsoft.Azure.Management.Compute.Models.DiskSecurityProfile securityProfile = default);
new Microsoft.Azure.Management.Compute.Models.Disk : string * Microsoft.Azure.Management.Compute.Models.CreationData * string * string * string * System.Collections.Generic.IDictionary<string, string> * string * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.DiskSku * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.ExtendedLocation * Nullable<DateTime> * Nullable<Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes> * string * Microsoft.Azure.Management.Compute.Models.PurchasePlan * Nullable<int> * Nullable<int64> * string * Microsoft.Azure.Management.Compute.Models.EncryptionSettingsCollection * string * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * string * Microsoft.Azure.Management.Compute.Models.Encryption * Nullable<int> * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.ShareInfoElement> * string * string * string * Nullable<bool> * Microsoft.Azure.Management.Compute.Models.PropertyUpdatesInProgress * Nullable<bool> * Microsoft.Azure.Management.Compute.Models.DiskSecurityProfile -> Microsoft.Azure.Management.Compute.Models.Disk
Public Sub New (location As String, creationData As CreationData, id As String, name As String, type As String, tags As IDictionary(Of String, String), managedBy As String, managedByExtended As IList(Of String), sku As DiskSku, zones As IList(Of String), extendedLocation As ExtendedLocation, timeCreated As Nullable(Of DateTime), osType As Nullable(Of OperatingSystemTypes), hyperVGeneration As String, purchasePlan As PurchasePlan, diskSizeGB As Nullable(Of Integer), Optional diskSizeBytes As Nullable(Of Long) = Nothing, Optional uniqueId As String = Nothing, Optional encryptionSettingsCollection As EncryptionSettingsCollection = Nothing, Optional provisioningState As String = Nothing, Optional diskIOPSReadWrite As Nullable(Of Long) = Nothing, Optional diskMBpsReadWrite As Nullable(Of Long) = Nothing, Optional diskIOPSReadOnly As Nullable(Of Long) = Nothing, Optional diskMBpsReadOnly As Nullable(Of Long) = Nothing, Optional diskState As String = Nothing, Optional encryption As Encryption = Nothing, Optional maxShares As Nullable(Of Integer) = Nothing, Optional shareInfo As IList(Of ShareInfoElement) = Nothing, Optional networkAccessPolicy As String = Nothing, Optional diskAccessId As String = Nothing, Optional tier As String = Nothing, Optional burstingEnabled As Nullable(Of Boolean) = Nothing, Optional propertyUpdatesInProgress As PropertyUpdatesInProgress = Nothing, Optional supportsHibernation As Nullable(Of Boolean) = Nothing, Optional securityProfile As DiskSecurityProfile = Nothing)

Parameters

location
String

Resource location

creationData
CreationData

Disk source information. CreationData information cannot be changed after the disk has been created.

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

managedBy
String

A relative URI containing the ID of the VM that has the disk attached.

managedByExtended
IList<String>

List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.

sku
DiskSku
zones
IList<String>

The Logical zone list for Disk.

extendedLocation
ExtendedLocation

The extended location where the disk will be created. Extended location cannot be changed.

timeCreated
Nullable<DateTime>

The time when the disk was created.

osType
Nullable<OperatingSystemTypes>

The Operating System type. Possible values include: 'Windows', 'Linux'

hyperVGeneration
String

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', 'V2'

purchasePlan
PurchasePlan

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

diskSizeGB
Nullable<Int32>

If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

diskSizeBytes
Nullable<Int64>

The size of the disk in bytes. This field is read only.

uniqueId
String

Unique Guid identifying the resource.

encryptionSettingsCollection
EncryptionSettingsCollection

Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

provisioningState
String

The disk provisioning state.

diskIOPSReadWrite
Nullable<Int64>

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

diskMBpsReadWrite
Nullable<Int64>

The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

diskIOPSReadOnly
Nullable<Int64>

The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.

diskMBpsReadOnly
Nullable<Int64>

The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

diskState
String

The state of the disk. Possible values include: 'Unattached', 'Attached', 'Reserved', 'Frozen', 'ActiveSAS', 'ActiveSASFrozen', 'ReadyToUpload', 'ActiveUpload'

encryption
Encryption

Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

maxShares
Nullable<Int32>

The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.

shareInfo
IList<ShareInfoElement>

Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.

networkAccessPolicy
String

Possible values include: 'AllowAll', 'AllowPrivate', 'DenyAll'

diskAccessId
String

ARM id of the DiskAccess resource for using private endpoints on disks.

tier
String

Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.

burstingEnabled
Nullable<Boolean>

Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.

propertyUpdatesInProgress
PropertyUpdatesInProgress

Properties of the disk for which update is pending.

supportsHibernation
Nullable<Boolean>

Indicates the OS on a disk supports hibernation.

securityProfile
DiskSecurityProfile

Contains the security related information for the resource.

Applies to

Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile, Nullable<Double>, String, String, Nullable<Boolean>)

public Disk (string location, Microsoft.Azure.Management.Compute.Models.CreationData creationData, string id, string name, string type, System.Collections.Generic.IDictionary<string,string> tags, string managedBy, System.Collections.Generic.IList<string> managedByExtended, Microsoft.Azure.Management.Compute.Models.DiskSku sku, System.Collections.Generic.IList<string> zones, Microsoft.Azure.Management.Compute.Models.ExtendedLocation extendedLocation, DateTime? timeCreated, Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes? osType, string hyperVGeneration, Microsoft.Azure.Management.Compute.Models.PurchasePlan purchasePlan, Microsoft.Azure.Management.Compute.Models.SupportedCapabilities supportedCapabilities, int? diskSizeGB, long? diskSizeBytes, string uniqueId, Microsoft.Azure.Management.Compute.Models.EncryptionSettingsCollection encryptionSettingsCollection, string provisioningState, long? diskIOPSReadWrite, long? diskMBpsReadWrite, long? diskIOPSReadOnly, long? diskMBpsReadOnly, string diskState, Microsoft.Azure.Management.Compute.Models.Encryption encryption, int? maxShares, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.ShareInfoElement> shareInfo, string networkAccessPolicy, string diskAccessId, string tier, bool? burstingEnabled = default, Microsoft.Azure.Management.Compute.Models.PropertyUpdatesInProgress propertyUpdatesInProgress = default, bool? supportsHibernation = default, Microsoft.Azure.Management.Compute.Models.DiskSecurityProfile securityProfile = default, double? completionPercent = default, string publicNetworkAccess = default, string dataAccessAuthMode = default, bool? optimizedForFrequentAttach = default);
new Microsoft.Azure.Management.Compute.Models.Disk : string * Microsoft.Azure.Management.Compute.Models.CreationData * string * string * string * System.Collections.Generic.IDictionary<string, string> * string * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.DiskSku * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.ExtendedLocation * Nullable<DateTime> * Nullable<Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes> * string * Microsoft.Azure.Management.Compute.Models.PurchasePlan * Microsoft.Azure.Management.Compute.Models.SupportedCapabilities * Nullable<int> * Nullable<int64> * string * Microsoft.Azure.Management.Compute.Models.EncryptionSettingsCollection * string * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * string * Microsoft.Azure.Management.Compute.Models.Encryption * Nullable<int> * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.ShareInfoElement> * string * string * string * Nullable<bool> * Microsoft.Azure.Management.Compute.Models.PropertyUpdatesInProgress * Nullable<bool> * Microsoft.Azure.Management.Compute.Models.DiskSecurityProfile * Nullable<double> * string * string * Nullable<bool> -> Microsoft.Azure.Management.Compute.Models.Disk
Public Sub New (location As String, creationData As CreationData, id As String, name As String, type As String, tags As IDictionary(Of String, String), managedBy As String, managedByExtended As IList(Of String), sku As DiskSku, zones As IList(Of String), extendedLocation As ExtendedLocation, timeCreated As Nullable(Of DateTime), osType As Nullable(Of OperatingSystemTypes), hyperVGeneration As String, purchasePlan As PurchasePlan, supportedCapabilities As SupportedCapabilities, diskSizeGB As Nullable(Of Integer), diskSizeBytes As Nullable(Of Long), uniqueId As String, encryptionSettingsCollection As EncryptionSettingsCollection, provisioningState As String, diskIOPSReadWrite As Nullable(Of Long), diskMBpsReadWrite As Nullable(Of Long), diskIOPSReadOnly As Nullable(Of Long), diskMBpsReadOnly As Nullable(Of Long), diskState As String, encryption As Encryption, maxShares As Nullable(Of Integer), shareInfo As IList(Of ShareInfoElement), networkAccessPolicy As String, diskAccessId As String, tier As String, Optional burstingEnabled As Nullable(Of Boolean) = Nothing, Optional propertyUpdatesInProgress As PropertyUpdatesInProgress = Nothing, Optional supportsHibernation As Nullable(Of Boolean) = Nothing, Optional securityProfile As DiskSecurityProfile = Nothing, Optional completionPercent As Nullable(Of Double) = Nothing, Optional publicNetworkAccess As String = Nothing, Optional dataAccessAuthMode As String = Nothing, Optional optimizedForFrequentAttach As Nullable(Of Boolean) = Nothing)

Parameters

location
String
creationData
CreationData
id
String
name
String
type
String
managedBy
String
managedByExtended
IList<String>
sku
DiskSku
zones
IList<String>
extendedLocation
ExtendedLocation
timeCreated
Nullable<DateTime>
hyperVGeneration
String
purchasePlan
PurchasePlan
supportedCapabilities
SupportedCapabilities
diskSizeGB
Nullable<Int32>
diskSizeBytes
Nullable<Int64>
uniqueId
String
encryptionSettingsCollection
EncryptionSettingsCollection
provisioningState
String
diskIOPSReadWrite
Nullable<Int64>
diskMBpsReadWrite
Nullable<Int64>
diskIOPSReadOnly
Nullable<Int64>
diskMBpsReadOnly
Nullable<Int64>
diskState
String
encryption
Encryption
maxShares
Nullable<Int32>
shareInfo
IList<ShareInfoElement>
networkAccessPolicy
String
diskAccessId
String
tier
String
burstingEnabled
Nullable<Boolean>
propertyUpdatesInProgress
PropertyUpdatesInProgress
supportsHibernation
Nullable<Boolean>
securityProfile
DiskSecurityProfile
completionPercent
Nullable<Double>
publicNetworkAccess
String
dataAccessAuthMode
String
optimizedForFrequentAttach
Nullable<Boolean>

Applies to

Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, Nullable<DateTime>, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile, Nullable<Double>, String, String, Nullable<Boolean>)

Initializes a new instance of the Disk class.

public Disk (string location, Microsoft.Azure.Management.Compute.Models.CreationData creationData, string id = default, string name = default, string type = default, System.Collections.Generic.IDictionary<string,string> tags = default, string managedBy = default, System.Collections.Generic.IList<string> managedByExtended = default, Microsoft.Azure.Management.Compute.Models.DiskSku sku = default, System.Collections.Generic.IList<string> zones = default, Microsoft.Azure.Management.Compute.Models.ExtendedLocation extendedLocation = default, DateTime? timeCreated = default, Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes? osType = default, string hyperVGeneration = default, Microsoft.Azure.Management.Compute.Models.PurchasePlan purchasePlan = default, Microsoft.Azure.Management.Compute.Models.SupportedCapabilities supportedCapabilities = default, int? diskSizeGB = default, long? diskSizeBytes = default, string uniqueId = default, Microsoft.Azure.Management.Compute.Models.EncryptionSettingsCollection encryptionSettingsCollection = default, string provisioningState = default, long? diskIOPSReadWrite = default, long? diskMBpsReadWrite = default, long? diskIOPSReadOnly = default, long? diskMBpsReadOnly = default, string diskState = default, Microsoft.Azure.Management.Compute.Models.Encryption encryption = default, int? maxShares = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.ShareInfoElement> shareInfo = default, string networkAccessPolicy = default, string diskAccessId = default, DateTime? burstingEnabledTime = default, string tier = default, bool? burstingEnabled = default, Microsoft.Azure.Management.Compute.Models.PropertyUpdatesInProgress propertyUpdatesInProgress = default, bool? supportsHibernation = default, Microsoft.Azure.Management.Compute.Models.DiskSecurityProfile securityProfile = default, double? completionPercent = default, string publicNetworkAccess = default, string dataAccessAuthMode = default, bool? optimizedForFrequentAttach = default);
new Microsoft.Azure.Management.Compute.Models.Disk : string * Microsoft.Azure.Management.Compute.Models.CreationData * string * string * string * System.Collections.Generic.IDictionary<string, string> * string * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.DiskSku * System.Collections.Generic.IList<string> * Microsoft.Azure.Management.Compute.Models.ExtendedLocation * Nullable<DateTime> * Nullable<Microsoft.Azure.Management.Compute.Models.OperatingSystemTypes> * string * Microsoft.Azure.Management.Compute.Models.PurchasePlan * Microsoft.Azure.Management.Compute.Models.SupportedCapabilities * Nullable<int> * Nullable<int64> * string * Microsoft.Azure.Management.Compute.Models.EncryptionSettingsCollection * string * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * string * Microsoft.Azure.Management.Compute.Models.Encryption * Nullable<int> * System.Collections.Generic.IList<Microsoft.Azure.Management.Compute.Models.ShareInfoElement> * string * string * Nullable<DateTime> * string * Nullable<bool> * Microsoft.Azure.Management.Compute.Models.PropertyUpdatesInProgress * Nullable<bool> * Microsoft.Azure.Management.Compute.Models.DiskSecurityProfile * Nullable<double> * string * string * Nullable<bool> -> Microsoft.Azure.Management.Compute.Models.Disk
Public Sub New (location As String, creationData As CreationData, Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional managedBy As String = Nothing, Optional managedByExtended As IList(Of String) = Nothing, Optional sku As DiskSku = Nothing, Optional zones As IList(Of String) = Nothing, Optional extendedLocation As ExtendedLocation = Nothing, Optional timeCreated As Nullable(Of DateTime) = Nothing, Optional osType As Nullable(Of OperatingSystemTypes) = Nothing, Optional hyperVGeneration As String = Nothing, Optional purchasePlan As PurchasePlan = Nothing, Optional supportedCapabilities As SupportedCapabilities = Nothing, Optional diskSizeGB As Nullable(Of Integer) = Nothing, Optional diskSizeBytes As Nullable(Of Long) = Nothing, Optional uniqueId As String = Nothing, Optional encryptionSettingsCollection As EncryptionSettingsCollection = Nothing, Optional provisioningState As String = Nothing, Optional diskIOPSReadWrite As Nullable(Of Long) = Nothing, Optional diskMBpsReadWrite As Nullable(Of Long) = Nothing, Optional diskIOPSReadOnly As Nullable(Of Long) = Nothing, Optional diskMBpsReadOnly As Nullable(Of Long) = Nothing, Optional diskState As String = Nothing, Optional encryption As Encryption = Nothing, Optional maxShares As Nullable(Of Integer) = Nothing, Optional shareInfo As IList(Of ShareInfoElement) = Nothing, Optional networkAccessPolicy As String = Nothing, Optional diskAccessId As String = Nothing, Optional burstingEnabledTime As Nullable(Of DateTime) = Nothing, Optional tier As String = Nothing, Optional burstingEnabled As Nullable(Of Boolean) = Nothing, Optional propertyUpdatesInProgress As PropertyUpdatesInProgress = Nothing, Optional supportsHibernation As Nullable(Of Boolean) = Nothing, Optional securityProfile As DiskSecurityProfile = Nothing, Optional completionPercent As Nullable(Of Double) = Nothing, Optional publicNetworkAccess As String = Nothing, Optional dataAccessAuthMode As String = Nothing, Optional optimizedForFrequentAttach As Nullable(Of Boolean) = Nothing)

Parameters

location
String

Resource location

creationData
CreationData

Disk source information. CreationData information cannot be changed after the disk has been created.

id
String

Resource Id

name
String

Resource name

type
String

Resource type

tags
IDictionary<String,String>

Resource tags

managedBy
String

A relative URI containing the ID of the VM that has the disk attached.

managedByExtended
IList<String>

List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.

sku
DiskSku
zones
IList<String>

The Logical zone list for Disk.

extendedLocation
ExtendedLocation

The extended location where the disk will be created. Extended location cannot be changed.

timeCreated
Nullable<DateTime>

The time when the disk was created.

osType
Nullable<OperatingSystemTypes>

The Operating System type. Possible values include: 'Windows', 'Linux'

hyperVGeneration
String

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', 'V2'

purchasePlan
PurchasePlan

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

supportedCapabilities
SupportedCapabilities

List of supported capabilities for the image from which the OS disk was created.

diskSizeGB
Nullable<Int32>

If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.

diskSizeBytes
Nullable<Int64>

The size of the disk in bytes. This field is read only.

uniqueId
String

Unique Guid identifying the resource.

encryptionSettingsCollection
EncryptionSettingsCollection

Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

provisioningState
String

The disk provisioning state.

diskIOPSReadWrite
Nullable<Int64>

The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.

diskMBpsReadWrite
Nullable<Int64>

The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

diskIOPSReadOnly
Nullable<Int64>

The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes.

diskMBpsReadOnly
Nullable<Int64>

The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10.

diskState
String

The state of the disk. Possible values include: 'Unattached', 'Attached', 'Reserved', 'Frozen', 'ActiveSAS', 'ActiveSASFrozen', 'ReadyToUpload', 'ActiveUpload'

encryption
Encryption

Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

maxShares
Nullable<Int32>

The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time.

shareInfo
IList<ShareInfoElement>

Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs.

networkAccessPolicy
String

Possible values include: 'AllowAll', 'AllowPrivate', 'DenyAll'

diskAccessId
String

ARM id of the DiskAccess resource for using private endpoints on disks.

burstingEnabledTime
Nullable<DateTime>

Latest time when bursting was last enabled on a disk.

tier
String

Performance tier of the disk (e.g, P4, S10) as described here: https://azure.microsoft.com/en-us/pricing/details/managed-disks/. Does not apply to Ultra disks.

burstingEnabled
Nullable<Boolean>

Set to true to enable bursting beyond the provisioned performance target of the disk. Bursting is disabled by default. Does not apply to Ultra disks.

propertyUpdatesInProgress
PropertyUpdatesInProgress

Properties of the disk for which update is pending.

supportsHibernation
Nullable<Boolean>

Indicates the OS on a disk supports hibernation.

securityProfile
DiskSecurityProfile

Contains the security related information for the resource.

completionPercent
Nullable<Double>

Percentage complete for the background copy when a resource is created via the CopyStart operation.

publicNetworkAccess
String

Possible values include: 'Enabled', 'Disabled'

dataAccessAuthMode
String

Possible values include: 'AzureActiveDirectory', 'None'

optimizedForFrequentAttach
Nullable<Boolean>

Setting this property to true improves reliability and performance of data disks that are frequently (more than 5 times a day) by detached from one virtual machine and attached to another. This property should not be set for disks that are not detached and attached frequently as it causes the disks to not align with the fault domain of the virtual machine.

Applies to