ReplicationProtectedItemResource.PlannedFailoverAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.RecoveryServicesSiteRecovery

Assembly:: Azure.ResourceManager.RecoveryServicesSiteRecovery.dll

Package:: Azure.ResourceManager.RecoveryServicesSiteRecovery v1.2.0

Source:: ReplicationProtectedItemResource.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.

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

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

Public Overridable Function PlannedFailoverAsync (waitUntil As WaitUntil, content As PlannedFailoverContent, 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: PlannedFailoverContent

Planned failover input.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<ReplicationProtectedItemResource>>

Exceptions

ArgumentNullException

content is null.

Applies to

Share via