CosmosDBAccountLocation Class

Definition

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

public class CosmosDBAccountLocation : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountLocation>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountLocation>
type CosmosDBAccountLocation = class
    interface IJsonModel<CosmosDBAccountLocation>
    interface IPersistableModel<CosmosDBAccountLocation>
Public Class CosmosDBAccountLocation
Implements IJsonModel(Of CosmosDBAccountLocation), IPersistableModel(Of CosmosDBAccountLocation)
Inheritance
CosmosDBAccountLocation
Implements

Constructors

CosmosDBAccountLocation()

Initializes a new instance of CosmosDBAccountLocation.

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CosmosDBAccountLocation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CosmosDBAccountLocation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CosmosDBAccountLocation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CosmosDBAccountLocation>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CosmosDBAccountLocation>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to