Share via

DataReplicationProtectedItemResource.PlannedFailoverAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.RecoveryServicesDataReplication
Assembly:
Azure.ResourceManager.RecoveryServicesDataReplication.dll
Package:
Azure.ResourceManager.RecoveryServicesDataReplication v1.0.0-beta.2
Source:
DataReplicationProtectedItemResource.cs

Performs the planned failover on the protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/protectedItems/{protectedItemName}/plannedFailover
  • Operation Id: ProtectedItem_PlannedFailover
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel>> PlannedFailoverAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel body = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PlannedFailoverAsync : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel>>
override this.PlannedFailoverAsync : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel>>
Public Overridable Function PlannedFailoverAsync (waitUntil As WaitUntil, Optional body As PlannedFailoverModel = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of PlannedFailoverModel))

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.

body
PlannedFailoverModel

Planned failover model.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<PlannedFailoverModel>>

Applies to