Share via

Location Class

  • Reference

A region in which the Azure Cosmos DB database account is deployed.

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

Inheritance
azure.mgmt.cosmosdb._serialization.Model
Location

Constructor

Location(*, location_name: str | None = None, failover_priority: int | None = None, is_zone_redundant: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location_name
str

The name of the region.
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.
is_zone_redundant
bool

Flag to indicate whether or not this region is an AvailabilityZone region.

Variables

Name Description
id
str

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
location_name
str

The name of the region.
document_endpoint
str

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/.
provisioning_state
str

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
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.
is_zone_redundant
bool

Flag to indicate whether or not this region is an AvailabilityZone region.