Share via

SnapshotsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:snapshots> attribute.

Inheritance
builtins.object
SnapshotsOperations

Constructor

SnapshotsOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a snapshot.
begin_delete

Deletes a snapshot.
begin_grant_access

Grants access to a snapshot.
begin_revoke_access

Revokes access to a snapshot.
begin_update

Updates (patches) a snapshot.
get

Gets information about a snapshot.
list

Lists snapshots under a subscription.
list_by_resource_group

Lists snapshots under a resource group.

begin_create_or_update

Creates or updates a snapshot.

async begin_create_or_update(resource_group_name: str, snapshot_name: str, snapshot: _models.Snapshot, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Snapshot]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
snapshot_name
Required
str

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.
snapshot
Required
Snapshot or IO[bytes]

Snapshot object supplied in the body of the Put disk operation. Is either a Snapshot type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[Snapshot]

An instance of AsyncLROPoller that returns either Snapshot or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a snapshot.

async begin_delete(resource_group_name: str, snapshot_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
snapshot_name
Required
str

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.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_grant_access

Grants access to a snapshot.

async begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data: _models.GrantAccessData, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.AccessUri]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
snapshot_name
Required
str

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.
grant_access_data
Required
GrantAccessData or IO[bytes]

Access data object supplied in the body of the get snapshot access operation. Is either a GrantAccessData type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[AccessUri]

An instance of AsyncLROPoller that returns either AccessUri or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_revoke_access

Revokes access to a snapshot.

async begin_revoke_access(resource_group_name: str, snapshot_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
snapshot_name
Required
str

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.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Updates (patches) a snapshot.

async begin_update(resource_group_name: str, snapshot_name: str, snapshot: _models.SnapshotUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Snapshot]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
snapshot_name
Required
str

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.
snapshot
Required
SnapshotUpdate or IO[bytes]

Snapshot object supplied in the body of the Patch snapshot operation. Is either a SnapshotUpdate type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[Snapshot]

An instance of AsyncLROPoller that returns either Snapshot or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets information about a snapshot.

async get(resource_group_name: str, snapshot_name: str, **kwargs: Any) -> Snapshot

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
snapshot_name
Required
str

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.

Returns

Type Description
Snapshot

Snapshot or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists snapshots under a subscription.

list(**kwargs: Any) -> AsyncIterable[Snapshot]

Returns

Type Description
AsyncItemPaged[Snapshot]

An iterator like instance of either Snapshot or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists snapshots under a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[Snapshot]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
AsyncItemPaged[Snapshot]

An iterator like instance of either Snapshot or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.compute.v2018_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2018_04_01\\models\\__init__.py'>