Location interface

Package:
@azure/arm-cosmosdb

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

Properties

documentEndpoint

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
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 within the database account. Example: <accountName>-<locationName>.
isZoneRedundant

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

The name of the region.
provisioningState

The provisioning state of the resource.

Property Details

documentEndpoint

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

documentEndpoint?: string

Property Value

string

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 within the database account. Example: <accountName>-<locationName>.

id?: string

Property Value

string

isZoneRedundant

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

isZoneRedundant?: boolean

Property Value

boolean

locationName

The name of the region.

locationName?: string

Property Value

string

provisioningState

The provisioning state of the resource.

provisioningState?: string

Property Value

string