SiteRecoveryRecoveryPlanResource.PlannedFailoverAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.RecoveryServicesSiteRecovery

Assembly:: Azure.ResourceManager.RecoveryServicesSiteRecovery.dll

Package:: Azure.ResourceManager.RecoveryServicesSiteRecovery v1.2.0

Source:: SiteRecoveryRecoveryPlanResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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 System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryRecoveryPlanResource>> PlannedFailoverAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.RecoveryPlanPlannedFailoverContent content, System.Threading.CancellationToken cancellationToken = default);

abstract member PlannedFailoverAsync : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.RecoveryPlanPlannedFailoverContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryRecoveryPlanResource>>
override this.PlannedFailoverAsync : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.RecoveryPlanPlannedFailoverContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryRecoveryPlanResource>>

Public Overridable Function PlannedFailoverAsync (waitUntil As WaitUntil, content As RecoveryPlanPlannedFailoverContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.