Snapshot Class

Definition

Snapshot resource.

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

Constructors

Snapshot()

Initializes a new instance of the Snapshot class.

Snapshot(String, CreationData, String, String, String, IDictionary<String, String>, String, SnapshotSku, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, Nullable<Int32>, Nullable<Int64>, String, String, EncryptionSettingsCollection, String, Nullable<Boolean>, Encryption, String, String, Nullable<Boolean>)

Initializes a new instance of the Snapshot class.

Snapshot(String, CreationData, String, String, String, IDictionary<String, String>, String, SnapshotSku, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, String, EncryptionSettingsCollection, String, Nullable<Boolean>, Encryption, String, String, DiskSecurityProfile, Nullable<Boolean>, String, Nullable<Double>, CopyCompletionError, String)

Initializes a new instance of the Snapshot class.

Snapshot(String, CreationData, String, String, String, IDictionary<String, String>, String, SnapshotSku, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, String, EncryptionSettingsCollection, String, Nullable<Boolean>, Encryption, String, String, DiskSecurityProfile, Nullable<Boolean>, String, Nullable<Double>, String)

Initializes a new instance of the Snapshot class.

Snapshot(String, CreationData, String, String, String, IDictionary<String, String>, String, SnapshotSku, ExtendedLocation, Nullable<DateTime>, Nullable<OperatingSystemTypes>, String, PurchasePlan, SupportedCapabilities, Nullable<Int32>, Nullable<Int64>, String, String, EncryptionSettingsCollection, String, Nullable<Boolean>, String, Encryption, String, String, DiskSecurityProfile, Nullable<Boolean>, String, Nullable<Double>, CopyCompletionError, String)

Initializes a new instance of the Snapshot class.

Properties

CompletionPercent

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

CopyCompletionError

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

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.

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 snapshot. 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 be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.

ExtendedLocation

Gets or sets the extended location where the snapshot 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)
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.

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.

Location

Gets or sets resource location

(Inherited from Resource)
ManagedBy

Gets unused. Always Null.

Name

Gets resource name

(Inherited from Resource)
NetworkAccessPolicy

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

OsType

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

ProvisioningState

Gets the disk provisioning state.

PublicNetworkAccess

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

PurchasePlan

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

SecurityProfile

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

Sku
SupportedCapabilities

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

SupportsHibernation

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

Tags

Gets or sets resource tags

(Inherited from Resource)
TimeCreated

Gets the time when the snapshot was created.

Type

Gets resource type

(Inherited from Resource)
UniqueId

Gets unique Guid identifying the resource.

Methods

Validate()

Validate the object.

Applies to