VirtualMachineDiskProperties interface

Package:
@azure/arm-compute

Specifies the properties of a managed disk that can be set at the time of implicit creation of the disk.

Properties

availabilityPolicy

In the case of an availability or connectivity issue with the disk, specify the behavior of your VM.
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.
diskAccessId

Azure resource 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.
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.
logicalSectorSize

Logical sector size in bytes for Ultra Disks. Supported values are 512 and 4096. 4096 is the default.
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. Applies to data disks only.
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) 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.
performancePlus

Set this flag to true to get a boost on the performance target of the disk deployed. This flag can only be set on disk creation time and cannot be disabled after enabled.
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

availabilityPolicy

In the case of an availability or connectivity issue with the disk, specify the behavior of your VM.

availabilityPolicy?: DiskAvailabilityPolicy

Property Value

DiskAvailabilityPolicy

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

diskAccessId

Azure resource 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

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

logicalSectorSize

Logical sector size in bytes for Ultra Disks. Supported values are 512 and 4096. 4096 is the default.

logicalSectorSize?: number

Property Value

number

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. Applies to data disks only.

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) 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

performancePlus

Set this flag to true to get a boost on the performance target of the disk deployed. This flag can only be set on disk creation time and cannot be disabled after enabled.

performancePlus?: 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