FailoverPolicy Class

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

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.cosmosdb._serialization.Model

FailoverPolicy

Constructor

FailoverPolicy(*, location_name: str | None = None, failover_priority: int | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location_name	str The name of the region in which the database account exists.
failover_priority	int 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.

Variables

Name	Description
id	str The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
location_name	str The name of the region in which the database account exists.
failover_priority	int 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.