ArmCosmosDBModelFactory.CosmosDBFailoverPolicy Method

Definition

Namespace:

Azure.ResourceManager.CosmosDB.Models

Assembly:

Azure.ResourceManager.CosmosDB.dll

Package:

Azure.ResourceManager.CosmosDB v1.3.2

Source:

ArmCosmosDBModelFactory.cs

Initializes a new instance of CosmosDBFailoverPolicy.

public static Azure.ResourceManager.CosmosDB.Models.CosmosDBFailoverPolicy CosmosDBFailoverPolicy (string id = default, Azure.Core.AzureLocation? locationName = default, int? failoverPriority = default);

static member CosmosDBFailoverPolicy : string * Nullable<Azure.Core.AzureLocation> * Nullable<int> -> Azure.ResourceManager.CosmosDB.Models.CosmosDBFailoverPolicy

Public Shared Function CosmosDBFailoverPolicy (Optional id As String = Nothing, Optional locationName As Nullable(Of AzureLocation) = Nothing, Optional failoverPriority As Nullable(Of Integer) = Nothing) As CosmosDBFailoverPolicy

Parameters

id

String

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

locationName

Nullable<AzureLocation>

The name of the region in which the database account exists.

failoverPriority

Nullable<Int32>

The failover priority of the region. 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.

Returns

CosmosDBFailoverPolicy

A new CosmosDBFailoverPolicy instance for mocking.