ManagedInstanceResource.FailoverAsync 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.
Failovers a managed instance.
- Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/failover.
- Operation Id. : ManagedInstances_Failover.
- Default Api Version. : 2025-08-01-preview.
- Resource. : ManagedInstanceResource.
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> FailoverAsync(Azure.WaitUntil waitUntil, Azure.ResourceManager.Sql.Models.ReplicaType? replicaType = default, System.Threading.CancellationToken cancellationToken = default);abstract member FailoverAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.Sql.Models.ReplicaType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.FailoverAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.Sql.Models.ReplicaType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>Public Overridable Function FailoverAsync (waitUntil As WaitUntil, Optional replicaType As Nullable(Of ReplicaType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation)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.
- replicaType
- Nullable<ReplicaType>
The type of replica to be failed over.
- cancellationToken
- CancellationToken
The cancellation token to use.
