IDatabaseAccountsOperations.BeginFailoverPriorityChangeWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.CosmosDB.Fluent

Assembly:

Microsoft.Azure.Management.CosmosDB.Fluent.dll

Package:

Microsoft.Azure.Management.CosmosDB.Fluent v1.38.1

Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> BeginFailoverPriorityChangeWithHttpMessagesAsync (string resourceGroupName, string accountName, System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.FailoverPolicy> failoverPoliciesProperty, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member BeginFailoverPriorityChangeWithHttpMessagesAsync : string * string * System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.FailoverPolicy> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>

Public Function BeginFailoverPriorityChangeWithHttpMessagesAsync (resourceGroupName As String, accountName As String, failoverPoliciesProperty As IList(Of FailoverPolicy), Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName

String

Name of an Azure resource group.

accountName

String

Cosmos DB database account name.

failoverPoliciesProperty

IList<FailoverPolicy>

List of failover policies.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null