ReplicationRecoveryPlans interface
Interface representing a ReplicationRecoveryPlans.
Methods
Method Details
beginCreate(string, string, string, CreateRecoveryPlanInput, ReplicationRecoveryPlansCreateOptionalParams)
The operation to create a recovery plan.
function beginCreate(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: CreateRecoveryPlanInput, options?: ReplicationRecoveryPlansCreateOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
- input
- CreateRecoveryPlanInput
Recovery Plan creation input.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginCreateAndWait(string, string, string, CreateRecoveryPlanInput, ReplicationRecoveryPlansCreateOptionalParams)
The operation to create a recovery plan.
function beginCreateAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: CreateRecoveryPlanInput, options?: ReplicationRecoveryPlansCreateOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
- input
- CreateRecoveryPlanInput
Recovery Plan creation input.
The options parameters.
Returns
Promise<RecoveryPlan>
beginDelete(string, string, string, ReplicationRecoveryPlansDeleteOptionalParams)
Delete a recovery plan.
function beginDelete(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ReplicationRecoveryPlansDeleteOptionalParams)
Delete a recovery plan.
function beginDeleteAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansDeleteOptionalParams): Promise<void>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
The options parameters.
Returns
Promise<void>
beginFailoverCancel(string, string, string, ReplicationRecoveryPlansFailoverCancelOptionalParams)
The operation to cancel the failover of a recovery plan.
function beginFailoverCancel(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansFailoverCancelOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginFailoverCancelAndWait(string, string, string, ReplicationRecoveryPlansFailoverCancelOptionalParams)
The operation to cancel the failover of a recovery plan.
function beginFailoverCancelAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansFailoverCancelOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
The options parameters.
Returns
Promise<RecoveryPlan>
beginFailoverCommit(string, string, string, ReplicationRecoveryPlansFailoverCommitOptionalParams)
The operation to commit the failover of a recovery plan.
function beginFailoverCommit(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansFailoverCommitOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginFailoverCommitAndWait(string, string, string, ReplicationRecoveryPlansFailoverCommitOptionalParams)
The operation to commit the failover of a recovery plan.
function beginFailoverCommitAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansFailoverCommitOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
The options parameters.
Returns
Promise<RecoveryPlan>
beginPlannedFailover(string, string, string, RecoveryPlanPlannedFailoverInput, ReplicationRecoveryPlansPlannedFailoverOptionalParams)
The operation to start the planned failover of a recovery plan.
function beginPlannedFailover(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: RecoveryPlanPlannedFailoverInput, options?: ReplicationRecoveryPlansPlannedFailoverOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
Failover input.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginPlannedFailoverAndWait(string, string, string, RecoveryPlanPlannedFailoverInput, ReplicationRecoveryPlansPlannedFailoverOptionalParams)
The operation to start the planned failover of a recovery plan.
function beginPlannedFailoverAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: RecoveryPlanPlannedFailoverInput, options?: ReplicationRecoveryPlansPlannedFailoverOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
Failover input.
The options parameters.
Returns
Promise<RecoveryPlan>
beginReprotect(string, string, string, ReplicationRecoveryPlansReprotectOptionalParams)
The operation to reprotect(reverse replicate) a recovery plan.
function beginReprotect(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansReprotectOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginReprotectAndWait(string, string, string, ReplicationRecoveryPlansReprotectOptionalParams)
The operation to reprotect(reverse replicate) a recovery plan.
function beginReprotectAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansReprotectOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
The options parameters.
Returns
Promise<RecoveryPlan>
beginTestFailover(string, string, string, RecoveryPlanTestFailoverInput, ReplicationRecoveryPlansTestFailoverOptionalParams)
The operation to start the test failover of a recovery plan.
function beginTestFailover(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: RecoveryPlanTestFailoverInput, options?: ReplicationRecoveryPlansTestFailoverOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
Recovery plan test failover input.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginTestFailoverAndWait(string, string, string, RecoveryPlanTestFailoverInput, ReplicationRecoveryPlansTestFailoverOptionalParams)
The operation to start the test failover of a recovery plan.
function beginTestFailoverAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: RecoveryPlanTestFailoverInput, options?: ReplicationRecoveryPlansTestFailoverOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
Recovery plan test failover input.
The options parameters.
Returns
Promise<RecoveryPlan>
beginTestFailoverCleanup(string, string, string, RecoveryPlanTestFailoverCleanupInput, ReplicationRecoveryPlansTestFailoverCleanupOptionalParams)
The operation to cleanup test failover of a recovery plan.
function beginTestFailoverCleanup(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: RecoveryPlanTestFailoverCleanupInput, options?: ReplicationRecoveryPlansTestFailoverCleanupOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
Recovery plan test failover cleanup input.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginTestFailoverCleanupAndWait(string, string, string, RecoveryPlanTestFailoverCleanupInput, ReplicationRecoveryPlansTestFailoverCleanupOptionalParams)
The operation to cleanup test failover of a recovery plan.
function beginTestFailoverCleanupAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: RecoveryPlanTestFailoverCleanupInput, options?: ReplicationRecoveryPlansTestFailoverCleanupOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
Recovery plan test failover cleanup input.
The options parameters.
Returns
Promise<RecoveryPlan>
beginUnplannedFailover(string, string, string, RecoveryPlanUnplannedFailoverInput, ReplicationRecoveryPlansUnplannedFailoverOptionalParams)
The operation to start the unplanned failover of a recovery plan.
function beginUnplannedFailover(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: RecoveryPlanUnplannedFailoverInput, options?: ReplicationRecoveryPlansUnplannedFailoverOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
Recovery plan unplanned failover input.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginUnplannedFailoverAndWait(string, string, string, RecoveryPlanUnplannedFailoverInput, ReplicationRecoveryPlansUnplannedFailoverOptionalParams)
The operation to start the unplanned failover of a recovery plan.
function beginUnplannedFailoverAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: RecoveryPlanUnplannedFailoverInput, options?: ReplicationRecoveryPlansUnplannedFailoverOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
Recovery plan unplanned failover input.
The options parameters.
Returns
Promise<RecoveryPlan>
beginUpdate(string, string, string, UpdateRecoveryPlanInput, ReplicationRecoveryPlansUpdateOptionalParams)
The operation to update a recovery plan.
function beginUpdate(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: UpdateRecoveryPlanInput, options?: ReplicationRecoveryPlansUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
- input
- UpdateRecoveryPlanInput
Update recovery plan input.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
beginUpdateAndWait(string, string, string, UpdateRecoveryPlanInput, ReplicationRecoveryPlansUpdateOptionalParams)
The operation to update a recovery plan.
function beginUpdateAndWait(resourceName: string, resourceGroupName: string, recoveryPlanName: string, input: UpdateRecoveryPlanInput, options?: ReplicationRecoveryPlansUpdateOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Recovery plan name.
- input
- UpdateRecoveryPlanInput
Update recovery plan input.
The options parameters.
Returns
Promise<RecoveryPlan>
get(string, string, string, ReplicationRecoveryPlansGetOptionalParams)
Gets the details of the recovery plan.
function get(resourceName: string, resourceGroupName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansGetOptionalParams): Promise<RecoveryPlan>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- recoveryPlanName
-
string
Name of the recovery plan.
The options parameters.
Returns
Promise<RecoveryPlan>
list(string, string, ReplicationRecoveryPlansListOptionalParams)
Lists the recovery plans in the vault.
function list(resourceName: string, resourceGroupName: string, options?: ReplicationRecoveryPlansListOptionalParams): PagedAsyncIterableIterator<RecoveryPlan, RecoveryPlan[], PageSettings>Parameters
- resourceName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
The options parameters.