LocationResponse

data class LocationResponse(val documentEndpoint: String, val failoverPriority: Int? = null, val id: String, val isZoneRedundant: Boolean? = null, val locationName: String? = null, val provisioningState: String)

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

Constructors

Link copied to clipboard
constructor(documentEndpoint: String, failoverPriority: Int? = null, id: String, isZoneRedundant: Boolean? = null, locationName: String? = null, provisioningState: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard
val failoverPriority: Int? = null

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.

Link copied to clipboard
val id: String

The unique identifier of the region within the database account. Example: -.

Link copied to clipboard

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

Link copied to clipboard
val locationName: String? = null

The name of the region.

Link copied to clipboard

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.