DiskUpdate | @azure/arm-compute

Disk update resource.

Hierarchy

DiskUpdate

Index

Properties

Optional burstingEnabled

burstingEnabled: undefined | false | true

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.

Optional diskAccessId

diskAccessId: undefined | string

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

Optional diskIopsReadOnly

diskIopsReadOnly: undefined | number

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.

Optional diskIopsReadWrite

diskIopsReadWrite: undefined | number

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

Optional diskMBpsReadOnly

diskMBpsReadOnly: undefined | number

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.

Optional diskMBpsReadWrite

diskMBpsReadWrite: undefined | number

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.

Optional diskSizeGB

diskSizeGB: undefined | number

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.

Optional encryption

encryption: Encryption

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

Optional encryptionSettingsCollection

encryptionSettingsCollection: EncryptionSettingsCollection

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

Optional maxShares

maxShares: undefined | number

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.

Optional networkAccessPolicy

networkAccessPolicy: NetworkAccessPolicy

Policy for accessing the disk via network.

Optional osType

osType: OperatingSystemTypes

the Operating System type.

Optional propertyUpdatesInProgress

propertyUpdatesInProgress: 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.

Optional purchasePlan

purchasePlan: PurchasePlanAutoGenerated

Purchase plan information to be added on the OS disk

Optional sku

sku: DiskSku

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

Optional supportsHibernation

supportsHibernation: undefined | false | true

Indicates the OS on a disk supports hibernation.

Optional tags

tags: undefined | {}

Resource tags

Optional tier

tier: undefined | 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.