DatabaseAccountCreateUpdateParameters Class

Definition

Parameters to create and update Cosmos DB database accounts.

[Microsoft.Rest.Serialization.JsonTransformation]
public class DatabaseAccountCreateUpdateParameters : Microsoft.Azure.Management.CosmosDB.Fluent.Models.ARMResourcePropertiesInner
[<Microsoft.Rest.Serialization.JsonTransformation>]
type DatabaseAccountCreateUpdateParameters = class
    inherit ARMResourcePropertiesInner
Public Class DatabaseAccountCreateUpdateParameters
Inherits ARMResourcePropertiesInner
Inheritance
DatabaseAccountCreateUpdateParameters
Attributes

Constructors

DatabaseAccountCreateUpdateParameters()

Initializes a new instance of the DatabaseAccountCreateUpdateParameters class.

DatabaseAccountCreateUpdateParameters(String, IList<Location>, String, String, String, IDictionary<String,String>, DatabaseAccountKind, ConsistencyPolicy, String, Nullable<Boolean>, Nullable<Boolean>, IList<Capability>, IList<VirtualNetworkRule>, Nullable<Boolean>, Nullable<Boolean>, ConnectorOffer, Nullable<Boolean>, String)

Initializes a new instance of the DatabaseAccountCreateUpdateParameters class.

Properties

Capabilities

Gets or sets list of Cosmos DB capabilities for the account

ConnectorOffer

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

ConsistencyPolicy

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

DatabaseAccountOfferType

The offer type for the database

DisableKeyBasedMetadataWriteAccess

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

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.

EnableCassandraConnector

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

EnableMultipleWriteLocations

Gets or sets enables the account to write in multiple locations

Id

Resource Id. Setter is protected because Id needs to be set in Network resources.

(Inherited from ProxyResource)
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.

IsVirtualNetworkFilterEnabled

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

KeyVaultKeyUri

Gets or sets the URI of the key vault

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'

Location

Resource location

(Inherited from Resource)
Locations

Gets or sets an array that contains the georeplication locations enabled for the Cosmos DB account.

Name

Resource name

(Inherited from ProxyResource)
Tags

Resource tags

(Inherited from Resource)
Type

Resource type

(Inherited from ProxyResource)
VirtualNetworkRules

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

Methods

Validate()

Validate the object.

Applies to