PSDisk 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.
public class PSDiskpublic class PSDisk : Microsoft.Azure.Management.Compute.Models.Disktype PSDisk = classtype PSDisk = class
inherit DiskPublic Class PSDiskPublic Class PSDisk
Inherits Disk- Inheritance
-
PSDisk
- Inheritance
- Derived
Constructors
| PSDisk() |
Properties
| BurstingEnabled | |
| 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. (Inherited from Disk) |
| BurstingEnabledTime |
Gets latest time when bursting was last enabled on a disk. (Inherited from Disk) |
| CompletionPercent | |
| CompletionPercent |
Gets or sets percentage complete for the background copy when a resource is created via the CopyStart operation. (Inherited from Disk) |
| CreationData | |
| CreationData |
Gets or sets disk source information. CreationData information cannot be changed after the disk has been created. (Inherited from Disk) |
| DataAccessAuthMode | |
| DataAccessAuthMode |
Gets or sets possible values include: 'AzureActiveDirectory', 'None' (Inherited from Disk) |
| DiskAccessId | |
| DiskAccessId |
Gets or sets ARM id of the DiskAccess resource for using private endpoints on disks. (Inherited from Disk) |
| DiskIOPSReadOnly | |
| 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. (Inherited from Disk) |
| DiskIOPSReadWrite | |
| 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. (Inherited from Disk) |
| DiskMBpsReadOnly | |
| 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. (Inherited from Disk) |
| DiskMBpsReadWrite | |
| 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. (Inherited from Disk) |
| DiskSizeBytes | |
| DiskSizeBytes |
Gets the size of the disk in bytes. This field is read only. (Inherited from Disk) |
| DiskSizeGB | |
| 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. (Inherited from Disk) |
| DiskState | |
| DiskState |
Gets or sets the state of the disk. Possible values include: 'Unattached', 'Attached', 'Reserved', 'Frozen', 'ActiveSAS', 'ActiveSASFrozen', 'ReadyToUpload', 'ActiveUpload' (Inherited from Disk) |
| Encryption | |
| Encryption |
Gets or sets encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. (Inherited from Disk) |
| EncryptionSettingsCollection | |
| EncryptionSettingsCollection |
Gets or sets encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. (Inherited from Disk) |
| ExtendedLocation | |
| ExtendedLocation |
Gets or sets the extended location where the disk will be created. Extended location cannot be changed. (Inherited from Disk) |
| HyperVGeneration | |
| HyperVGeneration |
Gets or sets the hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: 'V1', 'V2' (Inherited from Disk) |
| Id | |
| Id |
Gets resource Id (Inherited from Resource) |
| LastOwnershipUpdateTime |
Gets 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. (Inherited from Disk) |
| Location | |
| Location |
Gets or sets resource location (Inherited from Resource) |
| ManagedBy | |
| ManagedBy |
Gets a relative URI containing the ID of the VM that has the disk attached. (Inherited from Disk) |
| ManagedByExtended | |
| 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. (Inherited from Disk) |
| MaxShares | |
| 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. (Inherited from Disk) |
| Name | |
| Name |
Gets resource name (Inherited from Resource) |
| NetworkAccessPolicy | |
| NetworkAccessPolicy |
Gets or sets possible values include: 'AllowAll', 'AllowPrivate', 'DenyAll' (Inherited from Disk) |
| OptimizedForFrequentAttach | |
| 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. (Inherited from Disk) |
| OsType | |
| OsType |
Gets or sets the Operating System type. Possible values include: 'Windows', 'Linux' (Inherited from Disk) |
| PropertyUpdatesInProgress |
Gets properties of the disk for which update is pending. (Inherited from Disk) |
| ProvisioningState | |
| ProvisioningState |
Gets the disk provisioning state. (Inherited from Disk) |
| PublicNetworkAccess | |
| PublicNetworkAccess |
Gets or sets possible values include: 'Enabled', 'Disabled' (Inherited from Disk) |
| PurchasePlan | |
| 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} (Inherited from Disk) |
| ResourceGroupName | |
| SecurityProfile | |
| SecurityProfile |
Gets or sets contains the security related information for the resource. (Inherited from Disk) |
| ShareInfo | |
| 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. (Inherited from Disk) |
| Sku | |
| Sku | (Inherited from Disk) |
| SupportedCapabilities | |
| SupportedCapabilities |
Gets or sets list of supported capabilities for the image from which the OS disk was created. (Inherited from Disk) |
| SupportsHibernation | |
| SupportsHibernation |
Gets or sets indicates the OS on a disk supports hibernation. (Inherited from Disk) |
| Tags | |
| Tags |
Gets or sets resource tags (Inherited from Resource) |
| Tier | |
| 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. (Inherited from Disk) |
| TimeCreated | |
| TimeCreated |
Gets the time when the disk was created. (Inherited from Disk) |
| Type | |
| Type |
Gets resource type (Inherited from Resource) |
| UniqueId | |
| UniqueId |
Gets unique Guid identifying the resource. (Inherited from Disk) |
| Zones | |
| Zones |
Gets or sets the Logical zone list for Disk. (Inherited from Disk) |
Methods
| Validate() |
Validate the object. (Inherited from Disk) |