Condividi tramite


Disk Class

Definition

Disk resource.

[Microsoft.Rest.Serialization.JsonTransformation]
public class Disk : Microsoft.Azure.Management.Compute.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type Disk = class
    inherit Resource
Public Class Disk
Inherits Resource
Inheritance
Attributes

Constructors

Disk()

Initializes a new instance of the Disk class.

Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile)

Initializes a new instance of the Disk class.

Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, Nullable<DateTime>, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile, Nullable<Double>, String, String, Nullable<Boolean>)

Initializes a new instance of the Disk class.

Disk(String, CreationData, String, String, String, IDictionary<String, String>, String, IList<String>, DiskSku, IList<String>, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, EncryptionSettingsCollection, String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, String, Encryption, Nullable<Int32>, IList<ShareInfoElement>, String, String, String, Nullable<Boolean>, PropertyUpdatesInProgress, Nullable<Boolean>, DiskSecurityProfile, Nullable<Double>, String, String, Nullable<Boolean>)

Properties

BurstingEnabled

Gets or sets 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.

BurstingEnabledTime

Gets latest time when bursting was last enabled on a disk.

CompletionPercent

Gets or sets percentage complete for the background copy when a resource is created via the CopyStart operation.

CreationData

Gets or sets disk source information. CreationData information cannot be changed after the disk has been created.

DataAccessAuthMode

Gets or sets possible values include: 'AzureActiveDirectory', 'None'

DiskAccessId

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

DiskIOPSReadOnly

Gets or sets 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

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

DiskMBpsReadOnly

Gets or sets 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

Gets or sets 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

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

DiskSizeGB

Gets or sets 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

Gets or sets the state of the disk. Possible values include: 'Unattached', 'Attached', 'Reserved', 'Frozen', 'ActiveSAS', 'ActiveSASFrozen', 'ReadyToUpload', 'ActiveUpload'

Encryption

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

EncryptionSettingsCollection

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

ExtendedLocation

Gets or sets the extended location where the disk will be created. Extended location cannot be changed.

HyperVGeneration

Gets or sets the hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', 'V2'

Id

Gets resource Id

(Inherited from Resource)
Location

Gets or sets resource location

(Inherited from Resource)
ManagedBy

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

ManagedByExtended

Gets 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

Gets or sets 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

Gets resource name

(Inherited from Resource)
NetworkAccessPolicy

Gets or sets possible values include: 'AllowAll', 'AllowPrivate', 'DenyAll'

OptimizedForFrequentAttach

Gets or sets 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.

OsType

Gets or sets the Operating System type. Possible values include: 'Windows', 'Linux'

PropertyUpdatesInProgress

Gets properties of the disk for which update is pending.

ProvisioningState

Gets the disk provisioning state.

PublicNetworkAccess

Gets or sets possible values include: 'Enabled', 'Disabled'

PurchasePlan

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

SecurityProfile

Gets or sets contains the security related information for the resource.

ShareInfo

Gets 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
SupportedCapabilities

Gets or sets list of supported capabilities for the image from which the OS disk was created.

SupportsHibernation

Gets or sets indicates the OS on a disk supports hibernation.

Tags

Gets or sets resource tags

(Inherited from Resource)
Tier

Gets or sets 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

Gets the time when the disk was created.

Type

Gets resource type

(Inherited from Resource)
UniqueId

Gets unique Guid identifying the resource.

Zones

Gets or sets the Logical zone list for Disk.

Methods

Validate()

Validate the object.

Applies to