Share via

Disk interface

  • Reference
Package:
@azure/arm-compute

Disk resource.

Extends
Resource

Properties

burstingEnabled

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

Latest time when bursting was last enabled on a disk. NOTE: This property will not be serialized. It can only be populated by the server.
completionPercent

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

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

Additional authentication requirements when exporting or uploading to a disk or snapshot.
diskAccessId

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

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

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

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

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

The size of the disk in bytes. This field is read only. NOTE: This property will not be serialized. It can only be populated by the server.
diskSizeGB

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

The state of the disk. NOTE: This property will not be serialized. It can only be populated by the server.
encryption

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

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

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

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
lastOwnershipUpdateTime

The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. NOTE: This property will not be serialized. It can only be populated by the server.
managedBy

A relative URI containing the ID of the VM that has the disk attached. NOTE: This property will not be serialized. It can only be populated by the server.
managedByExtended

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. NOTE: This property will not be serialized. It can only be populated by the server.
maxShares

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

Policy for accessing the disk via network.
optimizedForFrequentAttach

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

The Operating System type.
propertyUpdatesInProgress

Properties of the disk for which update is pending. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The disk provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Policy for controlling export on the disk.
purchasePlan

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

Contains the security related information for the resource.
shareInfo

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. NOTE: This property will not be serialized. It can only be populated by the server.
sku

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.
supportedCapabilities

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

Indicates the OS on a disk supports hibernation.
tier

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

The time when the disk was created. NOTE: This property will not be serialized. It can only be populated by the server.
uniqueId

Unique Guid identifying the resource. NOTE: This property will not be serialized. It can only be populated by the server.
zones

The Logical zone list for Disk.

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

burstingEnabled

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.

burstingEnabled?: boolean

Property Value

boolean

burstingEnabledTime

Latest time when bursting was last enabled on a disk. NOTE: This property will not be serialized. It can only be populated by the server.

burstingEnabledTime?: Date

Property Value

Date

completionPercent

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

completionPercent?: number

Property Value

number

creationData

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

creationData?: CreationData

Property Value

CreationData

dataAccessAuthMode

Additional authentication requirements when exporting or uploading to a disk or snapshot.

dataAccessAuthMode?: string

Property Value

string

diskAccessId

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

diskAccessId?: string

Property Value

string

diskIopsReadOnly

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.

diskIopsReadOnly?: number

Property Value

number

diskIopsReadWrite

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

diskIopsReadWrite?: number

Property Value

number

diskMBpsReadOnly

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.

diskMBpsReadOnly?: number

Property Value

number

diskMBpsReadWrite

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.

diskMBpsReadWrite?: number

Property Value

number

diskSizeBytes

The size of the disk in bytes. This field is read only. NOTE: This property will not be serialized. It can only be populated by the server.

diskSizeBytes?: number

Property Value

number

diskSizeGB

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.

diskSizeGB?: number

Property Value

number

diskState

The state of the disk. NOTE: This property will not be serialized. It can only be populated by the server.

diskState?: string

Property Value

string

encryption

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

encryption?: Encryption

Property Value

Encryption

encryptionSettingsCollection

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

encryptionSettingsCollection?: EncryptionSettingsCollection

Property Value

EncryptionSettingsCollection

extendedLocation

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

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

hyperVGeneration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

hyperVGeneration?: string

Property Value

string

lastOwnershipUpdateTime

The UTC time when the ownership state of the disk was last changed i.e., the time the disk was last attached or detached from a VM or the time when the VM to which the disk was attached was deallocated or started. NOTE: This property will not be serialized. It can only be populated by the server.

lastOwnershipUpdateTime?: Date

Property Value

Date

managedBy

A relative URI containing the ID of the VM that has the disk attached. NOTE: This property will not be serialized. It can only be populated by the server.

managedBy?: string

Property Value

string

managedByExtended

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. NOTE: This property will not be serialized. It can only be populated by the server.

managedByExtended?: string[]

Property Value

string[]

maxShares

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.

maxShares?: number

Property Value

number

networkAccessPolicy

Policy for accessing the disk via network.

networkAccessPolicy?: string

Property Value

string

optimizedForFrequentAttach

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.

optimizedForFrequentAttach?: boolean

Property Value

boolean

osType

The Operating System type.

osType?: OperatingSystemTypes

Property Value

OperatingSystemTypes

propertyUpdatesInProgress

Properties of the disk for which update is pending. NOTE: This property will not be serialized. It can only be populated by the server.

propertyUpdatesInProgress?: PropertyUpdatesInProgress

Property Value

PropertyUpdatesInProgress

provisioningState

The disk provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Policy for controlling export on the disk.

publicNetworkAccess?: string

Property Value

string

purchasePlan

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

purchasePlan?: DiskPurchasePlan

Property Value

DiskPurchasePlan

securityProfile

Contains the security related information for the resource.

securityProfile?: DiskSecurityProfile

Property Value

DiskSecurityProfile

shareInfo

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. NOTE: This property will not be serialized. It can only be populated by the server.

shareInfo?: ShareInfoElement[]

Property Value

ShareInfoElement[]

sku

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

sku?: DiskSku

Property Value

DiskSku

supportedCapabilities

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

supportedCapabilities?: SupportedCapabilities

Property Value

SupportedCapabilities

supportsHibernation

Indicates the OS on a disk supports hibernation.

supportsHibernation?: boolean

Property Value

boolean

tier

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.

tier?: string

Property Value

string

timeCreated

The time when the disk was created. NOTE: This property will not be serialized. It can only be populated by the server.

timeCreated?: Date

Property Value

Date

uniqueId

Unique Guid identifying the resource. NOTE: This property will not be serialized. It can only be populated by the server.

uniqueId?: string

Property Value

string

zones

The Logical zone list for Disk.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type