Share via

Snapshot interface

  • Reference
Package:
@azure/arm-compute

Snapshot resource.

Extends
Resource

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. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
encryption

Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
encryptionSettingsCollection

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.
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. NOTE: This property will not be serialized. It can only be populated by the server.
managedBy

Unused. Always Null. NOTE: This property will not be serialized. It can only be populated by the server.
networkAccessPolicy

Policy for accessing the disk via network.
osType

The Operating System type.
provisioningState

The disk provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
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.
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.
timeCreated

The time when the snapshot was created. NOTE: This property will not be serialized. It can only be populated by the server.
uniqueId

Unique Guid identifying the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags
type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

completionPercent

Percentage complete for the background copy when a resource is created via the CopyStart operation.

completionPercent?: number

Property Value

number

copyCompletionError

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

copyCompletionError?: CopyCompletionError

Property Value

CopyCompletionError

creationData

Disk source information. CreationData information cannot be changed after the disk has been created.

creationData?: CreationData

Property Value

CreationData

dataAccessAuthMode

Additional authentication requirements when exporting or uploading to a disk or snapshot.

dataAccessAuthMode?: string

Property Value

string

diskAccessId

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

diskAccessId?: string

Property Value

string

diskSizeBytes

The size of the disk in bytes. This field is read only. NOTE: This property will not be serialized. It can only be populated by the server.

diskSizeBytes?: number

Property Value

number

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.

diskSizeGB?: number

Property Value

number

diskState

The state of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.

diskState?: string

Property Value

string

encryption

Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.

encryption?: Encryption

Property Value

Encryption

encryptionSettingsCollection

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

encryptionSettingsCollection?: EncryptionSettingsCollection

Property Value

EncryptionSettingsCollection

extendedLocation

The extended location where the snapshot will be created. Extended location cannot be changed.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

hyperVGeneration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only.

hyperVGeneration?: string

Property Value

string

incremental

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

incremental?: boolean

Property Value

boolean

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. NOTE: This property will not be serialized. It can only be populated by the server.

incrementalSnapshotFamilyId?: string

Property Value

string

managedBy

Unused. Always Null. NOTE: This property will not be serialized. It can only be populated by the server.

managedBy?: string

Property Value

string

networkAccessPolicy

Policy for accessing the disk via network.

networkAccessPolicy?: string

Property Value

string

osType

The Operating System type.

osType?: OperatingSystemTypes

Property Value

OperatingSystemTypes

provisioningState

The disk provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Policy for controlling export on the disk.

publicNetworkAccess?: string

Property Value

string

purchasePlan

Purchase plan information for the image from which the source disk for the snapshot was originally created.

purchasePlan?: DiskPurchasePlan

Property Value

DiskPurchasePlan

securityProfile

Contains the security related information for the resource.

securityProfile?: DiskSecurityProfile

Property Value

DiskSecurityProfile

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

sku?: SnapshotSku

Property Value

SnapshotSku

supportedCapabilities

List of supported capabilities for the image from which the source disk from the snapshot was originally created.

supportedCapabilities?: SupportedCapabilities

Property Value

SupportedCapabilities

supportsHibernation

Indicates the OS on a snapshot supports hibernation.

supportsHibernation?: boolean

Property Value

boolean

timeCreated

The time when the snapshot was created. NOTE: This property will not be serialized. It can only be populated by the server.

timeCreated?: Date

Property Value

Date

uniqueId

Unique Guid identifying the resource. NOTE: This property will not be serialized. It can only be populated by the server.

uniqueId?: string

Property Value

string

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type