Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Location

Package version

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

Hierarchy

  • Location

Index

Properties

Optional documentEndpoint

documentEndpoint: undefined | string

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ NOTE: This property will not be serialized. It can only be populated by the server.

Optional failoverPriority

failoverPriority: undefined | number

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.

Optional id

id: undefined | string

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

Optional isZoneRedundant

isZoneRedundant: undefined | false | true

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

Optional locationName

locationName: undefined | string

The name of the region.

Optional provisioningState

provisioningState: undefined | string

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. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc