Package version:

Interface Backups

Interface representing a Backups.

Hierarchy

Backups

Index

Methods

beginClone beginCloneAndWait beginDelete beginDeleteAndWait listByDevice listByManager

Methods

beginClone

beginClone(deviceName: string, backupName: string, elementName: string, resourceGroupName: string, managerName: string, cloneRequest: CloneRequest, options?: BackupsCloneOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Clones the given backup element to a new disk or share with given details.
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.
- Optional options: BackupsCloneOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/backups.ts:87

beginCloneAndWait

beginCloneAndWait(deviceName: string, backupName: string, elementName: string, resourceGroupName: string, managerName: string, cloneRequest: CloneRequest, options?: BackupsCloneOptionalParams): Promise<void>
Clones the given backup element to a new disk or share with given details.
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.
- Optional options: BackupsCloneOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/backups.ts:106

beginDelete

beginDelete(deviceName: string, backupName: string, resourceGroupName: string, managerName: string, options?: BackupsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes the backup.
Parameters
- deviceName: string
  
  The device name.
- backupName: string
  
  The backup name.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: BackupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/backups.ts:55

beginDeleteAndWait

beginDeleteAndWait(deviceName: string, backupName: string, resourceGroupName: string, managerName: string, options?: BackupsDeleteOptionalParams): Promise<void>
Deletes the backup.
Parameters
- deviceName: string
  
  The device name.
- backupName: string
  
  The backup name.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: BackupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/backups.ts:70

listByDevice

listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: BackupsListByDeviceOptionalParams): PagedAsyncIterableIterator<Backup>
Retrieves all the backups in a device. Can be used to get the backups for failover also.
Parameters
- deviceName: string
  
  The device name.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: BackupsListByDeviceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Backup>
- Defined in operationsInterfaces/backups.ts:41

listByManager

listByManager(resourceGroupName: string, managerName: string, options?: BackupsListByManagerOptionalParams): PagedAsyncIterableIterator<Backup>
Retrieves all the backups in a manager.
Parameters
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: BackupsListByManagerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Backup>
- Defined in operationsInterfaces/backups.ts:29

Interface Backups

Hierarchy

Index

Methods

Methods

beginClone

Parameters

deviceName: string

backupName: string

elementName: string

resourceGroupName: string

managerName: string

cloneRequest: CloneRequest

Optional options: BackupsCloneOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCloneAndWait

Parameters

deviceName: string

backupName: string

elementName: string

resourceGroupName: string

managerName: string

cloneRequest: CloneRequest

Optional options: BackupsCloneOptionalParams

Returns Promise<void>

beginDelete

Parameters

deviceName: string

backupName: string

resourceGroupName: string

managerName: string

Optional options: BackupsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

deviceName: string

backupName: string

resourceGroupName: string

managerName: string

Optional options: BackupsDeleteOptionalParams

Returns Promise<void>

listByDevice

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: BackupsListByDeviceOptionalParams

Returns PagedAsyncIterableIterator<Backup>

listByManager

Parameters

resourceGroupName: string

managerName: string

Optional options: BackupsListByManagerOptionalParams

Returns PagedAsyncIterableIterator<Backup>

Settings

Member Visibility

Theme

`Optional` options: BackupsCloneOptionalParams

`Optional` options: BackupsCloneOptionalParams

`Optional` options: BackupsDeleteOptionalParams

`Optional` options: BackupsDeleteOptionalParams

`Optional` options: BackupsListByDeviceOptionalParams

`Optional` options: BackupsListByManagerOptionalParams