RecoveryServicesBackupClient class
- Extends
Constructors
| Recovery |
Initializes a new instance of the RecoveryServicesBackupClient class. |
Properties
Inherited Properties
| pipeline | The pipeline used by this client to make requests |
Methods
Inherited Methods
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
RecoveryServicesBackupClient(TokenCredential, string, RecoveryServicesBackupClientOptionalParams)
Initializes a new instance of the RecoveryServicesBackupClient class.
new RecoveryServicesBackupClient(credentials: TokenCredential, subscriptionId: string, options?: RecoveryServicesBackupClientOptionalParams)Parameters
- credentials
- TokenCredential
Subscription credentials which uniquely identify client subscription.
- subscriptionId
-
string
The subscription Id.
The parameter options
Property Details
$host
$host: stringProperty Value
string
apiVersion
apiVersion: stringProperty Value
string
backupEngines
backupJobs
backupOperationResults
backupOperationStatuses
backupPolicies
backupProtectableItems
backupProtectedItems
backupProtectionContainers
backupProtectionIntent
backupResourceEncryptionConfigs
backupResourceEncryptionConfigs: BackupResourceEncryptionConfigsProperty Value
backupResourceStorageConfigsNonCRR
backupResourceStorageConfigsNonCRR: BackupResourceStorageConfigsNonCRRProperty Value
backupResourceVaultConfigs
backups
backupStatus
backupUsageSummaries
backupWorkloadItems
bMSPrepareDataMoveOperationResult
bMSPrepareDataMoveOperationResult: BMSPrepareDataMoveOperationResultProperty Value
deletedProtectionContainers
exportJobsOperationResults
featureSupport
fetchTieringCost
getTieringCostOperationResult
getTieringCostOperationResult: GetTieringCostOperationResultProperty Value
itemLevelRecoveryConnections
itemLevelRecoveryConnections: ItemLevelRecoveryConnectionsProperty Value
jobCancellations
jobDetails
jobOperationResults
jobs
operation
operations
privateEndpointConnectionOperations
privateEndpointConnectionOperations: PrivateEndpointConnectionOperationsProperty Value
privateEndpointOperations
protectableContainers
protectedItemOperationResults
protectedItemOperationResults: ProtectedItemOperationResultsProperty Value
protectedItemOperationStatuses
protectedItemOperationStatuses: ProtectedItemOperationStatusesProperty Value
protectedItems
protectionContainerOperationResults
protectionContainerOperationResults: ProtectionContainerOperationResultsProperty Value
protectionContainerRefreshOperationResults
protectionContainerRefreshOperationResults: ProtectionContainerRefreshOperationResultsProperty Value
protectionContainers
protectionIntentOperations
protectionPolicies
protectionPolicyOperationResults
protectionPolicyOperationResults: ProtectionPolicyOperationResultsProperty Value
protectionPolicyOperationStatuses
protectionPolicyOperationStatuses: ProtectionPolicyOperationStatusesProperty Value
recoveryPoints
recoveryPointsRecommendedForMove
recoveryPointsRecommendedForMove: RecoveryPointsRecommendedForMoveProperty Value
resourceGuardProxies
resourceGuardProxy
restores
securityPINs
subscriptionId
subscriptionId: stringProperty Value
string
tieringCostOperationStatus
validateOperation
validateOperationResults
validateOperationStatuses
Inherited Property Details
pipeline
The pipeline used by this client to make requests
pipeline: PipelineProperty Value
Inherited From coreClient.ServiceClient.pipeline
Method Details
beginBMSPrepareDataMove(string, string, PrepareDataMoveRequest, BMSPrepareDataMoveOptionalParams)
Prepares source vault for Data Move operation
function beginBMSPrepareDataMove(vaultName: string, resourceGroupName: string, parameters: PrepareDataMoveRequest, options?: BMSPrepareDataMoveOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- parameters
- PrepareDataMoveRequest
Prepare data move request
- options
- BMSPrepareDataMoveOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginBMSPrepareDataMoveAndWait(string, string, PrepareDataMoveRequest, BMSPrepareDataMoveOptionalParams)
Prepares source vault for Data Move operation
function beginBMSPrepareDataMoveAndWait(vaultName: string, resourceGroupName: string, parameters: PrepareDataMoveRequest, options?: BMSPrepareDataMoveOptionalParams): Promise<void>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- parameters
- PrepareDataMoveRequest
Prepare data move request
- options
- BMSPrepareDataMoveOptionalParams
The options parameters.
Returns
Promise<void>
beginBMSTriggerDataMove(string, string, TriggerDataMoveRequest, BMSTriggerDataMoveOptionalParams)
Triggers Data Move Operation on target vault
function beginBMSTriggerDataMove(vaultName: string, resourceGroupName: string, parameters: TriggerDataMoveRequest, options?: BMSTriggerDataMoveOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- parameters
- TriggerDataMoveRequest
Trigger data move request
- options
- BMSTriggerDataMoveOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginBMSTriggerDataMoveAndWait(string, string, TriggerDataMoveRequest, BMSTriggerDataMoveOptionalParams)
Triggers Data Move Operation on target vault
function beginBMSTriggerDataMoveAndWait(vaultName: string, resourceGroupName: string, parameters: TriggerDataMoveRequest, options?: BMSTriggerDataMoveOptionalParams): Promise<void>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- parameters
- TriggerDataMoveRequest
Trigger data move request
- options
- BMSTriggerDataMoveOptionalParams
The options parameters.
Returns
Promise<void>
beginMoveRecoveryPoint(string, string, string, string, string, string, MoveRPAcrossTiersRequest, MoveRecoveryPointOptionalParams)
Move recovery point from one datastore to another store.
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
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- fabricName
-
string
- containerName
-
string
- protectedItemName
-
string
- recoveryPointId
-
string
- parameters
- MoveRPAcrossTiersRequest
Move Resource Across Tiers Request
- options
- MoveRecoveryPointOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginMoveRecoveryPointAndWait(string, string, string, string, string, string, MoveRPAcrossTiersRequest, MoveRecoveryPointOptionalParams)
Move recovery point from one datastore to another store.
function beginMoveRecoveryPointAndWait(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, protectedItemName: string, recoveryPointId: string, parameters: MoveRPAcrossTiersRequest, options?: MoveRecoveryPointOptionalParams): Promise<void>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- fabricName
-
string
- containerName
-
string
- protectedItemName
-
string
- recoveryPointId
-
string
- parameters
- MoveRPAcrossTiersRequest
Move Resource Across Tiers Request
- options
- MoveRecoveryPointOptionalParams
The options parameters.
Returns
Promise<void>
getOperationStatus(string, string, string, GetOperationStatusOptionalParams)
Fetches operation status for data move operation on vault
function getOperationStatus(vaultName: string, resourceGroupName: string, operationId: string, options?: GetOperationStatusOptionalParams): Promise<OperationStatus>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- operationId
-
string
- options
- GetOperationStatusOptionalParams
The options parameters.
Returns
Promise<OperationStatus>
Inherited Method Details
sendOperationRequest<T>(OperationArguments, OperationSpec)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>Parameters
- operationArguments
- OperationArguments
The arguments that the HTTP request's templated values will be populated from.
- operationSpec
- OperationSpec
The OperationSpec to use to populate the httpRequest.
Returns
Promise<T>
Inherited From coreClient.ServiceClient.sendOperationRequest
sendRequest(PipelineRequest)
Send the provided httpRequest.
function sendRequest(request: PipelineRequest): Promise<PipelineResponse>Parameters
- request
- PipelineRequest
Returns
Promise<PipelineResponse>
Inherited From coreClient.ServiceClient.sendRequest