Show / Hide Table of Contents

Class DisasterRecoveryClient

Service client instance for DisasterRecovery.

Inheritance
object
ClientBase
RegionalClientBase
DisasterRecoveryClient
Implements
IDisposable
Inherited Members
RegionalClientBase.logger
RegionalClientBase.SetRegion(Region)
RegionalClientBase.SetRegion(string)
RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)
RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
RegionalClientBase.parseEndpointForParameters(string)
ClientBase.restClient
ClientBase.service
ClientBase.userAgent
ClientBase.Dispose()
ClientBase.Dispose(bool)
ClientBase.SetEndpoint(string)
ClientBase.GetEndpoint()
ClientBase.GetUserAgent()
ClientBase.SetRealmSpecificEndpointTemplate(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DisasterrecoveryService
Assembly: OCI.DotNetSDK.Disasterrecovery.dll
Syntax
public class DisasterRecoveryClient : RegionalClientBase, IDisposable

Constructors

DisasterRecoveryClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration
public DisasterRecoveryClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type Name Description
IBasicAuthenticationDetailsProvider authenticationDetailsProvider

The authentication details provider. Required.

ClientConfiguration clientConfiguration

The client configuration that contains settings to adjust REST client behaviors. Optional.

string endpoint

The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration
public DisasterRecoveryPaginators Paginators { get; }
Property Value
Type Description
DisasterRecoveryPaginators

Waiters

Declaration
public DisasterRecoveryWaiters Waiters { get; }
Property Value
Type Description
DisasterRecoveryWaiters

Methods

AssociateDrProtectionGroup(AssociateDrProtectionGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an association between the DR protection group identified by drProtectionGroupId and another DR protection group.

Declaration
public Task<AssociateDrProtectionGroupResponse> AssociateDrProtectionGroup(AssociateDrProtectionGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
AssociateDrProtectionGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<AssociateDrProtectionGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use AssociateDrProtectionGroup API.

CancelDrPlanExecution(CancelDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel the DR plan execution identified by drPlanExecutionId.

Declaration
public Task<CancelDrPlanExecutionResponse> CancelDrPlanExecution(CancelDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CancelDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelDrPlanExecution API.

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel the work request identified by workRequestId.

Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelWorkRequestRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CancelWorkRequestResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelWorkRequest API.

ChangeDrProtectionGroupCompartment(ChangeDrProtectionGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Move the DR protection group identified by drProtectionGroupId to a different compartment.

Declaration
public Task<ChangeDrProtectionGroupCompartmentResponse> ChangeDrProtectionGroupCompartment(ChangeDrProtectionGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeDrProtectionGroupCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeDrProtectionGroupCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDrProtectionGroupCompartment API.

CreateDrPlan(CreateDrPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a DR plan of the specified DR plan type.

Declaration
public Task<CreateDrPlanResponse> CreateDrPlan(CreateDrPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDrPlanRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateDrPlanResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDrPlan API.

CreateDrPlanExecution(CreateDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Execute a DR plan for a DR protection group.

Declaration
public Task<CreateDrPlanExecutionResponse> CreateDrPlanExecution(CreateDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDrPlanExecution API.

CreateDrProtectionGroup(CreateDrProtectionGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a DR protection group.

Declaration
public Task<CreateDrProtectionGroupResponse> CreateDrProtectionGroup(CreateDrProtectionGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDrProtectionGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateDrProtectionGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDrProtectionGroup API.

DeleteDrPlan(DeleteDrPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the DR plan identified by drPlanId.

Declaration
public Task<DeleteDrPlanResponse> DeleteDrPlan(DeleteDrPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteDrPlanRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteDrPlanResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDrPlan API.

DeleteDrPlanExecution(DeleteDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the DR plan execution identified by drPlanExecutionId.

Declaration
public Task<DeleteDrPlanExecutionResponse> DeleteDrPlanExecution(DeleteDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDrPlanExecution API.

DeleteDrProtectionGroup(DeleteDrProtectionGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the DR protection group identified by drProtectionGroupId.

Declaration
public Task<DeleteDrProtectionGroupResponse> DeleteDrProtectionGroup(DeleteDrProtectionGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteDrProtectionGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteDrProtectionGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDrProtectionGroup API.

DisassociateDrProtectionGroup(DisassociateDrProtectionGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the association between the DR protection group identified by drProtectionGroupId. and its peer DR protection group.

Declaration
public Task<DisassociateDrProtectionGroupResponse> DisassociateDrProtectionGroup(DisassociateDrProtectionGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DisassociateDrProtectionGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DisassociateDrProtectionGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DisassociateDrProtectionGroup API.

GetDrPlan(GetDrPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get details for the DR plan identified by drPlanId.

Declaration
public Task<GetDrPlanResponse> GetDrPlan(GetDrPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDrPlanRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetDrPlanResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDrPlan API.

GetDrPlanExecution(GetDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get details for the DR plan execution identified by drPlanExecutionId.

Declaration
public Task<GetDrPlanExecutionResponse> GetDrPlanExecution(GetDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDrPlanExecution API.

GetDrProtectionGroup(GetDrProtectionGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the DR protection group identified by drProtectionGroupId.

Declaration
public Task<GetDrProtectionGroupResponse> GetDrProtectionGroup(GetDrProtectionGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDrProtectionGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetDrProtectionGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDrProtectionGroup API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the status of the work request identified by workRequestId.

Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetWorkRequestRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetWorkRequestResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

IgnoreDrPlanExecution(IgnoreDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Ignore the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.

Declaration
public Task<IgnoreDrPlanExecutionResponse> IgnoreDrPlanExecution(IgnoreDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
IgnoreDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<IgnoreDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use IgnoreDrPlanExecution API.

ListDrPlanExecutions(ListDrPlanExecutionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a summary list of all DR plan executions for a DR protection group.

Declaration
public Task<ListDrPlanExecutionsResponse> ListDrPlanExecutions(ListDrPlanExecutionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDrPlanExecutionsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListDrPlanExecutionsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDrPlanExecutions API.

ListDrPlans(ListDrPlansRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a summary list of all DR plans for a DR protection group.

Declaration
public Task<ListDrPlansResponse> ListDrPlans(ListDrPlansRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDrPlansRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListDrPlansResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDrPlans API.

ListDrProtectionGroups(ListDrProtectionGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a summary list of all DR protection groups in a compartment.

Declaration
public Task<ListDrProtectionGroupsResponse> ListDrProtectionGroups(ListDrProtectionGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDrProtectionGroupsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListDrProtectionGroupsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDrProtectionGroups API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a list of work request errors for the work request identified by workRequestId.

Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestErrorsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestErrorsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a list of logs for the work request identified by workRequestId.

Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestLogsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestLogsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkRequestsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkRequestsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

PauseDrPlanExecution(PauseDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Pause the DR plan execution identified by drPlanExecutionId.

Declaration
public Task<PauseDrPlanExecutionResponse> PauseDrPlanExecution(PauseDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
PauseDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<PauseDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use PauseDrPlanExecution API.

RefreshDrPlan(RefreshDrPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refresh DR Plan identified by drPlanId.

Declaration
public Task<RefreshDrPlanResponse> RefreshDrPlan(RefreshDrPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RefreshDrPlanRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<RefreshDrPlanResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RefreshDrPlan API.

ResumeDrPlanExecution(ResumeDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Resume the DR plan execution identified by drPlanExecutionId.

Declaration
public Task<ResumeDrPlanExecutionResponse> ResumeDrPlanExecution(ResumeDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ResumeDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ResumeDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ResumeDrPlanExecution API.

RetryDrPlanExecution(RetryDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retry the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.

Declaration
public Task<RetryDrPlanExecutionResponse> RetryDrPlanExecution(RetryDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RetryDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<RetryDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RetryDrPlanExecution API.

UpdateDrPlan(UpdateDrPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the DR plan identified by drPlanId.

Declaration
public Task<UpdateDrPlanResponse> UpdateDrPlan(UpdateDrPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDrPlanRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateDrPlanResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDrPlan API.

UpdateDrPlanExecution(UpdateDrPlanExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the DR plan execution identified by drPlanExecutionId.

Declaration
public Task<UpdateDrPlanExecutionResponse> UpdateDrPlanExecution(UpdateDrPlanExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDrPlanExecutionRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateDrPlanExecutionResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDrPlanExecution API.

UpdateDrProtectionGroup(UpdateDrProtectionGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the DR protection group identified by drProtectionGroupId.

Declaration
public Task<UpdateDrProtectionGroupResponse> UpdateDrProtectionGroup(UpdateDrProtectionGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDrProtectionGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateDrProtectionGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDrProtectionGroup API.

UpdateDrProtectionGroupRole(UpdateDrProtectionGroupRoleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the role of the DR protection group identified by drProtectionGroupId.

Declaration
public Task<UpdateDrProtectionGroupRoleResponse> UpdateDrProtectionGroupRole(UpdateDrProtectionGroupRoleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDrProtectionGroupRoleRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateDrProtectionGroupRoleResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDrProtectionGroupRole API.

VerifyDrPlan(VerifyDrPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Verify DR Plan identified by drPlanId.

Declaration
public Task<VerifyDrPlanResponse> VerifyDrPlan(VerifyDrPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
VerifyDrPlanRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<VerifyDrPlanResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use VerifyDrPlan API.

Implements

IDisposable
In this article
Back to top