Snapshot Class

Reference

Snapshot resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance: azure.mgmt.compute.v2024_03_02.models._models_py3.Resource

Snapshot

Constructor

Snapshot(*, location: str, tags: Dict[str, str] | None = None, sku: _models.SnapshotSku | None = None, extended_location: _models.ExtendedLocation | None = None, os_type: str | _models.OperatingSystemTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration | None = None, purchase_plan: _models.PurchasePlan | None = None, supported_capabilities: _models.SupportedCapabilities | None = None, creation_data: _models.CreationData | None = None, disk_size_gb: int | None = None, encryption_settings_collection: _models.EncryptionSettingsCollection | None = None, incremental: bool | None = None, encryption: _models.Encryption | None = None, network_access_policy: str | _models.NetworkAccessPolicy | None = None, disk_access_id: str | None = None, security_profile: _models.DiskSecurityProfile | None = None, supports_hibernation: bool | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, completion_percent: float | None = None, copy_completion_error: _models.CopyCompletionError | None = None, data_access_auth_mode: str | _models.DataAccessAuthMode | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
sku	SnapshotSku 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.
extended_location	ExtendedLocation The extended location where the snapshot will be created. Extended location cannot be changed.
os_type	str or OperatingSystemTypes The Operating System type. Known values are: "Windows" and "Linux".
hyper_v_generation	str or HyperVGeneration The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2".
purchase_plan	PurchasePlan Purchase plan information for the image from which the source disk for the snapshot was originally created.
supported_capabilities	SupportedCapabilities List of supported capabilities for the image from which the source disk from the snapshot was originally created.
creation_data	CreationData Disk source information. CreationData information cannot be changed after the disk has been created.
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.
encryption_settings_collection	EncryptionSettingsCollection Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
incremental	bool Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
encryption	Encryption Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
network_access_policy	str or NetworkAccessPolicy 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	DiskSecurityProfile Contains the security related information for the resource.
supports_hibernation	bool Indicates the OS on a snapshot supports hibernation.
public_network_access	str or PublicNetworkAccess Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".
completion_percent	float Percentage complete for the background copy when a resource is created via the CopyStart operation.
copy_completion_error	CopyCompletionError Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
data_access_auth_mode	str or DataAccessAuthMode Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: "AzureActiveDirectory" and "None".

Variables

Name	Description
id	str Resource Id.
name	str Resource name.
type	str Resource type.
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
managed_by	str Unused. Always Null.
sku	SnapshotSku 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.
extended_location	ExtendedLocation The extended location where the snapshot will be created. Extended location cannot be changed.
time_created	datetime The time when the snapshot was created.
os_type	str or OperatingSystemTypes The Operating System type. Known values are: "Windows" and "Linux".
hyper_v_generation	str or HyperVGeneration The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2".
purchase_plan	PurchasePlan Purchase plan information for the image from which the source disk for the snapshot was originally created.
supported_capabilities	SupportedCapabilities List of supported capabilities for the image from which the source disk from the snapshot was originally created.
creation_data	CreationData Disk source information. CreationData information cannot be changed after the disk has been created.
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	str or DiskState 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	EncryptionSettingsCollection 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	bool 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 Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
network_access_policy	str or NetworkAccessPolicy 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	DiskSecurityProfile Contains the security related information for the resource.
supports_hibernation	bool Indicates the OS on a snapshot supports hibernation.
public_network_access	str or PublicNetworkAccess Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".
completion_percent	float Percentage complete for the background copy when a resource is created via the CopyStart operation.
copy_completion_error	CopyCompletionError Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
data_access_auth_mode	str or DataAccessAuthMode Additional authentication requirements when exporting or uploading to a disk or snapshot. Known values are: "AzureActiveDirectory" and "None".

Share via

Snapshot Class

Constructor

Keyword-Only Parameters

Variables

Additional resources