FailoverPolicy interface

Package:

@azure/arm-cosmosdb

The failover policy for a given region of a database account.

Properties

failoverPriority	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.
id	The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. NOTE: This property will not be serialized. It can only be populated by the server.
locationName	The name of the region in which the database account exists.

Property Details

failoverPriority

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.

failoverPriority?: number

Property Value

number

id

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

locationName

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

locationName?: string

Property Value

string