Package version:

Interface RestorePointCollections

Interface representing a RestorePointCollections.

interface RestorePointCollections {
    beginDelete(resourceGroupName: string, restorePointCollectionName: string, options?: RestorePointCollectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, restorePointCollectionName: string, options?: RestorePointCollectionsDeleteOptionalParams): Promise<void>;
    createOrUpdate(resourceGroupName: string, restorePointCollectionName: string, parameters: RestorePointCollection, options?: RestorePointCollectionsCreateOrUpdateOptionalParams): Promise<RestorePointCollection>;
    get(resourceGroupName: string, restorePointCollectionName: string, options?: RestorePointCollectionsGetOptionalParams): Promise<RestorePointCollection>;
    list(resourceGroupName: string, options?: RestorePointCollectionsListOptionalParams): PagedAsyncIterableIterator<RestorePointCollection>;
    listAll(options?: RestorePointCollectionsListAllOptionalParams): PagedAsyncIterableIterator<RestorePointCollection>;
    update(resourceGroupName: string, restorePointCollectionName: string, parameters: RestorePointCollectionUpdate, options?: RestorePointCollectionsUpdateOptionalParams): Promise<RestorePointCollection>;
}

Methods

beginDelete(resourceGroupName, restorePointCollectionName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
The operation to delete the restore point collection. This operation will also delete all the contained restore points.
Parameters
- resourceGroupName: string
  The name of the resource group.
- restorePointCollectionName: string
  The name of the Restore Point Collection.
- Optionaloptions: RestorePointCollectionsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/restorePointCollections.ts:81

beginDeleteAndWait(resourceGroupName, restorePointCollectionName, options?): Promise<void>
The operation to delete the restore point collection. This operation will also delete all the contained restore points.
Parameters
- resourceGroupName: string
  The name of the resource group.
- restorePointCollectionName: string
  The name of the Restore Point Collection.
- Optionaloptions: RestorePointCollectionsDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/restorePointCollections.ts:93

createOrUpdate(resourceGroupName, restorePointCollectionName, parameters, options?): Promise<RestorePointCollection>
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.
Parameters
- resourceGroupName: string
  The name of the resource group.
- restorePointCollectionName: string
  The name of the restore point collection.
- parameters: RestorePointCollection
  Parameters supplied to the Create or Update restore point collection operation.
- Optionaloptions: RestorePointCollectionsCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<RestorePointCollection>
- Defined in operationsInterfaces/restorePointCollections.ts:55

get(resourceGroupName, restorePointCollectionName, options?): Promise<RestorePointCollection>
The operation to get the restore point collection.
Parameters
- resourceGroupName: string
  The name of the resource group.
- restorePointCollectionName: string
  The name of the restore point collection.
- Optionaloptions: RestorePointCollectionsGetOptionalParams
  The options parameters.
Returns Promise<RestorePointCollection>
- Defined in operationsInterfaces/restorePointCollections.ts:104

list(resourceGroupName, options?): PagedAsyncIterableIterator<RestorePointCollection>
Gets the list of restore point collections in a resource group.
Parameters
- resourceGroupName: string
  The name of the resource group.
- Optionaloptions: RestorePointCollectionsListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<RestorePointCollection>
- Defined in operationsInterfaces/restorePointCollections.ts:33

update(resourceGroupName, restorePointCollectionName, parameters, options?): Promise<RestorePointCollection>
The operation to update the restore point collection.
Parameters
- resourceGroupName: string
  The name of the resource group.
- restorePointCollectionName: string
  The name of the restore point collection.
- parameters: RestorePointCollectionUpdate
  Parameters supplied to the Update restore point collection operation.
- Optionaloptions: RestorePointCollectionsUpdateOptionalParams
  The options parameters.
Returns Promise<RestorePointCollection>
- Defined in operationsInterfaces/restorePointCollections.ts:68