SnapshotUpdateProperties Class

Snapshot resource update properties.

Constructor

SnapshotUpdateProperties()

Variables

Name Description
osType
Union[str, <xref:"OperatingSystemTypes">]

the Operating System type. Known values are: "Windows" and "Linux".
diskSizeGB
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.
encryptionSettingsCollection
<xref:<xref:"EncryptionSettingsCollection">>

Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
encryption
<xref:<xref:"Encryption">>

Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
networkAccessPolicy
Union[str, <xref:"NetworkAccessPolicy">]

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

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

Indicates the OS on a snapshot supports hibernation.
publicNetworkAccess
Union[str, <xref:"PublicNetworkAccess">]

Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled".
dataAccessAuthMode
Union[str, <xref:"DataAccessAuthMode">]

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

List of supported capabilities for the image from which the OS disk was created.
snapshotAccessState
Union[str, <xref:"SnapshotAccessState">]

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

Attributes

dataAccessAuthMode

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

dataAccessAuthMode: str | DataAccessAuthMode

diskAccessId

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

diskAccessId: str

diskSizeGB

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.

diskSizeGB: int

encryption

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

encryption: Encryption

encryptionSettingsCollection

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

encryptionSettingsCollection: EncryptionSettingsCollection

networkAccessPolicy

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

networkAccessPolicy: str | NetworkAccessPolicy

osType

"Windows" and "Linux".

osType: str | OperatingSystemTypes

publicNetworkAccess

"Enabled" and "Disabled".

publicNetworkAccess: str | PublicNetworkAccess

snapshotAccessState

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

snapshotAccessState: str | SnapshotAccessState

supportedCapabilities

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

supportedCapabilities: SupportedCapabilities

supportsHibernation

Indicates the OS on a snapshot supports hibernation.

supportsHibernation: bool