Class Location

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent.Models

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

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

public class Location

Inheritance

object

Location

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Location()

Initializes a new instance of the Location class.

public Location()

Location(string, string, string, string, int?, bool?)

Initializes a new instance of the Location class.

public Location(string id = null, string locationName = null, string documentEndpoint = null, string provisioningState = null, int? failoverPriority = null, bool? isZoneRedundant = null)

Parameters

id string

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

locationName string

The name of the region.

documentEndpoint string

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

provisioningState string

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.

isZoneRedundant bool?

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

Properties

DocumentEndpoint

Gets the connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

public string DocumentEndpoint { get; }

Property Value

string

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 within the database account. Example: <accountName>-<locationName>.

public string Id { get; }

Property Value

string

IsZoneRedundant

Gets or sets flag to indicate whether or not this region is an AvailabilityZone region

public bool? IsZoneRedundant { get; set; }

Property Value

bool?

LocationName

Gets or sets the name of the region.

public string LocationName { get; set; }

Property Value

string

ProvisioningState

public string ProvisioningState { get; set; }

Property Value

string

Methods

Validate()

Validate the object.

public virtual void Validate()

Exceptions

Microsoft.Rest.ValidationException

Thrown if validation fails