ReplicationProtectedItemResource.PlannedFailover Method

Definition

Operation to initiate a planned failover of the replication protected item.

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

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
PlannedFailoverContent

Planned failover input.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to