SnapshotProperties Class

Snapshot resource properties.

Constructor

SnapshotProperties()

Variables

Name Description
timeCreated
str

The time when the snapshot was created.
osType
Union[str, <xref:"OperatingSystemTypes">]

The Operating System type. Known values are: "Windows" and "Linux".
hyperVGeneration
Union[str, <xref:"HyperVGeneration">]

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2".
purchasePlan
<xref:<xref:"DiskPurchasePlan">>

Purchase plan information for the image from which the source disk for the snapshot was originally created.
supportedCapabilities
<xref:<xref:"SupportedCapabilities">>

List of supported capabilities for the image from which the source disk from the snapshot was originally created.
creationData
<xref:<xref:"CreationData">>

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

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.
diskSizeBytes
int

The size of the disk in bytes. This field is read only.
diskState
Union[str, <xref:"DiskState">]

The state of the snapshot. Known values are: "Unattached", "Attached", "Reserved", "Frozen", "ActiveSAS", "ActiveSASFrozen", "ReadyToUpload", and "ActiveUpload".
uniqueId
str

Unique Guid identifying the resource.
encryptionSettingsCollection
<xref:<xref:"EncryptionSettingsCollection">>

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

The disk provisioning state.
incremental
bool

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

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.
encryption
<xref:<xref:"Encryption">>

Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
networkAccessPolicy
Union[str, <xref:"NetworkAccessPolicy">]

Policy for accessing the disk via network. Known values are: "AllowAll", "AllowPrivate", and "DenyAll".
diskAccessId
str

ARM id of the DiskAccess resource for using private endpoints on disks.
securityProfile
<xref:<xref:"DiskSecurityProfile">>

Contains the security related information for the resource.
supportsHibernation
bool

Indicates the OS on a snapshot supports hibernation.
publicNetworkAccess
Union[str, <xref:"PublicNetworkAccess">]

Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".
completionPercent
float

Percentage complete for the background copy when a resource is created via the CopyStart operation.
copyCompletionError
<xref:<xref:"CopyCompletionError">>

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
dataAccessAuthMode
Union[str, <xref:"DataAccessAuthMode">]

Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: "AzureActiveDirectory" and "None".
snapshotAccessState
Union[str, <xref:"SnapshotAccessState">]

The state of snapshot which determines the access availability of the snapshot. Known values are: "Unknown", "Pending", "Available", "InstantAccess", and "AvailableWithInstantAccess".
immutabilityPolicy
<xref:<xref:"ImmutabilityPolicy">>

The immutability policy currently applied to this snapshot. Present only when an immutability policy has been configured.

Attributes

completionPercent

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

completionPercent: float

copyCompletionError

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

copyCompletionError: CopyCompletionError

creationData

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

creationData: Required[CreationData]

dataAccessAuthMode

Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: "AzureActiveDirectory" and "None".

dataAccessAuthMode: str | DataAccessAuthMode

diskAccessId

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

diskAccessId: str

diskSizeBytes

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

diskSizeBytes: int

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: int

diskState

"Unattached", "Attached", "Reserved", "Frozen", "ActiveSAS", "ActiveSASFrozen", "ReadyToUpload", and "ActiveUpload".

diskState: str | DiskState

encryption

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

encryption: Encryption

encryptionSettingsCollection

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

encryptionSettingsCollection: EncryptionSettingsCollection

hyperVGeneration

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2".

hyperVGeneration: str | HyperVGeneration

immutabilityPolicy

The immutability policy currently applied to this snapshot. Present only when an immutability policy has been configured.

immutabilityPolicy: ImmutabilityPolicy

incremental

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

incremental: bool

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: str

networkAccessPolicy

"AllowAll", "AllowPrivate", and "DenyAll".

networkAccessPolicy: str | NetworkAccessPolicy

osType

"Windows" and "Linux".

osType: str | OperatingSystemTypes

provisioningState

The disk provisioning state.

provisioningState: str

publicNetworkAccess

"Enabled" and "Disabled".

publicNetworkAccess: str | PublicNetworkAccess

purchasePlan

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

purchasePlan: DiskPurchasePlan

securityProfile

Contains the security related information for the resource.

securityProfile: DiskSecurityProfile

snapshotAccessState

The state of snapshot which determines the access availability of the snapshot. Known values are: "Unknown", "Pending", "Available", "InstantAccess", and "AvailableWithInstantAccess".

snapshotAccessState: str | SnapshotAccessState

supportedCapabilities

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

supportedCapabilities: SupportedCapabilities

supportsHibernation

Indicates the OS on a snapshot supports hibernation.

supportsHibernation: bool

timeCreated

The time when the snapshot was created.

timeCreated: str

uniqueId

Unique Guid identifying the resource.

uniqueId: str