RestorePointCollectionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:restore_point_collections> attribute.
Constructor
RestorePointCollectionsOperations(*args, **kwargs)
Methods
| begin_delete |
The operation to delete the restore point collection. This operation will also delete all the contained restore points. |
| create_or_update |
The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified. |
| get |
The operation to get the restore point collection. |
| list |
Gets the list of restore point collections in a resource group. |
| list_all |
Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections. |
| update |
The operation to update the restore point collection. |
begin_delete
The operation to delete the restore point collection. This operation will also delete all the contained restore points.
begin_delete(resource_group_name: str, restore_point_collection_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
restore_point_collection_name
Required
|
The name of the restore point collection. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns None |
Exceptions
| Type | Description |
|---|---|
create_or_update
The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.
create_or_update(resource_group_name: str, restore_point_collection_name: str, parameters: _models.RestorePointCollection, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RestorePointCollection
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
restore_point_collection_name
Required
|
The name of the restore point collection. Required. |
|
parameters
Required
|
Parameters supplied to the Create or Update restore point collection operation. Is one of the following types: RestorePointCollection, JSON, IO[bytes] Required. |
Returns
| Type | Description |
|---|---|
|
RestorePointCollection. The RestorePointCollection is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
get
The operation to get the restore point collection.
get(resource_group_name: str, restore_point_collection_name: str, *, expand: str | RestorePointCollectionExpandOptions | None = None, **kwargs: Any) -> RestorePointCollection
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
restore_point_collection_name
Required
|
The name of the restore point collection. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
expand
|
The expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection. "restorePoints" Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
RestorePointCollection. The RestorePointCollection is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list
Gets the list of restore point collections in a resource group.
list(resource_group_name: str, **kwargs: Any) -> ItemPaged[RestorePointCollection]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of RestorePointCollection |
Exceptions
| Type | Description |
|---|---|
list_all
Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.
list_all(**kwargs: Any) -> ItemPaged[RestorePointCollection]
Returns
| Type | Description |
|---|---|
|
An iterator like instance of RestorePointCollection |
Exceptions
| Type | Description |
|---|---|
update
The operation to update the restore point collection.
update(resource_group_name: str, restore_point_collection_name: str, parameters: _models.RestorePointCollectionUpdate, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RestorePointCollection
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
restore_point_collection_name
Required
|
The name of the restore point collection. Required. |
|
parameters
Required
|
Parameters supplied to the Update restore point collection operation. Is one of the following types: RestorePointCollectionUpdate, JSON, IO[bytes] Required. |
Returns
| Type | Description |
|---|---|
|
RestorePointCollection. The RestorePointCollection is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|