Class DatabaseAccountGetResultsInner

Namespace

Microsoft.Azure.Management.CosmosDB.Fluent.Models

Assembly

Microsoft.Azure.Management.CosmosDB.Fluent.dll

An Azure Cosmos DB database account.

public class DatabaseAccountGetResultsInner : ARMResourcePropertiesInner

Inheritance

object

ARMResourcePropertiesInner

DatabaseAccountGetResultsInner

Constructors

DatabaseAccountGetResultsInner()

Initializes a new instance of the DatabaseAccountGetResultsInner class.

public DatabaseAccountGetResultsInner()

DatabaseAccountGetResultsInner(string, string, string, string, IDictionary<string, string>, DatabaseAccountKind, string, string, DatabaseAccountOfferType?, string, bool?, bool?, ConsistencyPolicy, IList<Capability>, IList<Location>, IList<Location>, IList<Location>, IList<FailoverPolicy>, IList<VirtualNetworkRule>, bool?, bool?, ConnectorOffer, bool?, string)

Initializes a new instance of the DatabaseAccountGetResultsInner class.

public DatabaseAccountGetResultsInner(string location, string id = null, string name = null, string type = null, IDictionary<string, string> tags = null, DatabaseAccountKind kind = null, string provisioningState = null, string documentEndpoint = null, DatabaseAccountOfferType? databaseAccountOfferType = null, string ipRangeFilter = null, bool? isVirtualNetworkFilterEnabled = null, bool? enableAutomaticFailover = null, ConsistencyPolicy consistencyPolicy = null, IList<Capability> capabilities = null, IList<Location> writeLocations = null, IList<Location> readLocations = null, IList<Location> locations = null, IList<FailoverPolicy> failoverPolicies = null, IList<VirtualNetworkRule> virtualNetworkRules = null, bool? enableMultipleWriteLocations = null, bool? enableCassandraConnector = null, ConnectorOffer connectorOffer = null, bool? disableKeyBasedMetadataWriteAccess = null, string keyVaultKeyUri = null)

Parameters

location string

id string

name string

type string

tags IDictionary<string, string>

kind DatabaseAccountKind

Indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse'

provisioningState string

documentEndpoint string

The connection endpoint for the Cosmos DB database account.

databaseAccountOfferType DatabaseAccountOfferType?

The offer type for the Cosmos DB database account. Default value: Standard. Possible values include: 'Standard'

ipRangeFilter string

Cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

isVirtualNetworkFilterEnabled bool?

Flag to indicate whether to enable/disable Virtual Network ACL rules.

enableAutomaticFailover bool?

Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

consistencyPolicy ConsistencyPolicy

The consistency policy for the Cosmos DB database account.

capabilities IList<Capability>

List of Cosmos DB capabilities for the account

writeLocations IList<Location>

An array that contains the write location for the Cosmos DB account.

readLocations IList<Location>

An array that contains of the read locations enabled for the Cosmos DB account.

locations IList<Location>

An array that contains all of the locations enabled for the Cosmos DB account.

failoverPolicies IList<FailoverPolicy>

An array that contains the regions ordered by their failover priorities.

virtualNetworkRules IList<VirtualNetworkRule>

List of Virtual Network ACL rules configured for the Cosmos DB account.

enableMultipleWriteLocations bool?

Enables the account to write in multiple locations

enableCassandraConnector bool?

Enables the cassandra connector on the Cosmos DB C* account

connectorOffer ConnectorOffer

The cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'

disableKeyBasedMetadataWriteAccess bool?

Disable write operations on metadata resources (databases, containers, throughput) via account keys

keyVaultKeyUri string

The URI of the key vault

Properties

Capabilities

Gets or sets list of Cosmos DB capabilities for the account

public IList<Capability> Capabilities { get; set; }

Property Value

IList<Capability>

ConnectorOffer

Gets or sets the cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'

public ConnectorOffer ConnectorOffer { get; set; }

Property Value

ConnectorOffer

ConsistencyPolicy

Gets or sets the consistency policy for the Cosmos DB database account.

public ConsistencyPolicy ConsistencyPolicy { get; set; }

Property Value

ConsistencyPolicy

DatabaseAccountOfferType

Gets the offer type for the Cosmos DB database account. Default value: Standard. Possible values include: 'Standard'

public DatabaseAccountOfferType? DatabaseAccountOfferType { get; }

Property Value

DatabaseAccountOfferType?

DisableKeyBasedMetadataWriteAccess

Gets or sets disable write operations on metadata resources (databases, containers, throughput) via account keys

public bool? DisableKeyBasedMetadataWriteAccess { get; set; }

Property Value

bool?

DocumentEndpoint

Gets the connection endpoint for the Cosmos DB database account.

public string DocumentEndpoint { get; }

Property Value

string

EnableAutomaticFailover

Gets or sets enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

public bool? EnableAutomaticFailover { get; set; }

Property Value

bool?

EnableCassandraConnector

Gets or sets enables the cassandra connector on the Cosmos DB C* account

public bool? EnableCassandraConnector { get; set; }

Property Value

bool?

EnableMultipleWriteLocations

Gets or sets enables the account to write in multiple locations

public bool? EnableMultipleWriteLocations { get; set; }

Property Value

bool?

FailoverPolicies

Gets an array that contains the regions ordered by their failover priorities.

public IList<FailoverPolicy> FailoverPolicies { get; }

Property Value

IList<FailoverPolicy>

IpRangeFilter

Gets or sets cosmos DB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.

public string IpRangeFilter { get; set; }

Property Value

string

IsVirtualNetworkFilterEnabled

Gets or sets flag to indicate whether to enable/disable Virtual Network ACL rules.

public bool? IsVirtualNetworkFilterEnabled { get; set; }

Property Value

bool?

KeyVaultKeyUri

Gets or sets the URI of the key vault

public string KeyVaultKeyUri { get; set; }

Property Value

string

Kind

Gets or sets indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse'

public DatabaseAccountKind Kind { get; set; }

Property Value

DatabaseAccountKind

Locations

Gets an array that contains all of the locations enabled for the Cosmos DB account.

public IList<Location> Locations { get; }

Property Value

IList<Location>

ProvisioningState

public string ProvisioningState { get; set; }

Property Value

string

ReadLocations

Gets an array that contains of the read locations enabled for the Cosmos DB account.

public IList<Location> ReadLocations { get; }

Property Value

IList<Location>

VirtualNetworkRules

Gets or sets list of Virtual Network ACL rules configured for the Cosmos DB account.

public IList<VirtualNetworkRule> VirtualNetworkRules { get; set; }

Property Value

IList<VirtualNetworkRule>

WriteLocations

Gets an array that contains the write location for the Cosmos DB account.

public IList<Location> WriteLocations { get; }

Property Value

IList<Location>

Methods

Validate()

Validate the object.

public override void Validate()

Exceptions

Microsoft.Rest.ValidationException

Thrown if validation fails