SnapshotsOperations Class

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.

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 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 object supplied in the body of the Put disk operation. Is either a Snapshot type or a IO[bytes] type. Required.

Returns

Type Description

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

Exceptions

Type Description

begin_delete

Deletes a snapshot.

begin_delete(resource_group_name: str, snapshot_name: str, **kwargs: Any) -> LROPoller[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

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

Exceptions

Type Description

begin_grant_access

Grants access to a snapshot.

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 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

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

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

Exceptions

Type Description

begin_revoke_access

Revokes access to a snapshot.

begin_revoke_access(resource_group_name: str, snapshot_name: str, **kwargs: Any) -> LROPoller[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

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

Exceptions

Type Description

begin_update

Updates (patches) a snapshot.

begin_update(resource_group_name: str, snapshot_name: str, snapshot: _models.SnapshotUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_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 object supplied in the body of the Patch snapshot operation. Is either a SnapshotUpdate type or a IO[bytes] type. Required.

Returns

Type Description

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

Exceptions

Type Description

get

Gets information about a snapshot.

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 or the result of cls(response)

Exceptions

Type Description

list

Lists snapshots under a subscription.

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

Returns

Type Description

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

Exceptions

Type Description

list_by_resource_group

Lists snapshots under a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description

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

Exceptions

Type Description

Attributes

models

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