SqlDistributedAvailabilityGroupResource.Failover Method

Reference

Definition

Namespace:: Azure.ResourceManager.Sql

Assembly:: Azure.ResourceManager.Sql.dll

Package:: Azure.ResourceManager.Sql v1.3.0

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

Performs requested failover type in this distributed availability group.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/distributedAvailabilityGroups/{distributedAvailabilityGroupName}/failover
Operation Id: DistributedAvailabilityGroups_Failover
Default Api Version: 2023-08-01
Resource: SqlDistributedAvailabilityGroupResource

public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.SqlDistributedAvailabilityGroupResource> Failover(Azure.WaitUntil waitUntil, Azure.ResourceManager.Sql.Models.DistributedAvailabilityGroupsFailoverContent content, System.Threading.CancellationToken cancellationToken = default);

abstract member Failover : Azure.WaitUntil * Azure.ResourceManager.Sql.Models.DistributedAvailabilityGroupsFailoverContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.SqlDistributedAvailabilityGroupResource>
override this.Failover : Azure.WaitUntil * Azure.ResourceManager.Sql.Models.DistributedAvailabilityGroupsFailoverContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Sql.SqlDistributedAvailabilityGroupResource>

Public Overridable Function Failover (waitUntil As WaitUntil, content As DistributedAvailabilityGroupsFailoverContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of SqlDistributedAvailabilityGroupResource)

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: DistributedAvailabilityGroupsFailoverContent

The distributed availability group failover request parameters.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

ArmOperation<SqlDistributedAvailabilityGroupResource>

Exceptions

ArgumentNullException

content is null.

Applies to