RecoveryServicesBackupClient class

Package:

@azure/arm-recoveryservicesbackup

Constructors

RecoveryServicesBackupClient(TokenCredential, RecoveryServicesBackupClientOptionalParams)
RecoveryServicesBackupClient(TokenCredential, string, RecoveryServicesBackupClientOptionalParams)

Properties

backupEngines	The operation groups for backupEngines
backupJobs	The operation groups for backupJobs
backupOperationResults	The operation groups for backupOperationResults
backupOperationStatuses	The operation groups for backupOperationStatuses
backupPolicies	The operation groups for backupPolicies
backupProtectableItems	The operation groups for backupProtectableItems
backupProtectedItems	The operation groups for backupProtectedItems
backupProtectionContainers	The operation groups for backupProtectionContainers
backupProtectionIntent	The operation groups for backupProtectionIntent
backupResourceEncryptionConfigs	The operation groups for backupResourceEncryptionConfigs
backupResourceStorageConfigsNonCRR	The operation groups for backupResourceStorageConfigsNonCRR
backupResourceVaultConfigs	The operation groups for backupResourceVaultConfigs
backups	The operation groups for backups
backupStatus	The operation groups for backupStatus
backupUsageSummaries	The operation groups for backupUsageSummaries
backupWorkloadItems	The operation groups for backupWorkloadItems
bmsPrepareDataMoveOperationResult	The operation groups for bmsPrepareDataMoveOperationResult
deletedProtectionContainers	The operation groups for deletedProtectionContainers
exportJobsOperationResults	The operation groups for exportJobsOperationResults
featureSupport	The operation groups for featureSupport
fetchTieringCost	The operation groups for fetchTieringCost
getTieringCostOperationResult	The operation groups for getTieringCostOperationResult
itemLevelRecoveryConnections	The operation groups for itemLevelRecoveryConnections
jobCancellations	The operation groups for jobCancellations
jobDetails	The operation groups for jobDetails
jobOperationResults	The operation groups for jobOperationResults
jobs	The operation groups for jobs
operation	The operation groups for operation
operations	The operation groups for operations
pipeline	The pipeline used by this client to make requests
privateEndpoint	The operation groups for privateEndpoint
privateEndpointConnection	The operation groups for privateEndpointConnection
protectableContainers	The operation groups for protectableContainers
protectedItemOperationResults	The operation groups for protectedItemOperationResults
protectedItemOperationStatuses	The operation groups for protectedItemOperationStatuses
protectedItems	The operation groups for protectedItems
protectionContainerOperationResults	The operation groups for protectionContainerOperationResults
protectionContainerRefreshOperationResults	The operation groups for protectionContainerRefreshOperationResults
protectionContainers	The operation groups for protectionContainers
protectionIntent	The operation groups for protectionIntent
protectionPolicies	The operation groups for protectionPolicies
protectionPolicyOperationResults	The operation groups for protectionPolicyOperationResults
protectionPolicyOperationStatuses	The operation groups for protectionPolicyOperationStatuses
recoveryPoints	The operation groups for recoveryPoints
recoveryPointsRecommendedForMove	The operation groups for recoveryPointsRecommendedForMove
resourceGuardProxies	The operation groups for resourceGuardProxies
resourceGuardProxy	The operation groups for resourceGuardProxy
restores	The operation groups for restores
securityPINs	The operation groups for securityPINs
tieringCostOperationStatus	The operation groups for tieringCostOperationStatus
validateOperation	The operation groups for validateOperation
validateOperationResults	The operation groups for validateOperationResults
validateOperationStatuses	The operation groups for validateOperationStatuses

Methods

