azure.mgmt.compute.v2023_04_02.models.SnapshotUpdate.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_04_02.models.SnapshotUpdate
name: SnapshotUpdate
fullName: azure.mgmt.compute.v2023_04_02.models.SnapshotUpdate
module: azure.mgmt.compute.v2023_04_02.models
inheritances:
- azure.mgmt.compute._serialization.Model
summary: Snapshot update resource.
constructor:
  syntax: '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)'
  keywordOnlyParameters:
  - name: tags
    description: Resource tags.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: sku
    description: '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.'
    types:
    - <xref:azure.mgmt.compute.v2023_04_02.models.SnapshotSku>
  - name: os_type
    description: 'the Operating System type. Known values are: "Windows" and "Linux".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_04_02.models.OperatingSystemTypes>
  - name: disk_size_gb
    description: '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.'
    types:
    - <xref:int>
  - name: encryption_settings_collection
    description: 'Encryption settings collection used be Azure Disk

      Encryption, can contain multiple encryption settings per disk or snapshot.'
    types:
    - <xref:azure.mgmt.compute.v2023_04_02.models.EncryptionSettingsCollection>
  - name: encryption
    description: 'Encryption property can be used to encrypt data at rest with customer

      managed keys or platform managed keys.'
    types:
    - <xref:azure.mgmt.compute.v2023_04_02.models.Encryption>
  - name: network_access_policy
    description: 'Policy for accessing the disk via network. Known values are:

      "AllowAll", "AllowPrivate", and "DenyAll".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_04_02.models.NetworkAccessPolicy>
  - name: disk_access_id
    description: 'ARM id of the DiskAccess resource for using private endpoints on

      disks.'
    types:
    - <xref:str>
  - name: supports_hibernation
    description: Indicates the OS on a snapshot supports hibernation.
    types:
    - <xref:bool>
  - name: public_network_access
    description: 'Policy for controlling export on the disk. Known values are:

      "Enabled" and "Disabled".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_04_02.models.PublicNetworkAccess>
  - name: data_access_auth_mode
    description: 'Additional authentication requirements when exporting or

      uploading to a disk or snapshot. Known values are: "AzureActiveDirectory" and
      "None".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2023_04_02.models.DataAccessAuthMode>
  - name: supported_capabilities
    description: 'List of supported capabilities for the image from which the OS

      disk was created.'
    types:
    - <xref:azure.mgmt.compute.v2023_04_02.models.SupportedCapabilities>
variables:
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: '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.'
  name: sku
  types:
  - <xref:azure.mgmt.compute.v2023_04_02.models.SnapshotSku>
- description: 'the Operating System type. Known values are: "Windows" and "Linux".'
  name: os_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_04_02.models.OperatingSystemTypes>
- description: '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.'
  name: disk_size_gb
  types:
  - <xref:int>
- description: 'Encryption settings collection used be Azure Disk

    Encryption, can contain multiple encryption settings per disk or snapshot.'
  name: encryption_settings_collection
  types:
  - <xref:azure.mgmt.compute.v2023_04_02.models.EncryptionSettingsCollection>
- description: 'Encryption property can be used to encrypt data at rest with customer
    managed

    keys or platform managed keys.'
  name: encryption
  types:
  - <xref:azure.mgmt.compute.v2023_04_02.models.Encryption>
- description: 'Policy for accessing the disk via network. Known values are:

    "AllowAll", "AllowPrivate", and "DenyAll".'
  name: network_access_policy
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_04_02.models.NetworkAccessPolicy>
- description: ARM id of the DiskAccess resource for using private endpoints on disks.
  name: disk_access_id
  types:
  - <xref:str>
- description: Indicates the OS on a snapshot supports hibernation.
  name: supports_hibernation
  types:
  - <xref:bool>
- description: 'Policy for controlling export on the disk. Known values are:

    "Enabled" and "Disabled".'
  name: public_network_access
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_04_02.models.PublicNetworkAccess>
- description: 'Additional authentication requirements when exporting or uploading

    to a disk or snapshot. Known values are: "AzureActiveDirectory" and "None".'
  name: data_access_auth_mode
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2023_04_02.models.DataAccessAuthMode>
- description: 'List of supported capabilities for the image from which the OS

    disk was created.'
  name: supported_capabilities
  types:
  - <xref:azure.mgmt.compute.v2023_04_02.models.SupportedCapabilities>