Package version:

Interface ReplicationRecoveryPlans

Interface representing a ReplicationRecoveryPlans.

interface ReplicationRecoveryPlans {
    beginCreate(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: CreateRecoveryPlanInput, options?: ReplicationRecoveryPlansCreateOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginCreateAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: CreateRecoveryPlanInput, options?: ReplicationRecoveryPlansCreateOptionalParams): Promise<RecoveryPlan>;
    beginDelete(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansDeleteOptionalParams): Promise<void>;
    beginFailoverCancel(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansFailoverCancelOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginFailoverCancelAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansFailoverCancelOptionalParams): Promise<RecoveryPlan>;
    beginFailoverCommit(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansFailoverCommitOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginFailoverCommitAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansFailoverCommitOptionalParams): Promise<RecoveryPlan>;
    beginPlannedFailover(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: RecoveryPlanPlannedFailoverInput, options?: ReplicationRecoveryPlansPlannedFailoverOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginPlannedFailoverAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: RecoveryPlanPlannedFailoverInput, options?: ReplicationRecoveryPlansPlannedFailoverOptionalParams): Promise<RecoveryPlan>;
    beginReprotect(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansReprotectOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginReprotectAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansReprotectOptionalParams): Promise<RecoveryPlan>;
    beginTestFailover(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: RecoveryPlanTestFailoverInput, options?: ReplicationRecoveryPlansTestFailoverOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginTestFailoverAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: RecoveryPlanTestFailoverInput, options?: ReplicationRecoveryPlansTestFailoverOptionalParams): Promise<RecoveryPlan>;
    beginTestFailoverCleanup(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: RecoveryPlanTestFailoverCleanupInput, options?: ReplicationRecoveryPlansTestFailoverCleanupOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginTestFailoverCleanupAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: RecoveryPlanTestFailoverCleanupInput, options?: ReplicationRecoveryPlansTestFailoverCleanupOptionalParams): Promise<RecoveryPlan>;
    beginUnplannedFailover(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: RecoveryPlanUnplannedFailoverInput, options?: ReplicationRecoveryPlansUnplannedFailoverOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginUnplannedFailoverAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: RecoveryPlanUnplannedFailoverInput, options?: ReplicationRecoveryPlansUnplannedFailoverOptionalParams): Promise<RecoveryPlan>;
    beginUpdate(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: UpdateRecoveryPlanInput, options?: ReplicationRecoveryPlansUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>;
    beginUpdateAndWait(resourceGroupName: string, resourceName: string, recoveryPlanName: string, input: UpdateRecoveryPlanInput, options?: ReplicationRecoveryPlansUpdateOptionalParams): Promise<RecoveryPlan>;
    get(resourceGroupName: string, resourceName: string, recoveryPlanName: string, options?: ReplicationRecoveryPlansGetOptionalParams): Promise<RecoveryPlan>;
    list(resourceGroupName: string, resourceName: string, options?: ReplicationRecoveryPlansListOptionalParams): PagedAsyncIterableIterator<RecoveryPlan>;
}

Methods

beginCreate

beginCreate(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to create a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: CreateRecoveryPlanInput
  Recovery Plan creation input.
- Optionaloptions: ReplicationRecoveryPlansCreateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:81

beginCreateAndWait

beginCreateAndWait(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<RecoveryPlan>
The operation to create a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: CreateRecoveryPlanInput
  Recovery Plan creation input.
- Optionaloptions: ReplicationRecoveryPlansCreateOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:102

beginDelete

beginDelete(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<SimplePollerLike<OperationState<void>, void>>
Delete a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- Optionaloptions: ReplicationRecoveryPlansDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:117

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<void>
Delete a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- Optionaloptions: ReplicationRecoveryPlansDeleteOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:131

beginFailoverCancel

beginFailoverCancel(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to cancel the failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- Optionaloptions: ReplicationRecoveryPlansFailoverCancelOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:182

beginFailoverCancelAndWait

beginFailoverCancelAndWait(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<RecoveryPlan>
The operation to cancel the failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- Optionaloptions: ReplicationRecoveryPlansFailoverCancelOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:201

beginFailoverCommit

beginFailoverCommit(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to commit the failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- Optionaloptions: ReplicationRecoveryPlansFailoverCommitOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:215

beginFailoverCommitAndWait

beginFailoverCommitAndWait(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<RecoveryPlan>
The operation to commit the failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- Optionaloptions: ReplicationRecoveryPlansFailoverCommitOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:234

beginPlannedFailover

beginPlannedFailover(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to start the planned failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: RecoveryPlanPlannedFailoverInput
  Failover input.
- Optionaloptions: ReplicationRecoveryPlansPlannedFailoverOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:249

beginPlannedFailoverAndWait

beginPlannedFailoverAndWait(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<RecoveryPlan>
The operation to start the planned failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: RecoveryPlanPlannedFailoverInput
  Failover input.
- Optionaloptions: ReplicationRecoveryPlansPlannedFailoverOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:270

beginReprotect

beginReprotect(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to reprotect(reverse replicate) a recovery plan. This api is for deprecated scenarios and no longer works.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- Optionaloptions: ReplicationRecoveryPlansReprotectOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:286

beginReprotectAndWait

beginReprotectAndWait(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<RecoveryPlan>
The operation to reprotect(reverse replicate) a recovery plan. This api is for deprecated scenarios and no longer works.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- Optionaloptions: ReplicationRecoveryPlansReprotectOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:306

beginTestFailover

beginTestFailover(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to start the test failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: RecoveryPlanTestFailoverInput
  Recovery plan test failover input.
- Optionaloptions: ReplicationRecoveryPlansTestFailoverOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:321

beginTestFailoverAndWait

beginTestFailoverAndWait(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<RecoveryPlan>
The operation to start the test failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: RecoveryPlanTestFailoverInput
  Recovery plan test failover input.
- Optionaloptions: ReplicationRecoveryPlansTestFailoverOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:342

beginTestFailoverCleanup

beginTestFailoverCleanup(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to cleanup test failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: RecoveryPlanTestFailoverCleanupInput
  Recovery plan test failover cleanup input.
- Optionaloptions: ReplicationRecoveryPlansTestFailoverCleanupOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:358

beginTestFailoverCleanupAndWait

beginTestFailoverCleanupAndWait(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<RecoveryPlan>
The operation to cleanup test failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: RecoveryPlanTestFailoverCleanupInput
  Recovery plan test failover cleanup input.
- Optionaloptions: ReplicationRecoveryPlansTestFailoverCleanupOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:379

beginUnplannedFailover

beginUnplannedFailover(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to start the unplanned failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: RecoveryPlanUnplannedFailoverInput
  Recovery plan unplanned failover input.
- Optionaloptions: ReplicationRecoveryPlansUnplannedFailoverOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:395

beginUnplannedFailoverAndWait

beginUnplannedFailoverAndWait(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<RecoveryPlan>
The operation to start the unplanned failover of a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: RecoveryPlanUnplannedFailoverInput
  Recovery plan unplanned failover input.
- Optionaloptions: ReplicationRecoveryPlansUnplannedFailoverOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:416

beginUpdate

beginUpdate(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
The operation to update a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: UpdateRecoveryPlanInput
  Update recovery plan input.
- Optionaloptions: ReplicationRecoveryPlansUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:146

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, resourceName, recoveryPlanName, input, options?): Promise<RecoveryPlan>
The operation to update a recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Recovery plan name.
- input: UpdateRecoveryPlanInput
  Update recovery plan input.
- Optionaloptions: ReplicationRecoveryPlansUpdateOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:167

get

get(resourceGroupName, resourceName, recoveryPlanName, options?): Promise<RecoveryPlan>
Gets the details of the recovery plan.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- recoveryPlanName: string
  Name of the recovery plan.
- Optionaloptions: ReplicationRecoveryPlansGetOptionalParams
  The options parameters.
Returns Promise<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:66

list

list(resourceGroupName, resourceName, options?): PagedAsyncIterableIterator<RecoveryPlan>
Lists the recovery plans in the vault.
Parameters
- resourceGroupName: string
  The name of the resource group where the recovery services vault is present.
- resourceName: string
  The name of the recovery services vault.
- Optionaloptions: ReplicationRecoveryPlansListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<RecoveryPlan>
- Defined in operationsInterfaces/replicationRecoveryPlans.ts:53

Interface ReplicationRecoveryPlans

Index

Methods

Methods

beginCreate

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginCreateAndWait

Parameters

Returns Promise<RecoveryPlan>

beginDelete

Parameters

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

beginDeleteAndWait

Parameters

Returns Promise<void>

beginFailoverCancel

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginFailoverCancelAndWait

Parameters

Returns Promise<RecoveryPlan>

beginFailoverCommit

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginFailoverCommitAndWait

Parameters

Returns Promise<RecoveryPlan>

beginPlannedFailover

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginPlannedFailoverAndWait

Parameters

Returns Promise<RecoveryPlan>

beginReprotect

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginReprotectAndWait

Parameters

Returns Promise<RecoveryPlan>

beginTestFailover

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginTestFailoverAndWait

Parameters

Returns Promise<RecoveryPlan>

beginTestFailoverCleanup

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginTestFailoverCleanupAndWait

Parameters

Returns Promise<RecoveryPlan>

beginUnplannedFailover

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginUnplannedFailoverAndWait

Parameters

Returns Promise<RecoveryPlan>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<RecoveryPlan>, RecoveryPlan>>

beginUpdateAndWait

Parameters

Returns Promise<RecoveryPlan>

get

Parameters

Returns Promise<RecoveryPlan>

list

Parameters

Returns PagedAsyncIterableIterator<RecoveryPlan>

Settings