ManagedDisk Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
ManagedDisk.
public class ManagedDisk : Azure.Provisioning.Primitives.ProvisionableResource
type ManagedDisk = class
inherit ProvisionableResource
Public Class ManagedDisk
Inherits ProvisionableResource
- Inheritance
Constructors
| Name | Description |
|---|---|
| ManagedDisk(String, String) |
Creates a new ManagedDisk. |
Properties
| Name | Description |
|---|---|
| AvailabilityActionOnDiskDelay |
Determines on how to handle disks with slow I/O. |
| BicepIdentifier |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct) |
| BicepMetadata |
Gets the Bicep metadata for this resource, including decorators and conditions. (Inherited from ProvisionableResource) |
| 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. |
| DependsOn |
Declares explicit dependencies on other resources. (Inherited from ProvisionableResource) |
| 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 |
Gets the Id. |
| IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource) |
| 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 |
Gets or sets the Location. |
| 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 managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. |
| 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 |
Gets the type of the resource. (Inherited from ProvisionableResource) |
| ResourceVersion |
Gets or sets the version of the resource. (Inherited from ProvisionableResource) |
| 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 |
Gets the SystemData. |
| Tags |
Gets or sets the Tags. |
| 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
Explicit Interface Implementations
| Name | Description |
|---|---|
| IBicepValue.Assign(IBicepValue) |
Assign a value to this property. (Inherited from ProvisionableConstruct) |
| IBicepValue.Compile() |
Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct) |
| IBicepValue.Expression |
Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsEmpty |
Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsOutput |
Tracks whether this is an output only property. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsRequired |
Tracks whether this property is required. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsSecure |
Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct) |
| IBicepValue.Kind |
Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct) |
| IBicepValue.LiteralValue |
Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct) |
| IBicepValue.Self |
Gets information about where this value was defined. (Inherited from ProvisionableConstruct) |
| IBicepValue.SetReadOnly() |
Make this value readonly. (Inherited from ProvisionableConstruct) |
| IBicepValue.Source |
Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct) |
Extension Methods
| Name | Description |
|---|---|
| ToBicepExpression(IBicepValue) |
Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy. |