DiskUpdate interface

Package:

@azure/arm-compute

Disk update 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.
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.
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.
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
encryptionSettingsCollection	Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
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.
publicNetworkAccess	Policy for controlling export on the disk.
purchasePlan	Purchase plan information to be added on the OS disk
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 to be added on the OS disk.
supportsHibernation	Indicates the OS on a disk supports hibernation.
tags	Resource tags
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.

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

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

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

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 be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

encryptionSettingsCollection?: EncryptionSettingsCollection

Property Value

EncryptionSettingsCollection

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

publicNetworkAccess

Policy for controlling export on the disk.

publicNetworkAccess?: string

Property Value

string

purchasePlan

Purchase plan information to be added on the OS disk

purchasePlan?: DiskPurchasePlan

Property Value

DiskPurchasePlan

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 to be added on the OS disk.

supportedCapabilities?: SupportedCapabilities

Property Value

SupportedCapabilities

supportsHibernation

Indicates the OS on a disk supports hibernation.

supportsHibernation?: boolean

Property Value

boolean

tags

Resource tags

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

Property Value

{[propertyName: string]: string}

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