SnapshotPropertiesOutput 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.
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.
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.
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.
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.
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.
timeCreated	The time when the snapshot was created.
uniqueId	Unique Guid identifying the resource.

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?: CopyCompletionErrorOutput

Property Value

CopyCompletionErrorOutput

creationData

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

creationData: CreationDataOutput

Property Value

CreationDataOutput

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

diskSizeBytes

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

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.

diskState?: "Unattached" | "Attached" | "Reserved" | "Frozen" | "ActiveSAS" | "ActiveSASFrozen" | "ReadyToUpload" | "ActiveUpload"

Property Value

"Unattached" | "Attached" | "Reserved" | "Frozen" | "ActiveSAS" | "ActiveSASFrozen" | "ReadyToUpload" | "ActiveUpload"

encryption

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

encryption?: EncryptionOutput

Property Value

EncryptionOutput

encryptionSettingsCollection

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

encryptionSettingsCollection?: EncryptionSettingsCollectionOutput

Property Value

EncryptionSettingsCollectionOutput

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

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.

incrementalSnapshotFamilyId?: string

Property Value

string

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"

provisioningState

The disk provisioning state.

provisioningState?: string

Property Value

string

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?: PurchasePlanAutoGeneratedOutput

Property Value

PurchasePlanAutoGeneratedOutput

securityProfile

Contains the security related information for the resource.

securityProfile?: DiskSecurityProfileOutput

Property Value

DiskSecurityProfileOutput

supportedCapabilities

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

supportedCapabilities?: SupportedCapabilitiesOutput

Property Value

SupportedCapabilitiesOutput

supportsHibernation

Indicates the OS on a snapshot supports hibernation.

supportsHibernation?: boolean

Property Value

boolean

timeCreated

The time when the snapshot was created.

timeCreated?: string

Property Value

string

uniqueId

Unique Guid identifying the resource.

uniqueId?: string

Property Value

string