Class FailoverPolicy

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent.Models

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

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

public class FailoverPolicy

Inheritance

object

FailoverPolicy

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FailoverPolicy()

Initializes a new instance of the FailoverPolicy class.

public FailoverPolicy()

FailoverPolicy(string, string, int?)

Initializes a new instance of the FailoverPolicy class.

public FailoverPolicy(string id = null, string locationName = null, int? failoverPriority = null)

Parameters

id string

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

locationName string

The name of the region in which the database account exists.

failoverPriority int?

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.

Properties

FailoverPriority

Gets or sets 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.

public int? FailoverPriority { get; set; }

Property Value

int?

Id

Gets the unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

public string Id { get; }

Property Value

string

LocationName

Gets or sets the name of the region in which the database account exists.

public string LocationName { get; set; }

Property Value

string

Methods

Validate()

Validate the object.

public virtual void Validate()

Exceptions

Microsoft.Rest.ValidationException

Thrown if validation fails