Share via

SqlDatabaseResource.FailoverAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Sql
Assembly:
Azure.ResourceManager.Sql.dll
Package:
Azure.ResourceManager.Sql v1.2.1
Package:
Azure.ResourceManager.Sql v1.3.0-beta.9
Source:
SqlDatabaseResource.cs
Source:
SqlDatabaseResource.cs

Failovers a database.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover
  • Operation Id: Databases_Failover
  • Default Api Version: 2023-02-01-preview
  • Resource: SqlDatabaseResource
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.

Returns

Task<ArmOperation>

Applies to