beginBmsPrepareDataMove(string, string, PrepareDataMoveRequest, BMSPrepareDataMoveOptionalParams)
beginBmsPrepareDataMoveAndWait(string, string, PrepareDataMoveRequest, BMSPrepareDataMoveOptionalParams)
beginBmsTriggerDataMove(string, string, TriggerDataMoveRequest, BMSTriggerDataMoveOptionalParams)
beginBmsTriggerDataMoveAndWait(string, string, TriggerDataMoveRequest, BMSTriggerDataMoveOptionalParams)
beginMoveRecoveryPoint(string, string, string, string, string, string, MoveRPAcrossTiersRequest, MoveRecoveryPointOptionalParams)
beginMoveRecoveryPointAndWait(string, string, string, string, string, string, MoveRPAcrossTiersRequest, MoveRecoveryPointOptionalParams)
bmsPrepareDataMove(string, string, PrepareDataMoveRequest, BMSPrepareDataMoveOptionalParams)	Prepares source vault for Data Move operation
bmsTriggerDataMove(string, string, TriggerDataMoveRequest, BMSTriggerDataMoveOptionalParams)	Triggers Data Move Operation on target vault
getOperationStatus(string, string, string, GetOperationStatusOptionalParams)	Fetches Operation Result for Prepare Data Move
moveRecoveryPoint(string, string, string, string, string, string, MoveRPAcrossTiersRequest, MoveRecoveryPointOptionalParams)	Move recovery point from one datastore to another store.

Constructor Details

RecoveryServicesBackupClient(TokenCredential, RecoveryServicesBackupClientOptionalParams)

new RecoveryServicesBackupClient(credential: TokenCredential, options?: RecoveryServicesBackupClientOptionalParams)

Parameters

credential

TokenCredential

options

RecoveryServicesBackupClientOptionalParams

RecoveryServicesBackupClient(TokenCredential, string, RecoveryServicesBackupClientOptionalParams)

new RecoveryServicesBackupClient(credential: TokenCredential, subscriptionId: string, options?: RecoveryServicesBackupClientOptionalParams)

Parameters

credential

TokenCredential

subscriptionId

string

options

RecoveryServicesBackupClientOptionalParams

Property Details

backupEngines

The operation groups for backupEngines

backupEngines: BackupEnginesOperations

Property Value

BackupEnginesOperations

backupJobs

The operation groups for backupJobs

backupJobs: BackupJobsOperations

Property Value

BackupJobsOperations

backupOperationResults

The operation groups for backupOperationResults

backupOperationResults: BackupOperationResultsOperations

Property Value

BackupOperationResultsOperations

backupOperationStatuses

The operation groups for backupOperationStatuses

backupOperationStatuses: BackupOperationStatusesOperations

Property Value

BackupOperationStatusesOperations

backupPolicies

The operation groups for backupPolicies

backupPolicies: BackupPoliciesOperations

Property Value

BackupPoliciesOperations

backupProtectableItems

The operation groups for backupProtectableItems

backupProtectableItems: BackupProtectableItemsOperations

Property Value

BackupProtectableItemsOperations

backupProtectedItems

The operation groups for backupProtectedItems

backupProtectedItems: BackupProtectedItemsOperations

Property Value

BackupProtectedItemsOperations

backupProtectionContainers

The operation groups for backupProtectionContainers

backupProtectionContainers: BackupProtectionContainersOperations

Property Value

BackupProtectionContainersOperations

backupProtectionIntent

The operation groups for backupProtectionIntent

backupProtectionIntent: BackupProtectionIntentOperations

Property Value

BackupProtectionIntentOperations

backupResourceEncryptionConfigs

The operation groups for backupResourceEncryptionConfigs

backupResourceEncryptionConfigs: BackupResourceEncryptionConfigsOperations

Property Value

BackupResourceEncryptionConfigsOperations

backupResourceStorageConfigsNonCRR

The operation groups for backupResourceStorageConfigsNonCRR

backupResourceStorageConfigsNonCRR: BackupResourceStorageConfigsNonCRROperations

Property Value

BackupResourceStorageConfigsNonCRROperations

backupResourceVaultConfigs

The operation groups for backupResourceVaultConfigs

backupResourceVaultConfigs: BackupResourceVaultConfigsOperations

Property Value

BackupResourceVaultConfigsOperations

backups

The operation groups for backups

backups: BackupsOperations

Property Value

BackupsOperations

backupStatus

The operation groups for backupStatus

backupStatus: BackupStatusOperations

Property Value

BackupStatusOperations

backupUsageSummaries

