SnapshotData 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.
A class representing the Snapshot data model. Snapshot resource.
public class SnapshotData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.SnapshotData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.SnapshotData>
type SnapshotData = class
inherit TrackedResourceData
interface IJsonModel<SnapshotData>
interface IPersistableModel<SnapshotData>
Public Class SnapshotData
Inherits TrackedResourceData
Implements IJsonModel(Of SnapshotData), IPersistableModel(Of SnapshotData)
- Inheritance
- Implements
Constructors
SnapshotData(AzureLocation) |
Initializes a new instance of SnapshotData. |
Properties
CompletionPercent |
Percentage complete for the background copy when a resource is created via the CopyStart operation. |
CopyCompletionError |
Indicates the error details if the background copy of a resource created via the CopyStart operation fails. |
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. |
DiskAccessId |
ARM id of the DiskAccess resource for using private endpoints on disks. |
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 snapshot. |
Encryption |
Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. |
EncryptionSettingsGroup |
Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. |
ExtendedLocation |
The extended location where the snapshot will be created. Extended location cannot be changed. |
HyperVGeneration |
The hypervisor generation of the Virtual Machine. Applicable to OS disks only. |
Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
Incremental |
Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. |
IncrementalSnapshotFamilyId |
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 |
The geo-location where the resource lives. (Inherited from TrackedResourceData) |
ManagedBy |
Unused. Always Null. |
Name |
The name of the resource. (Inherited from ResourceData) |
NetworkAccessPolicy |
Policy for accessing the disk via network. |
OSType |
The Operating System type. |
ProvisioningState |
The disk provisioning state. |
PublicNetworkAccess |
Policy for controlling export on the disk. |
PurchasePlan |
Purchase plan information for the image from which the source disk for the snapshot was originally created. |
ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
SecurityProfile |
Contains the security related information for the resource. |
Sku |
The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot. |
SupportedCapabilities |
List of supported capabilities for the image from which the source disk from the snapshot was originally created. |
SupportsHibernation |
Indicates the OS on a snapshot supports hibernation. |
SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
Tags |
Resource tags. (Inherited from TrackedResourceData) |
TimeCreated |
The time when the snapshot was created. |
UniqueId |
Unique Guid identifying the resource. |
Methods
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) |
Explicit Interface Implementations
IJsonModel<SnapshotData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<SnapshotData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<SnapshotData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<SnapshotData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<SnapshotData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |