Disk interface

Package:

@azure/arm-compute-profile-2020-09-01-hybrid

Disk resource.

Extends

Resource

Properties

creationData	Disk source information. CreationData information cannot be changed after the disk has been created.
diskIopsReadWrite	The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes.
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.
diskSizeBytes	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.
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.
diskState	The state of the disk. NOTE: This property will not be serialized. It can only be populated by the server.
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
encryptionSettingsCollection	Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
hyperVGeneration	The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
managedBy	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.
osType	The Operating System type.
provisioningState	The disk provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
sku	The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS.
timeCreated	The time when the disk was created. NOTE: This property will not be serialized. It can only be populated by the server.
uniqueId	Unique Guid identifying the resource. NOTE: This property will not be serialized. It can only be populated by the server.
zones	The Logical zone list for Disk.

Inherited Properties

id	Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location
name	Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags
type	Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

creationData

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

creationData?: CreationData

Property Value

CreationData

diskIopsReadWrite

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

diskIopsReadWrite?: number

Property 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?: number

Property Value

number

diskSizeBytes

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.

diskSizeBytes?: number

Property 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?: number

Property Value

number

diskState

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

diskState?: string

Property Value

string

encryption

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

encryption?: Encryption

Property Value

Encryption

encryptionSettingsCollection

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

encryptionSettingsCollection?: EncryptionSettingsCollection

Property Value

EncryptionSettingsCollection

hyperVGeneration

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

hyperVGeneration?: string

Property Value

string

managedBy

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.

managedBy?: string

Property Value

string

osType

The Operating System type.

osType?: OperatingSystemTypes

Property Value

OperatingSystemTypes

provisioningState

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

provisioningState?: string

Property Value

string

sku

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

sku?: DiskSku

Property Value

DiskSku

timeCreated

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

timeCreated?: Date

Property Value

Date

uniqueId

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

uniqueId?: string

Property Value

string

zones

The Logical zone list for Disk.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

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

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

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

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

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

type?: string

Property Value

string

Inherited From Resource.type