SnapshotProperties Class

Snapshot resource properties.

Constructor

SnapshotProperties(*args: Any, **kwargs: Any)

Variables

Name Description
time_created

The time when the snapshot was created.

os_type

The Operating System type. Known values are: "Windows" and "Linux".

hyper_v_generation

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

purchase_plan

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

supported_capabilities

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

creation_data

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

disk_size_gb
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.

disk_size_bytes
int

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

disk_state

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

unique_id
str

Unique Guid identifying the resource.

encryption_settings_collection

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

provisioning_state
str

The disk provisioning state.

incremental

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

incremental_snapshot_family_id
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

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

network_access_policy

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

disk_access_id
str

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

security_profile

Contains the security related information for the resource.

supports_hibernation

Indicates the OS on a snapshot supports hibernation.

public_network_access

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

completion_percent

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

copy_completion_error

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

data_access_auth_mode

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

snapshot_access_state

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

Attributes

completion_percent

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

completion_percent: float | None

copy_completion_error

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

copy_completion_error: _models.CopyCompletionError | None

creation_data

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

creation_data: _models.CreationData

data_access_auth_mode

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

data_access_auth_mode: str | _models.DataAccessAuthMode | None

disk_access_id

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

disk_access_id: str | None

disk_size_bytes

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

disk_size_bytes: int | None

disk_size_gb

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.

disk_size_gb: int | None

disk_state

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

disk_state: str | _models.DiskState | None

encryption

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

encryption: _models.Encryption | None

encryption_settings_collection

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

encryption_settings_collection: _models.EncryptionSettingsCollection | None

hyper_v_generation

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

hyper_v_generation: str | _models.HyperVGeneration | None

incremental

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

incremental: bool | None

incremental_snapshot_family_id

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.

incremental_snapshot_family_id: str | None

network_access_policy

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

network_access_policy: str | _models.NetworkAccessPolicy | None

os_type

"Windows" and "Linux".

os_type: str | _models.OperatingSystemTypes | None

provisioning_state

The disk provisioning state.

provisioning_state: str | None

public_network_access

"Enabled" and "Disabled".

public_network_access: str | _models.PublicNetworkAccess | None

purchase_plan

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

purchase_plan: _models.DiskPurchasePlan | None

security_profile

Contains the security related information for the resource.

security_profile: _models.DiskSecurityProfile | None

snapshot_access_state

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

snapshot_access_state: str | _models.SnapshotAccessState | None

supported_capabilities

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

supported_capabilities: _models.SupportedCapabilities | None

supports_hibernation

Indicates the OS on a snapshot supports hibernation.

supports_hibernation: bool | None

time_created

The time when the snapshot was created.

time_created: datetime | None

unique_id

Unique Guid identifying the resource.

unique_id: str | None