Package version:

Interface DiskUpdate

Disk update resource.

interface DiskUpdate {
    burstingEnabled?: boolean;
    dataAccessAuthMode?: string;
    diskAccessId?: string;
    diskIopsReadOnly?: number;
    diskIopsReadWrite?: number;
    diskMBpsReadOnly?: number;
    diskMBpsReadWrite?: number;
    diskSizeGB?: number;
    encryption?: Encryption;
    encryptionSettingsCollection?: EncryptionSettingsCollection;
    maxShares?: number;
    networkAccessPolicy?: string;
    optimizedForFrequentAttach?: boolean;
    osType?: OperatingSystemTypes;
    propertyUpdatesInProgress?: PropertyUpdatesInProgress;
    publicNetworkAccess?: string;
    purchasePlan?: DiskPurchasePlan;
    sku?: DiskSku;
    supportedCapabilities?: SupportedCapabilities;
    supportsHibernation?: boolean;
    tags?: {
        [propertyName: string]: string;
    };
    tier?: string;
}

Properties

burstingEnabled? dataAccessAuthMode? diskAccessId? diskIopsReadOnly? diskIopsReadWrite? diskMBpsReadOnly? diskMBpsReadWrite? diskSizeGB? encryption? encryptionSettingsCollection? maxShares? networkAccessPolicy? optimizedForFrequentAttach? osType? propertyUpdatesInProgress? publicNetworkAccess? purchasePlan? sku? supportedCapabilities? supportsHibernation? tags? tier?

Properties

OptionalburstingEnabled

burstingEnabled?: 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.

OptionaldataAccessAuthMode

dataAccessAuthMode?: string

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

OptionaldiskAccessId

diskAccessId?: string

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

OptionaldiskIopsReadOnly

diskIopsReadOnly?: 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.

OptionaldiskIopsReadWrite

diskIopsReadWrite?: number

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

OptionaldiskMBpsReadOnly

diskMBpsReadOnly?: 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.

OptionaldiskMBpsReadWrite

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

OptionaldiskSizeGB

diskSizeGB?: 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.

Optionalencryption

encryption?: Encryption

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

OptionalencryptionSettingsCollection

encryptionSettingsCollection?: EncryptionSettingsCollection

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

OptionalmaxShares

maxShares?: 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.

OptionalnetworkAccessPolicy

networkAccessPolicy?: string

Policy for accessing the disk via network.

OptionaloptimizedForFrequentAttach

optimizedForFrequentAttach?: 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.

OptionalosType

osType?: OperatingSystemTypes

the Operating System type.

Optional ReadonlypropertyUpdatesInProgress

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.

OptionalpublicNetworkAccess

publicNetworkAccess?: string

Policy for controlling export on the disk.

OptionalpurchasePlan

purchasePlan?: DiskPurchasePlan

Purchase plan information to be added on the OS disk

Optionalsku

sku?: DiskSku

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

OptionalsupportedCapabilities

supportedCapabilities?: SupportedCapabilities

List of supported capabilities to be added on the OS disk.

OptionalsupportsHibernation

supportsHibernation?: boolean

Indicates the OS on a disk supports hibernation.

Optionaltags

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

Resource tags

Optionaltier

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.

Settings

Member Visibility