Package version:

Interface Disk

Disk resource.

interface Disk {
    burstingEnabled?: boolean;
    burstingEnabledTime?: any;
    completionPercent?: number;
    creationData?: CreationData;
    dataAccessAuthMode?: string;
    diskAccessId?: string;
    diskIopsReadOnly?: number;
    diskIopsReadWrite?: number;
    diskMBpsReadOnly?: number;
    diskMBpsReadWrite?: number;
    diskSizeBytes?: number;
    diskSizeGB?: number;
    diskState?: string;
    encryption?: Encryption;
    encryptionSettingsCollection?: EncryptionSettingsCollection;
    extendedLocation?: ExtendedLocation;
    hyperVGeneration?: string;
    id?: string;
    lastOwnershipUpdateTime?: any;
    location: string;
    managedBy?: string;
    managedByExtended?: string[];
    maxShares?: number;
    name?: string;
    networkAccessPolicy?: string;
    optimizedForFrequentAttach?: boolean;
    osType?: OperatingSystemTypes;
    propertyUpdatesInProgress?: PropertyUpdatesInProgress;
    provisioningState?: string;
    publicNetworkAccess?: string;
    purchasePlan?: DiskPurchasePlan;
    securityProfile?: DiskSecurityProfile;
    shareInfo?: ShareInfoElement[];
    sku?: DiskSku;
    supportedCapabilities?: SupportedCapabilities;
    supportsHibernation?: boolean;
    tags?: {
        [propertyName: string]: string;
    };
    tier?: string;
    timeCreated?: any;
    type?: string;
    uniqueId?: string;
    zones?: string[];
}

Hierarchy (view full)

Properties

burstingEnabled? burstingEnabledTime? completionPercent? creationData? dataAccessAuthMode? diskAccessId? diskIopsReadOnly? diskIopsReadWrite? diskMBpsReadOnly? diskMBpsReadWrite? diskSizeBytes? diskSizeGB? diskState? encryption? encryptionSettingsCollection? extendedLocation? hyperVGeneration? id? lastOwnershipUpdateTime? location managedBy? managedByExtended? maxShares? name? networkAccessPolicy? optimizedForFrequentAttach? osType? propertyUpdatesInProgress? provisioningState? publicNetworkAccess? purchasePlan? securityProfile? shareInfo? sku? supportedCapabilities? supportsHibernation? tags? tier? timeCreated? type? uniqueId? zones?

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.

Optional ReadonlyburstingEnabledTime

burstingEnabledTime?: any

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.

OptionalcompletionPercent

completionPercent?: number

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

OptionalcreationData

creationData?: CreationData

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

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.

Optional ReadonlydiskSizeBytes

diskSizeBytes?: number

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.

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.

Optional ReadonlydiskState

diskState?: string

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

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

OptionalextendedLocation

extendedLocation?: ExtendedLocation

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

OptionalhyperVGeneration

hyperVGeneration?: string

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

Optional Readonlyid

id?: string

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

Optional ReadonlylastOwnershipUpdateTime

lastOwnershipUpdateTime?: any

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.

location

location: string

Resource location

Optional ReadonlymanagedBy

managedBy?: string

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.

Optional ReadonlymanagedByExtended

managedByExtended?: string[]

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.

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.

Optional Readonlyname

name?: string

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

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.

Optional ReadonlyprovisioningState

provisioningState?: string

The disk provisioning state. 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 for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

OptionalsecurityProfile

securityProfile?: DiskSecurityProfile

Contains the security related information for the resource.

Optional ReadonlyshareInfo

shareInfo?: ShareInfoElement[]

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.

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 for the image from which the OS disk was created.

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.

Optional ReadonlytimeCreated

timeCreated?: any

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

Optional Readonlytype

type?: string

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

Optional ReadonlyuniqueId

uniqueId?: string

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

Optionalzones

zones?: string[]

The Logical zone list for Disk.

Settings

Member Visibility