Share via

Backups interface

  • Reference
Package:
@azure/arm-storsimple1200series

Interface representing a Backups.

Methods

beginClone(string, string, string, string, string, CloneRequest, BackupsCloneOptionalParams)

Clones the given backup element to a new disk or share with given details.
beginCloneAndWait(string, string, string, string, string, CloneRequest, BackupsCloneOptionalParams)

Clones the given backup element to a new disk or share with given details.
beginDelete(string, string, string, string, BackupsDeleteOptionalParams)

Deletes the backup.
beginDeleteAndWait(string, string, string, string, BackupsDeleteOptionalParams)

Deletes the backup.
listByDevice(string, string, string, BackupsListByDeviceOptionalParams)

Retrieves all the backups in a device. Can be used to get the backups for failover also.
listByManager(string, string, BackupsListByManagerOptionalParams)

Retrieves all the backups in a manager.

Method Details

beginClone(string, string, string, string, string, CloneRequest, BackupsCloneOptionalParams)

Clones the given backup element to a new disk or share with given details.

function beginClone(deviceName: string, backupName: string, elementName: string, resourceGroupName: string, managerName: string, cloneRequest: CloneRequest, options?: BackupsCloneOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

backupName

string

The backup name.

elementName

string

The backup element name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

cloneRequest
CloneRequest

The clone request.

options
BackupsCloneOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginCloneAndWait(string, string, string, string, string, CloneRequest, BackupsCloneOptionalParams)

Clones the given backup element to a new disk or share with given details.

function beginCloneAndWait(deviceName: string, backupName: string, elementName: string, resourceGroupName: string, managerName: string, cloneRequest: CloneRequest, options?: BackupsCloneOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

backupName

string

The backup name.

elementName

string

The backup element name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

cloneRequest
CloneRequest

The clone request.

options
BackupsCloneOptionalParams

The options parameters.

Returns

Promise<void>

beginDelete(string, string, string, string, BackupsDeleteOptionalParams)

Deletes the backup.

function beginDelete(deviceName: string, backupName: string, resourceGroupName: string, managerName: string, options?: BackupsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

backupName

string

The backup name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, BackupsDeleteOptionalParams)

Deletes the backup.

function beginDeleteAndWait(deviceName: string, backupName: string, resourceGroupName: string, managerName: string, options?: BackupsDeleteOptionalParams): Promise<void>

Parameters

deviceName

string

The device name.

backupName

string

The backup name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

listByDevice(string, string, string, BackupsListByDeviceOptionalParams)

Retrieves all the backups in a device. Can be used to get the backups for failover also.

function listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: BackupsListByDeviceOptionalParams): PagedAsyncIterableIterator<Backup, Backup[], PageSettings>

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupsListByDeviceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Backup, Backup[], PageSettings>

listByManager(string, string, BackupsListByManagerOptionalParams)

Retrieves all the backups in a manager.

function listByManager(resourceGroupName: string, managerName: string, options?: BackupsListByManagerOptionalParams): PagedAsyncIterableIterator<Backup, Backup[], PageSettings>

Parameters

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupsListByManagerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Backup, Backup[], PageSettings>