RecoveryJobsOperations interface

Package:

@azure/arm-resiliencemanagement

Interface representing a RecoveryJobs operations.

Properties

beginCancel
beginCancelAndWait
beginResume
beginResumeAndWait
beginRetry
beginRetryAndWait
cancel	This action attempts to cancel the ongoing recovery orchestration job.
get	Get a RecoveryJob
list	List RecoveryJob resources by RecoveryPlan
resume	This action resumes the ongoing recovery orchestration job that was paused for required user intervention.
retry	This action retries the ongoing recovery orchestration job for resources that failed in previous attempts.

Property Details

beginCancel

Warning

This API is now deprecated.

use cancel instead

beginCancel: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsCancelOptionalParams) => Promise<SimplePollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsCancelOptionalParams) => Promise<SimplePollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>>

beginCancelAndWait

Warning

This API is now deprecated.

use cancel instead

beginCancelAndWait: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsCancelOptionalParams) => Promise<ArmResponseErrorResponse>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsCancelOptionalParams) => Promise<ArmResponseErrorResponse>

beginResume

Warning

This API is now deprecated.

use resume instead

beginResume: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsResumeOptionalParams) => Promise<SimplePollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsResumeOptionalParams) => Promise<SimplePollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>>

beginResumeAndWait

Warning

This API is now deprecated.

use resume instead

beginResumeAndWait: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsResumeOptionalParams) => Promise<ArmResponseErrorResponse>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsResumeOptionalParams) => Promise<ArmResponseErrorResponse>

beginRetry

Warning

This API is now deprecated.

use retry instead

beginRetry: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, options?: RecoveryJobsRetryOptionalParams) => Promise<SimplePollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, options?: RecoveryJobsRetryOptionalParams) => Promise<SimplePollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>>

beginRetryAndWait

Warning

This API is now deprecated.

use retry instead

beginRetryAndWait: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, options?: RecoveryJobsRetryOptionalParams) => Promise<ArmResponseErrorResponse>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, options?: RecoveryJobsRetryOptionalParams) => Promise<ArmResponseErrorResponse>

cancel

This action attempts to cancel the ongoing recovery orchestration job.

cancel: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsCancelOptionalParams) => PollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsCancelOptionalParams) => PollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>

get

Get a RecoveryJob

get: (serviceGroupName: string, recoveryPlanName: string, recoveryJobName: string, options?: RecoveryJobsGetOptionalParams) => Promise<RecoveryJob>

Property Value

(serviceGroupName: string, recoveryPlanName: string, recoveryJobName: string, options?: RecoveryJobsGetOptionalParams) => Promise<RecoveryJob>

list

List RecoveryJob resources by RecoveryPlan

list: (serviceGroupName: string, recoveryPlanName: string, options?: RecoveryJobsListOptionalParams) => PagedAsyncIterableIterator<RecoveryJob, RecoveryJob[], PageSettings>

Property Value

(serviceGroupName: string, recoveryPlanName: string, options?: RecoveryJobsListOptionalParams) => PagedAsyncIterableIterator<RecoveryJob, RecoveryJob[], PageSettings>

resume

This action resumes the ongoing recovery orchestration job that was paused for required user intervention.

resume: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsResumeOptionalParams) => PollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, body: RecoveryActionRequest, options?: RecoveryJobsResumeOptionalParams) => PollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>

retry

This action retries the ongoing recovery orchestration job for resources that failed in previous attempts.

retry: (serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, options?: RecoveryJobsRetryOptionalParams) => PollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>

Property Value

(serviceGroupName: string, operationId: string, recoveryPlanName: string, recoveryJobName: string, options?: RecoveryJobsRetryOptionalParams) => PollerLike<OperationState<ArmResponseErrorResponse>, ArmResponseErrorResponse>