DatabaseAccountCreateUpdateParameters Class

Definition

Parameters to create and update Cosmos DB database accounts.

public class DatabaseAccountCreateUpdateParameters extends ARMResourceProperties
Inheritance
java.lang.Object
com.microsoft.azure.ProxyResource
com.microsoft.azure.Resource
DatabaseAccountCreateUpdateParameters

Inherited Members

com.microsoft.azure.ProxyResource.id() com.microsoft.azure.ProxyResource.name() com.microsoft.azure.ProxyResource.type() com.microsoft.azure.Resource.getTags() com.microsoft.azure.Resource.location() com.microsoft.azure.Resource.withLocation(java.lang.String) com.microsoft.azure.Resource.withTags(java.util.Map<java.lang.String,java.lang.String>) java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructors

DatabaseAccountCreateUpdateParameters()

Creates an instance of DatabaseAccountCreateUpdateParameters class.

Methods

capabilities()

Get list of Cosmos DB capabilities for the account.

connectorOffer()

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

consistencyPolicy()

Get the consistency policy for the Cosmos DB account.

databaseAccountOfferType()

Get the offer type for the database.

disableKeyBasedMetadataWriteAccess()

Get disable write operations on metadata resources (databases, containers, throughput) via account keys.

enableAutomaticFailover()

Get 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()

Get enables the cassandra connector on the Cosmos DB C* account.

enableMultipleWriteLocations()

Get enables the account to write in multiple locations.

ipRangeFilter()

Get 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()

Get flag to indicate whether to enable/disable Virtual Network ACL rules.

kind()

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

locations()

Get an array that contains the georeplication locations enabled for the Cosmos DB account.

virtualNetworkRules()

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

withCapabilities(List<Capability> capabilities)

Set list of Cosmos DB capabilities for the account.

withConnectorOffer(ConnectorOffer connectorOffer)

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

withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)

Set the consistency policy for the Cosmos DB account.

withDatabaseAccountOfferType(String databaseAccountOfferType)

Set the offer type for the database.

withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)

Set disable write operations on metadata resources (databases, containers, throughput) via account keys.

withEnableAutomaticFailover(Boolean enableAutomaticFailover)

Set 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.

withEnableCassandraConnector(Boolean enableCassandraConnector)

Set enables the cassandra connector on the Cosmos DB C* account.

withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)

Set enables the account to write in multiple locations.

withIpRangeFilter(String ipRangeFilter)

Set 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.

withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)

Set flag to indicate whether to enable/disable Virtual Network ACL rules.

withKind(DatabaseAccountKind kind)

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

withLocations(List<Location> locations)

Set an array that contains the georeplication locations enabled for the Cosmos DB account.

withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)

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

Applies to