RestorePointCollections interface

Package:

@azure/arm-compute

Interface representing a RestorePointCollections.

Methods

beginDelete(string, string, RestorePointCollectionsDeleteOptionalParams)	The operation to delete the restore point collection. This operation will also delete all the contained restore points.
beginDeleteAndWait(string, string, RestorePointCollectionsDeleteOptionalParams)	The operation to delete the restore point collection. This operation will also delete all the contained restore points.
createOrUpdate(string, string, RestorePointCollection, RestorePointCollectionsCreateOrUpdateOptionalParams)	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(string, string, RestorePointCollectionsGetOptionalParams)	The operation to get the restore point collection.
list(string, RestorePointCollectionsListOptionalParams)	Gets the list of restore point collections in a resource group.
listAll(RestorePointCollectionsListAllOptionalParams)	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(string, string, RestorePointCollectionUpdate, RestorePointCollectionsUpdateOptionalParams)	The operation to update the restore point collection.

Method Details

beginDelete(string, string, RestorePointCollectionsDeleteOptionalParams)

The operation to delete the restore point collection. This operation will also delete all the contained restore points.

function beginDelete(resourceGroupName: string, restorePointCollectionName: string, options?: RestorePointCollectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

restorePointCollectionName

string

The name of the Restore Point Collection.

options

RestorePointCollectionsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, RestorePointCollectionsDeleteOptionalParams)

The operation to delete the restore point collection. This operation will also delete all the contained restore points.

function beginDeleteAndWait(resourceGroupName: string, restorePointCollectionName: string, options?: RestorePointCollectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

restorePointCollectionName

string

The name of the Restore Point Collection.

options

RestorePointCollectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, RestorePointCollection, RestorePointCollectionsCreateOrUpdateOptionalParams)

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.

function createOrUpdate(resourceGroupName: string, restorePointCollectionName: string, parameters: RestorePointCollection, options?: RestorePointCollectionsCreateOrUpdateOptionalParams): Promise<RestorePointCollection>

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.

options

RestorePointCollectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RestorePointCollection>

get(string, string, RestorePointCollectionsGetOptionalParams)

The operation to get the restore point collection.

function get(resourceGroupName: string, restorePointCollectionName: string, options?: RestorePointCollectionsGetOptionalParams): Promise<RestorePointCollection>

Parameters

resourceGroupName

string

The name of the resource group.

restorePointCollectionName

string

The name of the restore point collection.

options

RestorePointCollectionsGetOptionalParams

The options parameters.

Returns

Promise<RestorePointCollection>

list(string, RestorePointCollectionsListOptionalParams)

Gets the list of restore point collections in a resource group.

function list(resourceGroupName: string, options?: RestorePointCollectionsListOptionalParams): PagedAsyncIterableIterator<RestorePointCollection, RestorePointCollection[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

RestorePointCollectionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RestorePointCollection, RestorePointCollection[], PageSettings>

listAll(RestorePointCollectionsListAllOptionalParams)

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.

function listAll(options?: RestorePointCollectionsListAllOptionalParams): PagedAsyncIterableIterator<RestorePointCollection, RestorePointCollection[], PageSettings>

Parameters

options

RestorePointCollectionsListAllOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RestorePointCollection, RestorePointCollection[], PageSettings>

update(string, string, RestorePointCollectionUpdate, RestorePointCollectionsUpdateOptionalParams)

The operation to update the restore point collection.

function update(resourceGroupName: string, restorePointCollectionName: string, parameters: RestorePointCollectionUpdate, options?: RestorePointCollectionsUpdateOptionalParams): Promise<RestorePointCollection>

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.

options

RestorePointCollectionsUpdateOptionalParams

The options parameters.

Returns

Promise<RestorePointCollection>