Share via

DataReplicationProtectedItemResource.PlannedFailover Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.RecoveryServicesDataReplication
Assembly:
Azure.ResourceManager.RecoveryServicesDataReplication.dll
Package:
Azure.ResourceManager.RecoveryServicesDataReplication v1.0.0-beta.3
Package:
Azure.ResourceManager.RecoveryServicesDataReplication v1.0.0

Overloads

PlannedFailover(WaitUntil, PlannedFailoverModel, CancellationToken)

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
  • Default Api Version: 2021-02-16-preview
  • Resource: DataReplicationProtectedItemResource
PlannedFailover(WaitUntil, PlannedFailover, CancellationToken)

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
  • Default Api Version: 2024-09-01
  • Resource: DataReplicationProtectedItemResource

PlannedFailover(WaitUntil, PlannedFailoverModel, CancellationToken)

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
  • Default Api Version: 2021-02-16-preview
  • Resource: DataReplicationProtectedItemResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel> PlannedFailover(Azure.WaitUntil waitUntil, Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel body = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PlannedFailover : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel>
override this.PlannedFailover : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel>
Public Overridable Function PlannedFailover (waitUntil As WaitUntil, Optional body As PlannedFailoverModel = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

ArmOperation<PlannedFailoverModel>

Applies to

PlannedFailover(WaitUntil, PlannedFailover, CancellationToken)

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
  • Default Api Version: 2024-09-01
  • Resource: DataReplicationProtectedItemResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover> PlannedFailover(Azure.WaitUntil waitUntil, Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover body, System.Threading.CancellationToken cancellationToken = default);
abstract member PlannedFailover : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover>
override this.PlannedFailover : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover>
Public Overridable Function PlannedFailover (waitUntil As WaitUntil, body As PlannedFailover, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of PlannedFailover)

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
PlannedFailover

Planned failover model.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

ArmOperation<PlannedFailover>

Exceptions

ArgumentNullException

body is null.

Applies to