SnapshotProperties interface

Package:

@azure-rest/arm-compute

Snapshot resource properties.

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.
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.
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.
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.
networkAccessPolicy	Policy for accessing the disk via network.
osType	The Operating System type.
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.
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.

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?: "None" | "AzureActiveDirectory"

Property Value

"None" | "AzureActiveDirectory"

diskAccessId

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

diskAccessId?: string

Property Value

string

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

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

hyperVGeneration

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

hyperVGeneration?: "V1" | "V2"

Property Value

"V1" | "V2"

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

networkAccessPolicy

Policy for accessing the disk via network.

networkAccessPolicy?: "AllowAll" | "AllowPrivate" | "DenyAll"

Property Value

"AllowAll" | "AllowPrivate" | "DenyAll"

osType

The Operating System type.

osType?: "Windows" | "Linux"

Property Value

"Windows" | "Linux"

publicNetworkAccess

Policy for controlling export on the disk.

publicNetworkAccess?: "Enabled" | "Disabled"

Property Value

"Enabled" | "Disabled"

purchasePlan

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

purchasePlan?: PurchasePlanAutoGenerated

Property Value

PurchasePlanAutoGenerated

securityProfile

Contains the security related information for the resource.

securityProfile?: DiskSecurityProfile

Property Value

DiskSecurityProfile

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