azure.mgmt.compute.v2021_12_01.models.Snapshot.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2021_12_01.models.Snapshot
name: Snapshot
fullName: azure.mgmt.compute.v2021_12_01.models.Snapshot
module: azure.mgmt.compute.v2021_12_01.models
inheritances:
- azure.mgmt.compute.v2021_12_01.models._models_py3.Resource
summary: 'Snapshot resource.


  Variables are only populated by the server, and will be ignored when sending a request.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'Snapshot(*, location: str, tags: Dict[str, str] | None = None, sku: _models.SnapshotSku
    | None = None, extended_location: _models.ExtendedLocation | None = None, os_type:
    str | _models.OperatingSystemTypes | None = None, hyper_v_generation: str | _models.HyperVGeneration
    | None = None, purchase_plan: _models.PurchasePlan | None = None, supported_capabilities:
    _models.SupportedCapabilities | None = None, creation_data: _models.CreationData
    | None = None, disk_size_gb: int | None = None, encryption_settings_collection:
    _models.EncryptionSettingsCollection | None = None, incremental: bool | None =
    None, encryption: _models.Encryption | None = None, network_access_policy: str
    | _models.NetworkAccessPolicy | None = None, disk_access_id: str | None = None,
    security_profile: _models.DiskSecurityProfile | None = None, supports_hibernation:
    bool | None = None, public_network_access: str | _models.PublicNetworkAccess |
    None = None, completion_percent: float | None = None, data_access_auth_mode: str
    | _models.DataAccessAuthMode | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: location
    description: Resource location. Required.
    types:
    - <xref:str>
  - 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.v2021_12_01.models.SnapshotSku>
  - name: extended_location
    description: 'The extended location where the snapshot will be created. Extended

      location cannot be changed.'
    types:
    - <xref:azure.mgmt.compute.v2021_12_01.models.ExtendedLocation>
  - name: os_type
    description: 'The Operating System type. Known values are: "Windows" and "Linux".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2021_12_01.models.OperatingSystemTypes>
  - name: hyper_v_generation
    description: 'The hypervisor generation of the Virtual Machine. Applicable to
      OS

      disks only. Known values are: "V1" and "V2".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.compute.v2021_12_01.models.HyperVGeneration>
  - name: purchase_plan
    description: 'Purchase plan information for the image from which the source disk
      for

      the snapshot was originally created.'
    types:
    - <xref:azure.mgmt.compute.v2021_12_01.models.PurchasePlan>
  - name: supported_capabilities
    description: 'List of supported capabilities for the image from which the

      source disk from the snapshot was originally created.'
    types:
    - <xref:azure.mgmt.compute.v2021_12_01.models.SupportedCapabilities>
  - name: creation_data
    description: 'Disk source information. CreationData information cannot be changed

      after the disk has been created.'
    types:
    - <xref:azure.mgmt.compute.v2021_12_01.models.CreationData>
  - 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.v2021_12_01.models.EncryptionSettingsCollection>
  - name: incremental
    description: 'Whether a snapshot is incremental. Incremental snapshots on the
      same disk

      occupy less space than full snapshots and can be diffed.'
    types:
    - <xref:bool>
  - 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.v2021_12_01.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.v2021_12_01.models.NetworkAccessPolicy>
  - name: disk_access_id
    description: 'ARM id of the DiskAccess resource for using private endpoints on

      disks.'
    types:
    - <xref:str>
  - name: security_profile
    description: Contains the security related information for the resource.
    types:
    - <xref:azure.mgmt.compute.v2021_12_01.models.DiskSecurityProfile>
  - 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.v2021_12_01.models.PublicNetworkAccess>
  - name: completion_percent
    description: 'Percentage complete for the background copy when a resource is

      created via the CopyStart operation.'
    types:
    - <xref:float>
  - 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.v2021_12_01.models.DataAccessAuthMode>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource name.
  name: name
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Resource location. Required.
  name: location
  types:
  - <xref:str>
- description: Resource tags.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: Unused. Always Null.
  name: managed_by
  types:
  - <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.v2021_12_01.models.SnapshotSku>
- description: 'The extended location where the snapshot will be created. Extended

    location cannot be changed.'
  name: extended_location
  types:
  - <xref:azure.mgmt.compute.v2021_12_01.models.ExtendedLocation>
- description: The time when the snapshot was created.
  name: time_created
  types:
  - <xref:datetime.datetime>
- description: 'The Operating System type. Known values are: "Windows" and "Linux".'
  name: os_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2021_12_01.models.OperatingSystemTypes>
- description: 'The hypervisor generation of the Virtual Machine. Applicable to OS

    disks only. Known values are: "V1" and "V2".'
  name: hyper_v_generation
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2021_12_01.models.HyperVGeneration>
- description: 'Purchase plan information for the image from which the source disk
    for the

    snapshot was originally created.'
  name: purchase_plan
  types:
  - <xref:azure.mgmt.compute.v2021_12_01.models.PurchasePlan>
- description: 'List of supported capabilities for the image from which the

    source disk from the snapshot was originally created.'
  name: supported_capabilities
  types:
  - <xref:azure.mgmt.compute.v2021_12_01.models.SupportedCapabilities>
- description: 'Disk source information. CreationData information cannot be changed
    after

    the disk has been created.'
  name: creation_data
  types:
  - <xref:azure.mgmt.compute.v2021_12_01.models.CreationData>
- 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: The size of the disk in bytes. This field is read only.
  name: disk_size_bytes
  types:
  - <xref:int>
- description: 'The state of the snapshot. Known values are: "Unattached", "Attached",

    "Reserved", "Frozen", "ActiveSAS", "ActiveSASFrozen", "ReadyToUpload", and "ActiveUpload".'
  name: disk_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.compute.v2021_12_01.models.DiskState>
- description: Unique Guid identifying the resource.
  name: unique_id
  types:
  - <xref:str>
- 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.v2021_12_01.models.EncryptionSettingsCollection>
- description: The disk provisioning state.
  name: provisioning_state
  types:
  - <xref:str>
- description: 'Whether a snapshot is incremental. Incremental snapshots on the same
    disk

    occupy less space than full snapshots and can be diffed.'
  name: incremental
  types:
  - <xref:bool>
- 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.v2021_12_01.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.v2021_12_01.models.NetworkAccessPolicy>
- description: ARM id of the DiskAccess resource for using private endpoints on disks.
  name: disk_access_id
  types:
  - <xref:str>
- description: Contains the security related information for the resource.
  name: security_profile
  types:
  - <xref:azure.mgmt.compute.v2021_12_01.models.DiskSecurityProfile>
- 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.v2021_12_01.models.PublicNetworkAccess>
- description: 'Percentage complete for the background copy when a resource is

    created via the CopyStart operation.'
  name: completion_percent
  types:
  - <xref:float>
- 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.v2021_12_01.models.DataAccessAuthMode>