SnapshotUpdate Class

Snapshot update resource.

Inheritance
azure.mgmt.compute._serialization.Model
SnapshotUpdate

Constructor

SnapshotUpdate(*, tags: Dict[str, str] | None = None, sku: _models.SnapshotSku | None = None, os_type: str | _models.OperatingSystemTypes | None = None, disk_size_gb: int | None = None, encryption_settings_collection: _models.EncryptionSettingsCollection | None = None, encryption: _models.Encryption | None = None, network_access_policy: str | _models.NetworkAccessPolicy | None = None, disk_access_id: str | None = None, supports_hibernation: bool | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, data_access_auth_mode: str | _models.DataAccessAuthMode | None = None, supported_capabilities: _models.SupportedCapabilities | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags

Resource tags.

sku

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.

os_type

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

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

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

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.

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

data_access_auth_mode

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

supported_capabilities

List of supported capabilities for the image from which the OS disk was created.

Variables

Name Description
tags

Resource tags.

sku

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.

os_type

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

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

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

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.

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

data_access_auth_mode

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

supported_capabilities

List of supported capabilities for the image from which the OS disk was created.