SnapshotsOperations Class
SnapshotsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectSnapshotsOperations
Constructor
SnapshotsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
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, **kwargs: Any) -> LROPoller[_models.Snapshot]Parameters
- snapshot_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Snapshot or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes a snapshot.
begin_delete(resource_group_name: str, snapshot_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- snapshot_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_grant_access
Grants access to a snapshot.
begin_grant_access(resource_group_name: str, snapshot_name: str, grant_access_data: _models.GrantAccessData, **kwargs: Any) -> LROPoller[_models.AccessUri]Parameters
- snapshot_name
- 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.
- grant_access_data
- GrantAccessData
Access data object supplied in the body of the get snapshot access operation.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either AccessUri or the result of cls(response)
Return type
Exceptions
begin_revoke_access
Revokes access to a snapshot.
begin_revoke_access(resource_group_name: str, snapshot_name: str, **kwargs: Any) -> LROPoller[None]Parameters
- snapshot_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_update
Updates (patches) a snapshot.
begin_update(resource_group_name: str, snapshot_name: str, snapshot: _models.SnapshotUpdate, **kwargs: Any) -> LROPoller[_models.Snapshot]Parameters
- snapshot_name
- 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.
- snapshot
- SnapshotUpdate
Snapshot object supplied in the body of the Patch snapshot operation.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Snapshot or the result of cls(response)
Return type
Exceptions
get
Gets information about a snapshot.
get(resource_group_name: str, snapshot_name: str, **kwargs: Any) -> _models.SnapshotParameters
- snapshot_name
- 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.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Snapshot, or the result of cls(response)
Return type
Exceptions
list
Lists snapshots under a subscription.
list(**kwargs: Any) -> Iterable[_models.SnapshotList]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either SnapshotList or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Lists snapshots under a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[_models.SnapshotList]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either SnapshotList or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.compute.v2021_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\compute\\v2021_04_01\\models\\__init__.py'>Feedback
Submit and view feedback for