The operation groups for backupUsageSummaries

backupUsageSummaries: BackupUsageSummariesOperations

Property Value

BackupUsageSummariesOperations

backupWorkloadItems

The operation groups for backupWorkloadItems

backupWorkloadItems: BackupWorkloadItemsOperations

Property Value

BackupWorkloadItemsOperations

bmsPrepareDataMoveOperationResult

The operation groups for bmsPrepareDataMoveOperationResult

bmsPrepareDataMoveOperationResult: BMSPrepareDataMoveOperationResultOperations

Property Value

BMSPrepareDataMoveOperationResultOperations

deletedProtectionContainers

The operation groups for deletedProtectionContainers

deletedProtectionContainers: DeletedProtectionContainersOperations

Property Value

DeletedProtectionContainersOperations

exportJobsOperationResults

The operation groups for exportJobsOperationResults

exportJobsOperationResults: ExportJobsOperationResultsOperations

Property Value

ExportJobsOperationResultsOperations

featureSupport

The operation groups for featureSupport

featureSupport: FeatureSupportOperations

Property Value

FeatureSupportOperations

fetchTieringCost

The operation groups for fetchTieringCost

fetchTieringCost: FetchTieringCostOperations

Property Value

FetchTieringCostOperations

getTieringCostOperationResult

The operation groups for getTieringCostOperationResult

getTieringCostOperationResult: GetTieringCostOperationResultOperations

Property Value

GetTieringCostOperationResultOperations

itemLevelRecoveryConnections

The operation groups for itemLevelRecoveryConnections

itemLevelRecoveryConnections: ItemLevelRecoveryConnectionsOperations

Property Value

ItemLevelRecoveryConnectionsOperations

jobCancellations

The operation groups for jobCancellations

jobCancellations: JobCancellationsOperations

Property Value

JobCancellationsOperations

jobDetails

The operation groups for jobDetails

jobDetails: JobDetailsOperations

Property Value

JobDetailsOperations

jobOperationResults

The operation groups for jobOperationResults

jobOperationResults: JobOperationResultsOperations

Property Value

JobOperationResultsOperations

jobs

The operation groups for jobs

jobs: JobsOperations

Property Value

JobsOperations

operation

The operation groups for operation

operation: OperationOperations

Property Value

OperationOperations

operations

The operation groups for operations

operations: OperationsOperations

Property Value

OperationsOperations

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

privateEndpoint

The operation groups for privateEndpoint

privateEndpoint: PrivateEndpointOperations

Property Value

PrivateEndpointOperations

privateEndpointConnection

The operation groups for privateEndpointConnection

privateEndpointConnection: PrivateEndpointConnectionOperations

Property Value

PrivateEndpointConnectionOperations

protectableContainers

The operation groups for protectableContainers

protectableContainers: ProtectableContainersOperations

Property Value

ProtectableContainersOperations

protectedItemOperationResults

The operation groups for protectedItemOperationResults

protectedItemOperationResults: ProtectedItemOperationResultsOperations

Property Value

ProtectedItemOperationResultsOperations

protectedItemOperationStatuses

The operation groups for protectedItemOperationStatuses

protectedItemOperationStatuses: ProtectedItemOperationStatusesOperations

Property Value

ProtectedItemOperationStatusesOperations

protectedItems

The operation groups for protectedItems

protectedItems: ProtectedItemsOperations

Property Value

ProtectedItemsOperations

protectionContainerOperationResults

The operation groups for protectionContainerOperationResults

protectionContainerOperationResults: ProtectionContainerOperationResultsOperations

Property Value

ProtectionContainerOperationResultsOperations

protectionContainerRefreshOperationResults

The operation groups for protectionContainerRefreshOperationResults

protectionContainerRefreshOperationResults: ProtectionContainerRefreshOperationResultsOperations

Property Value

ProtectionContainerRefreshOperationResultsOperations

protectionContainers

The operation groups for protectionContainers

protectionContainers: ProtectionContainersOperations

Property Value

ProtectionContainersOperations

protectionIntent

The operation groups for protectionIntent

protectionIntent: ProtectionIntentOperations

