GetDiskResult

data class GetDiskResult(val azureApiVersion: String, val burstingEnabled: Boolean? = null, val burstingEnabledTime: String, val completionPercent: Double? = null, val creationData: CreationDataResponse, val dataAccessAuthMode: String? = null, val diskAccessId: String? = null, val diskIOPSReadOnly: Double? = null, val diskIOPSReadWrite: Double? = null, val diskMBpsReadOnly: Double? = null, val diskMBpsReadWrite: Double? = null, val diskSizeBytes: Double, val diskSizeGB: Int? = null, val diskState: String, val encryption: EncryptionResponse? = null, val encryptionSettingsCollection: EncryptionSettingsCollectionResponse? = null, val extendedLocation: ExtendedLocationResponse? = null, val hyperVGeneration: String? = null, val id: String, val lastOwnershipUpdateTime: String, val location: String, val managedBy: String, val managedByExtended: List<String>, val maxShares: Int? = null, val name: String, val networkAccessPolicy: String? = null, val optimizedForFrequentAttach: Boolean? = null, val osType: String? = null, val propertyUpdatesInProgress: PropertyUpdatesInProgressResponse, val provisioningState: String, val publicNetworkAccess: String? = null, val purchasePlan: PurchasePlanResponse? = null, val securityProfile: DiskSecurityProfileResponse? = null, val shareInfo: List<ShareInfoElementResponse>, val sku: DiskSkuResponse? = null, val supportedCapabilities: SupportedCapabilitiesResponse? = null, val supportsHibernation: Boolean? = null, val tags: Map<String, String>? = null, val tier: String? = null, val timeCreated: String, val type: String, val uniqueId: String, val zones: List<String>? = null)

Disk resource.

Constructors

Link copied to clipboard
constructor(azureApiVersion: String, burstingEnabled: Boolean? = null, burstingEnabledTime: String, completionPercent: Double? = null, creationData: CreationDataResponse, dataAccessAuthMode: String? = null, diskAccessId: String? = null, diskIOPSReadOnly: Double? = null, diskIOPSReadWrite: Double? = null, diskMBpsReadOnly: Double? = null, diskMBpsReadWrite: Double? = null, diskSizeBytes: Double, diskSizeGB: Int? = null, diskState: String, encryption: EncryptionResponse? = null, encryptionSettingsCollection: EncryptionSettingsCollectionResponse? = null, extendedLocation: ExtendedLocationResponse? = null, hyperVGeneration: String? = null, id: String, lastOwnershipUpdateTime: String, location: String, managedBy: String, managedByExtended: List<String>, maxShares: Int? = null, name: String, networkAccessPolicy: String? = null, optimizedForFrequentAttach: Boolean? = null, osType: String? = null, propertyUpdatesInProgress: PropertyUpdatesInProgressResponse, provisioningState: String, publicNetworkAccess: String? = null, purchasePlan: PurchasePlanResponse? = null, securityProfile: DiskSecurityProfileResponse? = null, shareInfo: List<ShareInfoElementResponse>, sku: DiskSkuResponse? = null, supportedCapabilities: SupportedCapabilitiesResponse? = null, supportsHibernation: Boolean? = null, tags: Map<String, String>? = null, tier: String? = null, timeCreated: String, type: String, uniqueId: String, zones: List<String>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The Azure API version of the resource.

Link copied to clipboard

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.

Link copied to clipboard

Latest time when bursting was last enabled on a disk.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val diskAccessId: String? = null

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The size of the disk in bytes. This field is read only.

Link copied to clipboard
val diskSizeGB: Int? = null

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.

Link copied to clipboard

The state of the disk.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val id: String

Resource Id

Link copied to clipboard

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.

Link copied to clipboard

Resource location

Link copied to clipboard

A relative URI containing the ID of the VM that has the disk attached.

Link copied to clipboard

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.

Link copied to clipboard
val maxShares: Int? = null

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.

Link copied to clipboard

Resource name

Link copied to clipboard

Policy for accessing the disk via network.

Link copied to clipboard

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.

Link copied to clipboard
val osType: String? = null

The Operating System type.

Link copied to clipboard

Properties of the disk for which update is pending.

Link copied to clipboard

The disk provisioning state.

Link copied to clipboard

Policy for controlling export on the disk.

Link copied to clipboard

Purchase plan information for the the image from which the OS disk was created. E.g. - {name: 2019-Datacenter, publisher: MicrosoftWindowsServer, product: WindowsServer}

Link copied to clipboard

Contains the security related information for the resource.

Link copied to clipboard

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.

Link copied to clipboard
val sku: DiskSkuResponse? = null

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

Link copied to clipboard

List of supported capabilities for the image from which the OS disk was created.

Link copied to clipboard

Indicates the OS on a disk supports hibernation.

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags

Link copied to clipboard
val tier: String? = null

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.

Link copied to clipboard

The time when the disk was created.

Link copied to clipboard

Resource type

Link copied to clipboard

Unique Guid identifying the resource.

Link copied to clipboard
val zones: List<String>? = null

The Logical zone list for Disk.