SnapshotUpdate interface

Package:

@azure/arm-compute

Snapshot update resource.

Properties

dataAccessAuthMode	Additional authentication requirements when exporting or uploading to a disk or snapshot.
diskAccessId	ARM id of the DiskAccess resource for using private endpoints on disks.
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.
encryption	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
encryptionSettingsCollection	Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
networkAccessPolicy	Policy for accessing the disk via network.
osType	the Operating System type.
publicNetworkAccess	Policy for controlling export on the disk.
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
supportedCapabilities	List of supported capabilities for the image from which the OS disk was created.
supportsHibernation	Indicates the OS on a snapshot supports hibernation.
tags	Resource tags

Property Details

dataAccessAuthMode

Additional authentication requirements when exporting or uploading to a disk or snapshot.

dataAccessAuthMode?: string

Property Value

string

diskAccessId

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

diskAccessId?: string

Property Value

string

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?: number

Property Value

number

encryption

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

encryption?: Encryption

Property Value

Encryption

encryptionSettingsCollection

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

encryptionSettingsCollection?: EncryptionSettingsCollection

Property Value

EncryptionSettingsCollection

networkAccessPolicy

Policy for accessing the disk via network.

networkAccessPolicy?: string

Property Value

string

osType

the Operating System type.

osType?: OperatingSystemTypes

Property Value

OperatingSystemTypes

publicNetworkAccess

Policy for controlling export on the disk.

publicNetworkAccess?: string

Property Value

string

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

sku?: SnapshotSku

Property Value

SnapshotSku

supportedCapabilities

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

supportedCapabilities?: SupportedCapabilities

Property Value

SupportedCapabilities

supportsHibernation

Indicates the OS on a snapshot supports hibernation.

supportsHibernation?: boolean

Property Value

boolean

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}