Share via


SiteRecoveryReplicationProtectionClusterResource.TestFailover Method

Definition

Operation to initiate a failover of the replication protection cluster.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionClusters/{replicationProtectionClusterName}/testFailover
  • Operation Id: ReplicationProtectionClusters_TestFailover
  • Default Api Version: 2025-01-01
  • Resource: SiteRecoveryReplicationProtectionClusterResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryReplicationProtectionClusterResource> TestFailover(Azure.WaitUntil waitUntil, Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.ClusterTestFailoverContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member TestFailover : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.ClusterTestFailoverContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryReplicationProtectionClusterResource>
override this.TestFailover : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesSiteRecovery.Models.ClusterTestFailoverContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesSiteRecovery.SiteRecoveryReplicationProtectionClusterResource>
Public Overridable Function TestFailover (waitUntil As WaitUntil, content As ClusterTestFailoverContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of SiteRecoveryReplicationProtectionClusterResource)

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
ClusterTestFailoverContent

Cluster test failover input body.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to