PSSnapshot Class

Definition

public class PSSnapshot
public class PSSnapshot : Microsoft.Azure.Management.Compute.Models.Snapshot
type PSSnapshot = class
type PSSnapshot = class
    inherit Snapshot
Public Class PSSnapshot
Public Class PSSnapshot
Inherits Snapshot
Inheritance
PSSnapshot
Inheritance
PSSnapshot
Derived

Constructors

PSSnapshot()

Properties

CompletionPercent
CompletionPercent

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

(Inherited from Snapshot)
CopyCompletionError

Gets or sets indicates the error details if the background copy of a resource created via the CopyStart operation fails.

(Inherited from Snapshot)
CreationData
CreationData

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

(Inherited from Snapshot)
DataAccessAuthMode
DataAccessAuthMode

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

(Inherited from Snapshot)
DiskAccessId
DiskAccessId

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

(Inherited from Snapshot)
DiskSizeBytes
DiskSizeBytes

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

(Inherited from Snapshot)
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 Snapshot)
DiskState

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

(Inherited from Snapshot)
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 Snapshot)
EncryptionSettingsCollection
EncryptionSettingsCollection

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

(Inherited from Snapshot)
ExtendedLocation
ExtendedLocation

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

(Inherited from Snapshot)
HyperVGeneration
HyperVGeneration

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

(Inherited from Snapshot)
Id
Id

Gets resource Id

(Inherited from Resource)
Incremental
Incremental

Gets or sets whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.

(Inherited from Snapshot)
IncrementalSnapshotFamilyId

Gets incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.

(Inherited from Snapshot)
Location
Location

Gets or sets resource location

(Inherited from Resource)
ManagedBy
ManagedBy

Gets unused. Always Null.

(Inherited from Snapshot)
Name
Name

Gets resource name

(Inherited from Resource)
NetworkAccessPolicy
NetworkAccessPolicy

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

(Inherited from Snapshot)
OsType
OsType

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

(Inherited from Snapshot)
ProvisioningState
ProvisioningState

Gets the disk provisioning state.

(Inherited from Snapshot)
PublicNetworkAccess
PublicNetworkAccess

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

(Inherited from Snapshot)
PurchasePlan
PurchasePlan

Gets or sets purchase plan information for the image from which the source disk for the snapshot was originally created.

(Inherited from Snapshot)
ResourceGroupName
SecurityProfile

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

(Inherited from Snapshot)
Sku
Sku (Inherited from Snapshot)
SupportedCapabilities
SupportedCapabilities

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

(Inherited from Snapshot)
SupportsHibernation
SupportsHibernation

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

(Inherited from Snapshot)
Tags
Tags

Gets or sets resource tags

(Inherited from Resource)
TimeCreated
TimeCreated

Gets the time when the snapshot was created.

(Inherited from Snapshot)
Type
Type

Gets resource type

(Inherited from Resource)
UniqueId
UniqueId

Gets unique Guid identifying the resource.

(Inherited from Snapshot)

Methods

Validate()

Validate the object.

(Inherited from Snapshot)

Applies to