Property Value

ProtectionIntentOperations

protectionPolicies

The operation groups for protectionPolicies

protectionPolicies: ProtectionPoliciesOperations

Property Value

ProtectionPoliciesOperations

protectionPolicyOperationResults

The operation groups for protectionPolicyOperationResults

protectionPolicyOperationResults: ProtectionPolicyOperationResultsOperations

Property Value

ProtectionPolicyOperationResultsOperations

protectionPolicyOperationStatuses

The operation groups for protectionPolicyOperationStatuses

protectionPolicyOperationStatuses: ProtectionPolicyOperationStatusesOperations

Property Value

ProtectionPolicyOperationStatusesOperations

recoveryPoints

The operation groups for recoveryPoints

recoveryPoints: RecoveryPointsOperations

Property Value

RecoveryPointsOperations

recoveryPointsRecommendedForMove

The operation groups for recoveryPointsRecommendedForMove

recoveryPointsRecommendedForMove: RecoveryPointsRecommendedForMoveOperations

Property Value

RecoveryPointsRecommendedForMoveOperations

resourceGuardProxies

The operation groups for resourceGuardProxies

resourceGuardProxies: ResourceGuardProxiesOperations

Property Value

ResourceGuardProxiesOperations

resourceGuardProxy

The operation groups for resourceGuardProxy

resourceGuardProxy: ResourceGuardProxyOperations

Property Value

ResourceGuardProxyOperations

restores

The operation groups for restores

restores: RestoresOperations

Property Value

RestoresOperations

securityPINs

The operation groups for securityPINs

securityPINs: SecurityPINsOperations

Property Value

SecurityPINsOperations

tieringCostOperationStatus

The operation groups for tieringCostOperationStatus

tieringCostOperationStatus: TieringCostOperationStatusOperations

Property Value

TieringCostOperationStatusOperations

validateOperation

The operation groups for validateOperation

validateOperation: ValidateOperationOperations

Property Value

ValidateOperationOperations

validateOperationResults

The operation groups for validateOperationResults

validateOperationResults: ValidateOperationResultsOperations

Property Value

ValidateOperationResultsOperations

validateOperationStatuses

The operation groups for validateOperationStatuses

validateOperationStatuses: ValidateOperationStatusesOperations

Property Value

ValidateOperationStatusesOperations

Method Details

beginBmsPrepareDataMove(string, string, PrepareDataMoveRequest, BMSPrepareDataMoveOptionalParams)

Warning

This API is now deprecated.

use bmsPrepareDataMove instead

