CosmosDBFailoverPolicy Class

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB.Models

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.3.2

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.9

Source:: CosmosDBFailoverPolicy.cs

Source:: CosmosDBFailoverPolicy.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The failover policy for a given region of a database account.

public class CosmosDBFailoverPolicy : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBFailoverPolicy>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.CosmosDBFailoverPolicy>

type CosmosDBFailoverPolicy = class
    interface IJsonModel<CosmosDBFailoverPolicy>
    interface IPersistableModel<CosmosDBFailoverPolicy>

Public Class CosmosDBFailoverPolicy
Implements IJsonModel(Of CosmosDBFailoverPolicy), IPersistableModel(Of CosmosDBFailoverPolicy)

Inheritance: Object
CosmosDBFailoverPolicy

Implements: IJsonModel<CosmosDBFailoverPolicy> IPersistableModel<CosmosDBFailoverPolicy> IPersistableModel<T>

Constructors

CosmosDBFailoverPolicy()

Initializes a new instance of CosmosDBFailoverPolicy.

Properties

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 in which the database account replicates to. Example: <accountName>-<locationName>.
LocationName	The name of the region in which the database account exists.

Explicit Interface Implementations

IJsonModel<CosmosDBFailoverPolicy>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBFailoverPolicy>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<CosmosDBFailoverPolicy>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBFailoverPolicy>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBFailoverPolicy>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to