ReplicationRecoveryPlans | @azure/arm-recoveryservices-siterecovery

Class representing a ReplicationRecoveryPlans.

Hierarchy

ReplicationRecoveryPlans

Constructors

constructor

new ReplicationRecoveryPlans(client: SiteRecoveryManagementClientContext): ReplicationRecoveryPlans

- Defined in operations/replicationRecoveryPlans.ts:20
Create a ReplicationRecoveryPlans.

Parameters
- client: SiteRecoveryManagementClientContext
  
  Reference to the service client.
Returns ReplicationRecoveryPlans

Methods

beginCreate

beginCreate(recoveryPlanName: string, input: CreateRecoveryPlanInput, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:206
The operation to create a recovery plan.

summary

Creates a recovery plan with the given details.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: CreateRecoveryPlanInput
  
  Recovery Plan creation input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(recoveryPlanName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:224
Delete a recovery plan.

summary

Deletes the specified recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginFailoverCommit

beginFailoverCommit(recoveryPlanName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:260
The operation to commit the fail over of a recovery plan.

summary

Execute commit failover of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginPlannedFailover

beginPlannedFailover(recoveryPlanName: string, input: RecoveryPlanPlannedFailoverInput, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:278
The operation to start the planned failover of a recovery plan.

summary

Execute planned failover of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: RecoveryPlanPlannedFailoverInput
  
  Failover input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginReprotect

beginReprotect(recoveryPlanName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:296
The operation to reprotect(reverse replicate) a recovery plan.

summary

Execute reprotect of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginTestFailover

beginTestFailover(recoveryPlanName: string, input: RecoveryPlanTestFailoverInput, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:314
The operation to start the test failover of a recovery plan.

summary

Execute test failover of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: RecoveryPlanTestFailoverInput
  
  Failover input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginTestFailoverCleanup

beginTestFailoverCleanup(recoveryPlanName: string, input: RecoveryPlanTestFailoverCleanupInput, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:333
The operation to cleanup test failover of a recovery plan.

summary

Execute test failover cleanup of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: RecoveryPlanTestFailoverCleanupInput
  
  Test failover cleanup input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUnplannedFailover

beginUnplannedFailover(recoveryPlanName: string, input: RecoveryPlanUnplannedFailoverInput, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:352
The operation to start the failover of a recovery plan.

summary

Execute unplanned failover of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: RecoveryPlanUnplannedFailoverInput
  
  Failover input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdate

beginUpdate(recoveryPlanName: string, input: UpdateRecoveryPlanInput, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/replicationRecoveryPlans.ts:242
The operation to update a recovery plan.

summary

Updates the given recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: UpdateRecoveryPlanInput
  
  Update recovery plan input
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

create

create(recoveryPlanName: string, input: CreateRecoveryPlanInput, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansCreateResponse>

- Defined in operations/replicationRecoveryPlans.ts:92
The operation to create a recovery plan.

summary

Creates a recovery plan with the given details.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: CreateRecoveryPlanInput
  
  Recovery Plan creation input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansCreateResponse>

Promise<Models.ReplicationRecoveryPlansCreateResponse>

deleteMethod

deleteMethod(recoveryPlanName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/replicationRecoveryPlans.ts:104
Delete a recovery plan.

summary

Deletes the specified recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

failoverCommit

failoverCommit(recoveryPlanName: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansFailoverCommitResponse>

- Defined in operations/replicationRecoveryPlans.ts:129
The operation to commit the fail over of a recovery plan.

summary

Execute commit failover of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansFailoverCommitResponse>

Promise<Models.ReplicationRecoveryPlansFailoverCommitResponse>

get

get(recoveryPlanName: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansGetResponse>
get(recoveryPlanName: string, callback: msRest.ServiceCallback<RecoveryPlan>): void
get(recoveryPlanName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryPlan>): void

- Defined in operations/replicationRecoveryPlans.ts:62
Gets the details of the recovery plan.

summary

Gets the requested recovery plan.

Parameters
- recoveryPlanName: string
  
  Name of the recovery plan.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansGetResponse>

Promise<Models.ReplicationRecoveryPlansGetResponse>
- Defined in operations/replicationRecoveryPlans.ts:67
Parameters
- recoveryPlanName: string
  
  Name of the recovery plan.
- callback: msRest.ServiceCallback<RecoveryPlan>
  
  The callback
Returns void
- Defined in operations/replicationRecoveryPlans.ts:73
Parameters
- recoveryPlanName: string
  
  Name of the recovery plan.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RecoveryPlan>
  
  The callback
Returns void

list

list(options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansListResponse>
list(callback: msRest.ServiceCallback<RecoveryPlanCollection>): void
list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryPlanCollection>): void

- Defined in operations/replicationRecoveryPlans.ts:36
Lists the recovery plans in the vault.

summary

Gets the list of recovery plans.

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansListResponse>

Promise<Models.ReplicationRecoveryPlansListResponse>
- Defined in operations/replicationRecoveryPlans.ts:40
Parameters
- callback: msRest.ServiceCallback<RecoveryPlanCollection>
  
  The callback
Returns void
- Defined in operations/replicationRecoveryPlans.ts:45
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RecoveryPlanCollection>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<RecoveryPlanCollection>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<RecoveryPlanCollection>): void

- Defined in operations/replicationRecoveryPlans.ts:370
Lists the recovery plans in the vault.

summary

Gets the list of recovery plans.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansListNextResponse>

Promise<Models.ReplicationRecoveryPlansListNextResponse>
- Defined in operations/replicationRecoveryPlans.ts:375
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<RecoveryPlanCollection>
  
  The callback
Returns void
- Defined in operations/replicationRecoveryPlans.ts:381
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<RecoveryPlanCollection>
  
  The callback
Returns void

plannedFailover

plannedFailover(recoveryPlanName: string, input: RecoveryPlanPlannedFailoverInput, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansPlannedFailoverResponse>

- Defined in operations/replicationRecoveryPlans.ts:142
The operation to start the planned failover of a recovery plan.

summary

Execute planned failover of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: RecoveryPlanPlannedFailoverInput
  
  Failover input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansPlannedFailoverResponse>

Promise<Models.ReplicationRecoveryPlansPlannedFailoverResponse>

reprotect

reprotect(recoveryPlanName: string, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansReprotectResponse>

- Defined in operations/replicationRecoveryPlans.ts:154
The operation to reprotect(reverse replicate) a recovery plan.

summary

Execute reprotect of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansReprotectResponse>

Promise<Models.ReplicationRecoveryPlansReprotectResponse>

testFailover

testFailover(recoveryPlanName: string, input: RecoveryPlanTestFailoverInput, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansTestFailoverResponse>

- Defined in operations/replicationRecoveryPlans.ts:167
The operation to start the test failover of a recovery plan.

summary

Execute test failover of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: RecoveryPlanTestFailoverInput
  
  Failover input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansTestFailoverResponse>

Promise<Models.ReplicationRecoveryPlansTestFailoverResponse>

testFailoverCleanup

testFailoverCleanup(recoveryPlanName: string, input: RecoveryPlanTestFailoverCleanupInput, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansTestFailoverCleanupResponse>

- Defined in operations/replicationRecoveryPlans.ts:180
The operation to cleanup test failover of a recovery plan.

summary

Execute test failover cleanup of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: RecoveryPlanTestFailoverCleanupInput
  
  Test failover cleanup input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansTestFailoverCleanupResponse>

Promise<Models.ReplicationRecoveryPlansTestFailoverCleanupResponse>

unplannedFailover

unplannedFailover(recoveryPlanName: string, input: RecoveryPlanUnplannedFailoverInput, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansUnplannedFailoverResponse>

- Defined in operations/replicationRecoveryPlans.ts:193
The operation to start the failover of a recovery plan.

summary

Execute unplanned failover of the recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: RecoveryPlanUnplannedFailoverInput
  
  Failover input.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansUnplannedFailoverResponse>

Promise<Models.ReplicationRecoveryPlansUnplannedFailoverResponse>

update

update(recoveryPlanName: string, input: UpdateRecoveryPlanInput, options?: msRest.RequestOptionsBase): Promise<Models.ReplicationRecoveryPlansUpdateResponse>

- Defined in operations/replicationRecoveryPlans.ts:117
The operation to update a recovery plan.

summary

Updates the given recovery plan.

Parameters
- recoveryPlanName: string
  
  Recovery plan name.
- input: UpdateRecoveryPlanInput
  
  Update recovery plan input
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ReplicationRecoveryPlansUpdateResponse>

Promise<Models.ReplicationRecoveryPlansUpdateResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SiteRecoveryManagementClientContext

Returns ReplicationRecoveryPlans

Methods

beginCreate

Parameters

recoveryPlanName: string

input: CreateRecoveryPlanInput

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

recoveryPlanName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginFailoverCommit

Parameters

recoveryPlanName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginPlannedFailover

Parameters

recoveryPlanName: string

input: RecoveryPlanPlannedFailoverInput

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginReprotect

Parameters

recoveryPlanName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginTestFailover

Parameters

recoveryPlanName: string

input: RecoveryPlanTestFailoverInput

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginTestFailoverCleanup

Parameters

recoveryPlanName: string

input: RecoveryPlanTestFailoverCleanupInput

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginUnplannedFailover

Parameters

recoveryPlanName: string

input: RecoveryPlanUnplannedFailoverInput

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginUpdate

Parameters

recoveryPlanName: string

input: UpdateRecoveryPlanInput

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

create

Parameters

recoveryPlanName: string

input: CreateRecoveryPlanInput

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.ReplicationRecoveryPlansCreateResponse>

deleteMethod

Parameters

recoveryPlanName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

failoverCommit

Parameters

recoveryPlanName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.ReplicationRecoveryPlansFailoverCommitResponse>

get

Parameters

recoveryPlanName: string