Share via


IManagedInstancesOperations.FailoverWithHttpMessagesAsync Method

Definition

Failovers a managed instance.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> FailoverWithHttpMessagesAsync (string resourceGroupName, string managedInstanceName, string replicaType = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member FailoverWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function FailoverWithHttpMessagesAsync (resourceGroupName As String, managedInstanceName As String, Optional replicaType As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
String

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName
String

The name of the managed instance to failover.

replicaType
String

The type of replica to be failed over. Possible values include: 'Primary', 'ReadableSecondary'

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to