DiskProperties interface
Disk resource properties.
Properties
| bursting |
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. |
| completion |
Percentage complete for the background copy when a resource is created via the CopyStart operation. |
| creation |
Disk source information. CreationData information cannot be changed after the disk has been created. |
| data |
Additional authentication requirements when exporting or uploading to a disk or snapshot. |
| disk |
ARM id of the DiskAccess resource for using private endpoints on disks. |
| disk |
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. |
| disk |
The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. |
| disk |
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. |
| disk |
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. |
| disk |
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. |
| encryption |
Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. |
| hyper |
The hypervisor generation of the Virtual Machine. Applicable to OS disks only. |
| max |
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. |
| network |
Policy for accessing the disk via network. |
| optimized |
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. |
| os |
The Operating System type. |
| public |
Policy for controlling export on the disk. |
| purchase |
Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer} |
| security |
Contains the security related information for the resource. |
| supported |
List of supported capabilities for the image from which the OS disk was created. |
| supports |
Indicates the OS on a disk supports hibernation. |
| 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?: booleanProperty Value
boolean
completionPercent
Percentage complete for the background copy when a resource is created via the CopyStart operation.
completionPercent?: numberProperty Value
number
creationData
Disk source information. CreationData information cannot be changed after the disk has been created.
creationData: CreationDataProperty Value
dataAccessAuthMode
Additional authentication requirements when exporting or uploading to a disk or snapshot.
dataAccessAuthMode?: "None" | "AzureActiveDirectory"Property Value
"None" | "AzureActiveDirectory"
diskAccessId
ARM id of the DiskAccess resource for using private endpoints on disks.
diskAccessId?: stringProperty 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?: numberProperty 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?: numberProperty 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?: numberProperty 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?: numberProperty 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?: numberProperty Value
number
encryption
Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
encryption?: EncryptionProperty Value
encryptionSettingsCollection
Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
encryptionSettingsCollection?: EncryptionSettingsCollectionProperty Value
hyperVGeneration
The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
hyperVGeneration?: "V1" | "V2"Property Value
"V1" | "V2"
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?: numberProperty Value
number
networkAccessPolicy
Policy for accessing the disk via network.
networkAccessPolicy?: "AllowAll" | "AllowPrivate" | "DenyAll"Property Value
"AllowAll" | "AllowPrivate" | "DenyAll"
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?: booleanProperty Value
boolean
osType
The Operating System type.
osType?: "Windows" | "Linux"Property Value
"Windows" | "Linux"
publicNetworkAccess
Policy for controlling export on the disk.
publicNetworkAccess?: "Enabled" | "Disabled"Property Value
"Enabled" | "Disabled"
purchasePlan
Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}
purchasePlan?: PurchasePlanAutoGeneratedProperty Value
securityProfile
Contains the security related information for the resource.
securityProfile?: DiskSecurityProfileProperty Value
supportedCapabilities
List of supported capabilities for the image from which the OS disk was created.
supportedCapabilities?: SupportedCapabilitiesProperty Value
supportsHibernation
Indicates the OS on a disk supports hibernation.
supportsHibernation?: booleanProperty 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?: stringProperty Value
string
