Share via


SiteRecoveryRecoveryPlanResource.PlannedFailover Method

Definition

The operation to start the planned failover of a recovery plan.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationRecoveryPlans/{recoveryPlanName}/plannedFailover
  • Operation Id: ReplicationRecoveryPlans_PlannedFailover
  • Default Api Version: 2023-08-01
  • Resource: SiteRecoveryRecoveryPlanResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryRecoveryPlanResource> PlannedFailover (Azure.WaitUntil waitUntil, Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.RecoveryPlanPlannedFailoverContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member PlannedFailover : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.RecoveryPlanPlannedFailoverContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryRecoveryPlanResource>
override this.PlannedFailover : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.RecoveryPlanPlannedFailoverContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryRecoveryPlanResource>
Public Overridable Function PlannedFailover (waitUntil As WaitUntil, content As RecoveryPlanPlannedFailoverContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of SiteRecoveryRecoveryPlanResource)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

content
RecoveryPlanPlannedFailoverContent

Failover input.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to