Snapshot Class

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

Inheritance

azure.mgmt.compute.v2020_12_01.models._models_py3.Resource

Snapshot

Constructor

Snapshot(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.mgmt.compute.v2020_12_01.models._models_py3.SnapshotSku] = None, extended_location: Optional[azure.mgmt.compute.v2020_12_01.models._models_py3.ExtendedLocation] = None, os_type: Optional[Union[str, azure.mgmt.compute.v2020_12_01.models._compute_management_client_enums.OperatingSystemTypes]] = None, hyper_v_generation: Optional[Union[str, azure.mgmt.compute.v2020_12_01.models._compute_management_client_enums.HyperVGeneration]] = None, purchase_plan: Optional[azure.mgmt.compute.v2020_12_01.models._models_py3.PurchasePlan] = None, creation_data: Optional[azure.mgmt.compute.v2020_12_01.models._models_py3.CreationData] = None, disk_size_gb: Optional[int] = None, encryption_settings_collection: Optional[azure.mgmt.compute.v2020_12_01.models._models_py3.EncryptionSettingsCollection] = None, incremental: Optional[bool] = None, encryption: Optional[azure.mgmt.compute.v2020_12_01.models._models_py3.Encryption] = None, network_access_policy: Optional[Union[str, azure.mgmt.compute.v2020_12_01.models._compute_management_client_enums.NetworkAccessPolicy]] = None, disk_access_id: Optional[str] = None, supports_hibernation: Optional[bool] = None, **kwargs)

Parameters

location

str

Required

Required. Resource location.

tags

dict[str, str]

Required

A set of tags. Resource tags.

sku

SnapshotSku

Required

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

Required

The extended location where the snapshot will be created. Extended location cannot be changed.

os_type

str or OperatingSystemTypes

Required

The Operating System type. Possible values include: "Windows", "Linux".

hyper_v_generation

str or HyperVGeneration

Required

The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Possible values include: "V1", "V2".

purchase_plan

PurchasePlan

Required

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

creation_data

CreationData

Required

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

disk_size_gb

int

Required

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

Required

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

incremental

bool

Required

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

encryption

Encryption

Required

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

network_access_policy

str or NetworkAccessPolicy

Required

Policy for accessing the disk via network. Possible values include: "AllowAll", "AllowPrivate", "DenyAll".

disk_access_id

str

Required

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

supports_hibernation

bool

Required

Indicates the OS on a snapshot supports hibernation.

Variables

id

str

Resource Id.

name

str

Resource name.

type

str

Resource type.

managed_by

str

Unused. Always Null.

time_created

datetime

The time when the snapshot was created.

disk_size_bytes

<xref:long>

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

disk_state

str or DiskState

The state of the snapshot. Possible values include: "Unattached", "Attached", "Reserved", "ActiveSAS", "ReadyToUpload", "ActiveUpload".

unique_id

str

Unique Guid identifying the resource.

provisioning_state

str

The disk provisioning state.