BackupPolicies interface

Interface representing a BackupPolicies.

Methods

beginBackupNow(string, string, string, string, string, BackupPoliciesBackupNowOptionalParams)

Backup the backup policy now.

beginBackupNowAndWait(string, string, string, string, string, BackupPoliciesBackupNowOptionalParams)

Backup the backup policy now.

beginCreateOrUpdate(string, string, string, string, BackupPolicy, BackupPoliciesCreateOrUpdateOptionalParams)

Creates or updates the backup policy.

beginCreateOrUpdateAndWait(string, string, string, string, BackupPolicy, BackupPoliciesCreateOrUpdateOptionalParams)

Creates or updates the backup policy.

beginDelete(string, string, string, string, BackupPoliciesDeleteOptionalParams)

Deletes the backup policy.

beginDeleteAndWait(string, string, string, string, BackupPoliciesDeleteOptionalParams)

Deletes the backup policy.

get(string, string, string, string, BackupPoliciesGetOptionalParams)

Gets the properties of the specified backup policy name.

listByDevice(string, string, string, BackupPoliciesListByDeviceOptionalParams)

Gets all the backup policies in a device.

Method Details

beginBackupNow(string, string, string, string, string, BackupPoliciesBackupNowOptionalParams)

Backup the backup policy now.

function beginBackupNow(deviceName: string, backupPolicyName: string, backupType: string, resourceGroupName: string, managerName: string, options?: BackupPoliciesBackupNowOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name

backupPolicyName

string

The backup policy name.

backupType

string

The backup Type. This can be cloudSnapshot or localSnapshot.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupPoliciesBackupNowOptionalParams

The options parameters.

Returns

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

beginBackupNowAndWait(string, string, string, string, string, BackupPoliciesBackupNowOptionalParams)

Backup the backup policy now.

function beginBackupNowAndWait(deviceName: string, backupPolicyName: string, backupType: string, resourceGroupName: string, managerName: string, options?: BackupPoliciesBackupNowOptionalParams): Promise<void>

Parameters

deviceName

string

The device name

backupPolicyName

string

The backup policy name.

backupType

string

The backup Type. This can be cloudSnapshot or localSnapshot.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupPoliciesBackupNowOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, string, string, BackupPolicy, BackupPoliciesCreateOrUpdateOptionalParams)

Creates or updates the backup policy.

function beginCreateOrUpdate(deviceName: string, backupPolicyName: string, resourceGroupName: string, managerName: string, parameters: BackupPolicy, options?: BackupPoliciesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<BackupPolicy>, BackupPolicy>>

Parameters

deviceName

string

The device name

backupPolicyName

string

The name of the backup policy to be created/updated.

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
BackupPolicy

The backup policy.

options
BackupPoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, string, BackupPolicy, BackupPoliciesCreateOrUpdateOptionalParams)

Creates or updates the backup policy.

function beginCreateOrUpdateAndWait(deviceName: string, backupPolicyName: string, resourceGroupName: string, managerName: string, parameters: BackupPolicy, options?: BackupPoliciesCreateOrUpdateOptionalParams): Promise<BackupPolicy>

Parameters

deviceName

string

The device name

backupPolicyName

string

The name of the backup policy to be created/updated.

resourceGroupName

string

The resource group name

managerName

string

The manager name

parameters
BackupPolicy

The backup policy.

options
BackupPoliciesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<BackupPolicy>

beginDelete(string, string, string, string, BackupPoliciesDeleteOptionalParams)

Deletes the backup policy.

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

Parameters

deviceName

string

The device name

backupPolicyName

string

The name of the backup policy.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupPoliciesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, BackupPoliciesDeleteOptionalParams)

Deletes the backup policy.

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

Parameters

deviceName

string

The device name

backupPolicyName

string

The name of the backup policy.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupPoliciesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, BackupPoliciesGetOptionalParams)

Gets the properties of the specified backup policy name.

function get(deviceName: string, backupPolicyName: string, resourceGroupName: string, managerName: string, options?: BackupPoliciesGetOptionalParams): Promise<BackupPolicy>

Parameters

deviceName

string

The device name

backupPolicyName

string

The name of backup policy to be fetched.

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupPoliciesGetOptionalParams

The options parameters.

Returns

Promise<BackupPolicy>

listByDevice(string, string, string, BackupPoliciesListByDeviceOptionalParams)

Gets all the backup policies in a device.

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

Parameters

deviceName

string

The device name

resourceGroupName

string

The resource group name

managerName

string

The manager name

options
BackupPoliciesListByDeviceOptionalParams

The options parameters.

Returns