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

Constructor

Snapshot(*, location: str, tags: Dict[str, str] | None = None, sku: _models.SnapshotSku | None = None, os_type: str | _models.OperatingSystemTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration | 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, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location. Required.
tags	dict[str, str] Resource tags. Default value: None
sku	SnapshotSku The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. Default value: None
os_type	str or OperatingSystemTypes The Operating System type. Known values are: "Windows" and "Linux". Default value: None
hyper_v_generation	str or HyperVGeneration The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2". Default value: None
creation_data	CreationData Disk source information. CreationData information cannot be changed after the disk has been created. Default value: None
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. Default value: None
encryption_settings_collection	EncryptionSettingsCollection Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot. Default value: None
incremental	bool Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed. Default value: None
encryption	Encryption Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys. Default value: None
network_access_policy	str or NetworkAccessPolicy Policy for accessing the disk via network. Known values are: "AllowAll", "AllowPrivate", and "DenyAll". Default value: None
disk_access_id	str ARM id of the DiskAccess resource for using private endpoints on disks. Default value: 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.
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".
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.
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.
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.