ReplicationProtectedItemResource.UnplannedFailoverAsync Method

Definition

Operation to initiate a failover of the replication protected item.

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

Failover input.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to