azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations
name: SnapshotsOperations
fullName: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations
module: azure.mgmt.compute.v2021_04_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.compute.v2021_04_01.ComputeManagementClient>'s\n\
  >\n> <xref:snapshots> attribute.\n>"
constructor:
  syntax: SnapshotsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Creates or updates a snapshot.
  signature: 'begin_create_or_update(resource_group_name: str, snapshot_name: str,
    snapshot: _models.Snapshot, *, content_type: str = ''application/json'', **kwargs:
    Any) -> LROPoller[_models.Snapshot]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot_name
    description: 'The name of the snapshot that is being created. The name can''t
      be changed

      after the snapshot is created. Supported characters for the name are a-z, A-Z,
      0-9, _ and -.

      The max name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot
    description: 'Snapshot object supplied in the body of the Put disk operation.
      Is either a

      Snapshot type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2021_04_01.models.Snapshot>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either Snapshot or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2021_04_01.models.Snapshot>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.begin_delete
  name: begin_delete
  summary: Deletes a snapshot.
  signature: 'begin_delete(resource_group_name: str, snapshot_name: str, **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot_name
    description: 'The name of the snapshot that is being created. The name can''t
      be changed

      after the snapshot is created. Supported characters for the name are a-z, A-Z,
      0-9, _ and -.

      The max name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.begin_grant_access
  name: begin_grant_access
  summary: Grants access to a snapshot.
  signature: 'begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data:
    _models.GrantAccessData, *, content_type: str = ''application/json'', **kwargs:
    Any) -> LROPoller[_models.AccessUri]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot_name
    description: 'The name of the snapshot that is being created. The name can''t
      be changed

      after the snapshot is created. Supported characters for the name are a-z, A-Z,
      0-9, _ and -.

      The max name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: grant_access_data
    description: 'Access data object supplied in the body of the get snapshot access

      operation. Is either a GrantAccessData type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2021_04_01.models.GrantAccessData>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either AccessUri or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2021_04_01.models.AccessUri>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.begin_revoke_access
  name: begin_revoke_access
  summary: Revokes access to a snapshot.
  signature: 'begin_revoke_access(resource_group_name: str, snapshot_name: str, **kwargs:
    Any) -> LROPoller[None]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot_name
    description: 'The name of the snapshot that is being created. The name can''t
      be changed

      after the snapshot is created. Supported characters for the name are a-z, A-Z,
      0-9, _ and -.

      The max name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An instance of LROPoller that returns either None or the result of
      cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.begin_update
  name: begin_update
  summary: Updates (patches) a snapshot.
  signature: 'begin_update(resource_group_name: str, snapshot_name: str, snapshot:
    _models.SnapshotUpdate, *, content_type: str = ''application/json'', **kwargs:
    Any) -> LROPoller[_models.Snapshot]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot_name
    description: 'The name of the snapshot that is being created. The name can''t
      be changed

      after the snapshot is created. Supported characters for the name are a-z, A-Z,
      0-9, _ and -.

      The max name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot
    description: 'Snapshot object supplied in the body of the Patch snapshot operation.
      Is

      either a SnapshotUpdate type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2021_04_01.models.SnapshotUpdate>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An instance of LROPoller that returns either Snapshot or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.compute.v2021_04_01.models.Snapshot>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.get
  name: get
  summary: Gets information about a snapshot.
  signature: 'get(resource_group_name: str, snapshot_name: str, **kwargs: Any) ->
    Snapshot'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot_name
    description: 'The name of the snapshot that is being created. The name can''t
      be changed

      after the snapshot is created. Supported characters for the name are a-z, A-Z,
      0-9, _ and -.

      The max name length is 80 characters. Required.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: Snapshot or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2021_04_01.models.Snapshot>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.list
  name: list
  summary: Lists snapshots under a subscription.
  signature: 'list(**kwargs: Any) -> Iterable[Snapshot]'
  return:
    description: An iterator like instance of either Snapshot or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2021_04_01.models.Snapshot>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.list_by_resource_group
  name: list_by_resource_group
  summary: Lists snapshots under a resource group.
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[Snapshot]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: An iterator like instance of either Snapshot or the result of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.compute.v2021_04_01.models.Snapshot>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.compute.v2021_04_01.operations.SnapshotsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.compute.v2021_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2021_04_01\\models\\__init__.py'>