Share via


ManagedDiskData Class

Definition

A class representing the ManagedDisk data model. Disk resource.

public class ManagedDiskData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.ManagedDiskData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.ManagedDiskData>
type ManagedDiskData = class
    inherit TrackedResourceData
    interface IJsonModel<ManagedDiskData>
    interface IPersistableModel<ManagedDiskData>
Public Class ManagedDiskData
Inherits TrackedResourceData
Implements IJsonModel(Of ManagedDiskData), IPersistableModel(Of ManagedDiskData)
Inheritance
Implements

Constructors

ManagedDiskData(AzureLocation)

Initializes a new instance of ManagedDiskData.

Properties

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.

BurstingEnabledOn

Latest time when bursting was last enabled on a disk.

CompletionPercent

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

CreationData

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

DataAccessAuthMode

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

DiskAccessId

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

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.

DiskIopsReadWrite

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

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.

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.

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.

Encryption

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

EncryptionSettingsGroup

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

ExtendedLocation

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

HyperVGeneration

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

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
IsOptimizedForFrequentAttach

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.

LastOwnershipUpdateOn

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.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
ManagedBy

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

ManagedByExtended

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.

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.

Name

The name of the resource.

(Inherited from ResourceData)
NetworkAccessPolicy

Policy for accessing the disk via network.

OSType

The Operating System type.

PropertyUpdatesInProgressTargetTier

The target performance tier of the disk if a tier change operation is in progress.

ProvisioningState

The disk provisioning state.

PublicNetworkAccess

Policy for controlling export on the disk.

PurchasePlan

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

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SecurityProfile

Contains the security related information for the resource.

ShareInfo

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.

Sku

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

SupportedCapabilities

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

SupportsHibernation

Indicates the OS on a disk supports hibernation.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
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.

TimeCreated

The time when the disk was created.

UniqueId

Unique Guid identifying the resource.

Zones

The Logical zone list for Disk.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<ManagedDiskData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ManagedDiskData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ManagedDiskData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ManagedDiskData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ManagedDiskData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to