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/ NOTE: This property will not be serialized. It can only be populated by the server.
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>. NOTE: This property will not be serialized. It can only be populated by the server.
isZoneRedundant	Flag to indicate whether or not this region is an AvailabilityZone region
locationName	The name of the region.
provisioningState	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.

Property Details

documentEndpoint

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.

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

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 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.

provisioningState?: string

Property Value

string