function beginBmsPrepareDataMove(vaultName: string, resourceGroupName: string, parameters: PrepareDataMoveRequest, options?: BMSPrepareDataMoveOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

vaultName

string

resourceGroupName

string

parameters

PrepareDataMoveRequest

options

BMSPrepareDataMoveOptionalParams

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginBmsPrepareDataMoveAndWait(string, string, PrepareDataMoveRequest, BMSPrepareDataMoveOptionalParams)

Warning

This API is now deprecated.

use bmsPrepareDataMove instead

function beginBmsPrepareDataMoveAndWait(vaultName: string, resourceGroupName: string, parameters: PrepareDataMoveRequest, options?: BMSPrepareDataMoveOptionalParams): Promise<void>

Parameters

vaultName

string

resourceGroupName

string

parameters

PrepareDataMoveRequest

options

BMSPrepareDataMoveOptionalParams

Returns

Promise<void>

beginBmsTriggerDataMove(string, string, TriggerDataMoveRequest, BMSTriggerDataMoveOptionalParams)

Warning

This API is now deprecated.

use bmsTriggerDataMove instead

function beginBmsTriggerDataMove(vaultName: string, resourceGroupName: string, parameters: TriggerDataMoveRequest, options?: BMSTriggerDataMoveOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

vaultName

string

resourceGroupName

string

parameters

TriggerDataMoveRequest

options

BMSTriggerDataMoveOptionalParams

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginBmsTriggerDataMoveAndWait(string, string, TriggerDataMoveRequest, BMSTriggerDataMoveOptionalParams)

Warning

This API is now deprecated.

use bmsTriggerDataMove instead

function beginBmsTriggerDataMoveAndWait(vaultName: string, resourceGroupName: string, parameters: TriggerDataMoveRequest, options?: BMSTriggerDataMoveOptionalParams): Promise<void>

Parameters

vaultName

string

resourceGroupName

string

parameters

TriggerDataMoveRequest

options

BMSTriggerDataMoveOptionalParams

Returns

Promise<void>

beginMoveRecoveryPoint(string, string, string, string, string, string, MoveRPAcrossTiersRequest, MoveRecoveryPointOptionalParams)

Warning

This API is now deprecated.

use moveRecoveryPoint instead

function beginMoveRecoveryPoint(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, protectedItemName: string, recoveryPointId: string, parameters: MoveRPAcrossTiersRequest, options?: MoveRecoveryPointOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

vaultName

string

resourceGroupName

string

fabricName

string

containerName

string

protectedItemName

string

recoveryPointId

string

parameters

MoveRPAcrossTiersRequest

options

MoveRecoveryPointOptionalParams

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginMoveRecoveryPointAndWait(string, string, string, string, string, string, MoveRPAcrossTiersRequest, MoveRecoveryPointOptionalParams)

Warning

This API is now deprecated.

use moveRecoveryPoint instead

function beginMoveRecoveryPointAndWait(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, protectedItemName: string, recoveryPointId: string, parameters: MoveRPAcrossTiersRequest, options?: MoveRecoveryPointOptionalParams): Promise<void>

Parameters

vaultName

string

resourceGroupName

string

fabricName

string

containerName

string

protectedItemName

string

recoveryPointId

string

parameters

MoveRPAcrossTiersRequest

options

MoveRecoveryPointOptionalParams

Returns

Promise<void>

bmsPrepareDataMove(string, string, PrepareDataMoveRequest, BMSPrepareDataMoveOptionalParams)

Prepares source vault for Data Move operation

function bmsPrepareDataMove(vaultName: string, resourceGroupName: string, parameters: PrepareDataMoveRequest, options?: BMSPrepareDataMoveOptionalParams): PollerLike<OperationState<void>, void>

Parameters

vaultName

string

resourceGroupName

string

parameters

PrepareDataMoveRequest

options

BMSPrepareDataMoveOptionalParams

Returns

PollerLike<OperationState<void>, void>

bmsTriggerDataMove(string, string, TriggerDataMoveRequest, BMSTriggerDataMoveOptionalParams)

Triggers Data Move Operation on target vault

function bmsTriggerDataMove(vaultName: string, resourceGroupName: string, parameters: TriggerDataMoveRequest, options?: BMSTriggerDataMoveOptionalParams): PollerLike<OperationState<void>, void>

Parameters

vaultName

string

resourceGroupName

string

parameters

TriggerDataMoveRequest

options

BMSTriggerDataMoveOptionalParams

Returns

PollerLike<OperationState<void>, void>

getOperationStatus(string, string, string, GetOperationStatusOptionalParams)

Fetches Operation Result for Prepare Data Move

function getOperationStatus(vaultName: string, resourceGroupName: string, operationId: string, options?: GetOperationStatusOptionalParams): Promise<OperationStatus>

Parameters

vaultName

string

resourceGroupName

string

operationId

string

options

GetOperationStatusOptionalParams

Returns

Promise<OperationStatus>

moveRecoveryPoint(string, string, string, string, string, string, MoveRPAcrossTiersRequest, MoveRecoveryPointOptionalParams)

Move recovery point from one datastore to another store.

function moveRecoveryPoint(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, protectedItemName: string, recoveryPointId: string, parameters: MoveRPAcrossTiersRequest, options?: MoveRecoveryPointOptionalParams): PollerLike<OperationState<void>, void>

Parameters

vaultName

string

resourceGroupName

string

fabricName

string

containerName

string

protectedItemName

string

recoveryPointId

string

parameters

MoveRPAcrossTiersRequest

options

MoveRecoveryPointOptionalParams

Returns

PollerLike<OperationState<void>, void>