DataReplicationProtectedItemResource.PlannedFailoverAsync Method
Definition
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.
Overloads
PlannedFailoverAsync(WaitUntil, PlannedFailover, CancellationToken) |
Performs the planned failover on the protected item.
|
PlannedFailoverAsync(WaitUntil, PlannedFailoverModel, CancellationToken) |
Performs the planned failover on the protected item.
|
PlannedFailoverAsync(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
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover>> PlannedFailoverAsync(Azure.WaitUntil waitUntil, Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover body, System.Threading.CancellationToken cancellationToken = default);
abstract member PlannedFailoverAsync : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover>>
override this.PlannedFailoverAsync : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailover>>
Public Overridable Function PlannedFailoverAsync (waitUntil As WaitUntil, body As PlannedFailover, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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
Exceptions
body
is null.
Applies to
PlannedFailoverAsync(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
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel>> PlannedFailoverAsync(Azure.WaitUntil waitUntil, Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel body = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PlannedFailoverAsync : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel>>
override this.PlannedFailoverAsync : Azure.WaitUntil * Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.RecoveryServicesDataReplication.Models.PlannedFailoverModel>>
Public Overridable Function PlannedFailoverAsync (waitUntil As WaitUntil, Optional body As PlannedFailoverModel = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.