Package version:

Interface SnapshotUpdate

Snapshot update resource.

interface SnapshotUpdate {
    dataAccessAuthMode?: string;
    diskAccessId?: string;
    diskSizeGB?: number;
    encryption?: Encryption;
    encryptionSettingsCollection?: EncryptionSettingsCollection;
    networkAccessPolicy?: string;
    osType?: OperatingSystemTypes;
    publicNetworkAccess?: string;
    sku?: SnapshotSku;
    supportedCapabilities?: SupportedCapabilities;
    supportsHibernation?: boolean;
    tags?: {
        [propertyName: string]: string;
    };
}

Properties

dataAccessAuthMode? diskAccessId? diskSizeGB? encryption? encryptionSettingsCollection? networkAccessPolicy? osType? publicNetworkAccess? sku? supportedCapabilities? supportsHibernation? tags?

Properties

OptionaldataAccessAuthMode

dataAccessAuthMode?: string

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

OptionaldiskAccessId

diskAccessId?: string

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

OptionaldiskSizeGB

diskSizeGB?: number

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.

Optionalencryption

encryption?: Encryption

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

OptionalencryptionSettingsCollection

encryptionSettingsCollection?: EncryptionSettingsCollection

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

OptionalnetworkAccessPolicy

networkAccessPolicy?: string

Policy for accessing the disk via network.

OptionalosType

osType?: OperatingSystemTypes

the Operating System type.

OptionalpublicNetworkAccess

publicNetworkAccess?: string

Policy for controlling export on the disk.

Optionalsku

sku?: SnapshotSku

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

OptionalsupportedCapabilities

supportedCapabilities?: SupportedCapabilities

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

OptionalsupportsHibernation

supportsHibernation?: boolean

Indicates the OS on a snapshot supports hibernation.

Optionaltags

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

Resource tags

Settings

Member Visibility