Package version:

Interface Backups

Interface representing a Backups.

Hierarchy

Backups

Index

Methods

beginClone beginCloneAndWait beginDelete beginDeleteAndWait beginRestore beginRestoreAndWait listByDevice

Methods

beginClone

beginClone(deviceName: string, backupName: string, backupElementName: string, resourceGroupName: string, managerName: string, parameters: CloneRequest, options?: BackupsCloneOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Clones the backup element as a new volume.
Parameters
- deviceName: string
  
  The device name
- backupName: string
  
  The backup name.
- backupElementName: string
  
  The backup element name.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- parameters: CloneRequest
  
  The clone request object.
- Optional options: BackupsCloneOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/backups.ts:76

beginCloneAndWait

beginCloneAndWait(deviceName: string, backupName: string, backupElementName: string, resourceGroupName: string, managerName: string, parameters: CloneRequest, options?: BackupsCloneOptionalParams): Promise<void>
Clones the backup element as a new volume.
Parameters
- deviceName: string
  
  The device name
- backupName: string
  
  The backup name.
- backupElementName: string
  
  The backup element name.
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- parameters: CloneRequest
  
  The clone request object.
- Optional options: BackupsCloneOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/backups.ts:95

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:44

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:59

beginRestore

beginRestore(deviceName: string, backupName: string, resourceGroupName: string, managerName: string, options?: BackupsRestoreOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Restores the backup on the device.
Parameters
- deviceName: string
  
  The device name
- backupName: string
  
  The backupSet name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: BackupsRestoreOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/backups.ts:112

beginRestoreAndWait

beginRestoreAndWait(deviceName: string, backupName: string, resourceGroupName: string, managerName: string, options?: BackupsRestoreOptionalParams): Promise<void>
Restores the backup on the device.
Parameters
- deviceName: string
  
  The device name
- backupName: string
  
  The backupSet name
- resourceGroupName: string
  
  The resource group name
- managerName: string
  
  The manager name
- Optional options: BackupsRestoreOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/backups.ts:127

listByDevice

listByDevice(deviceName: string, resourceGroupName: string, managerName: string, options?: BackupsListByDeviceOptionalParams): PagedAsyncIterableIterator<Backup>
Retrieves all the backups in a device.
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:30

Interface Backups

Hierarchy

Index

Methods

Methods

beginClone

Parameters

deviceName: string

backupName: string

backupElementName: string

resourceGroupName: string

managerName: string

parameters: CloneRequest

Optional options: BackupsCloneOptionalParams

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

beginCloneAndWait

Parameters

deviceName: string

backupName: string

backupElementName: string

resourceGroupName: string

managerName: string

parameters: 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>

beginRestore

Parameters

deviceName: string

backupName: string

resourceGroupName: string

managerName: string

Optional options: BackupsRestoreOptionalParams

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

beginRestoreAndWait

Parameters

deviceName: string

backupName: string

resourceGroupName: string

managerName: string

Optional options: BackupsRestoreOptionalParams

Returns Promise<void>

listByDevice

Parameters

deviceName: string

resourceGroupName: string

managerName: string

Optional options: BackupsListByDeviceOptionalParams

Returns PagedAsyncIterableIterator<Backup>

Settings

Member Visibility

Theme

`Optional` options: BackupsCloneOptionalParams

`Optional` options: BackupsCloneOptionalParams

`Optional` options: BackupsDeleteOptionalParams

`Optional` options: BackupsDeleteOptionalParams

`Optional` options: BackupsRestoreOptionalParams

`Optional` options: BackupsRestoreOptionalParams

`Optional` options: BackupsListByDeviceOptionalParams