Backups interface
Interface representing a Backups.
Methods
begin |
Clones the backup element as a new volume. |
begin |
Clones the backup element as a new volume. |
begin |
Deletes the backup. |
begin |
Deletes the backup. |
begin |
Restores the backup on the device. |
begin |
Restores the backup on the device. |
list |
Retrieves all the backups in a device. |
Method Details
beginClone(string, string, string, string, string, CloneRequest, BackupsCloneOptionalParams)
Clones the backup element as a new volume.
function beginClone(deviceName: string, backupName: string, backupElementName: string, resourceGroupName: string, managerName: string, parameters: CloneRequest, options?: BackupsCloneOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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.
- options
- BackupsCloneOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginCloneAndWait(string, string, string, string, string, CloneRequest, BackupsCloneOptionalParams)
Clones the backup element as a new volume.
function beginCloneAndWait(deviceName: string, backupName: string, backupElementName: string, resourceGroupName: string, managerName: string, parameters: CloneRequest, options?: BackupsCloneOptionalParams): Promise<void>
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.
- 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>
beginRestore(string, string, string, string, BackupsRestoreOptionalParams)
Restores the backup on the device.
function beginRestore(deviceName: string, backupName: string, resourceGroupName: string, managerName: string, options?: BackupsRestoreOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Parameters
- deviceName
-
string
The device name
- backupName
-
string
The backupSet name
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- BackupsRestoreOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRestoreAndWait(string, string, string, string, BackupsRestoreOptionalParams)
Restores the backup on the device.
function beginRestoreAndWait(deviceName: string, backupName: string, resourceGroupName: string, managerName: string, options?: BackupsRestoreOptionalParams): Promise<void>
Parameters
- deviceName
-
string
The device name
- backupName
-
string
The backupSet name
- resourceGroupName
-
string
The resource group name
- managerName
-
string
The manager name
- options
- BackupsRestoreOptionalParams
The options parameters.
Returns
Promise<void>
listByDevice(string, string, string, BackupsListByDeviceOptionalParams)
Retrieves all the backups in a device.
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
The options parameters.
Returns
Azure SDK for JavaScript