DatabaseAccountCreateUpdateParameters Class

Package:

com.microsoft.azure.management.cosmosdb

Maven Artifact:

com.microsoft.azure:azure-mgmt-cosmosdb:1.41.4

• java.lang.Object
• • com.microsoft.azure.ProxyResource
  • • com.microsoft.azure.Resource
    • • com.microsoft.azure.management.cosmosdb.ARMResourceProperties
      • • com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters

public class DatabaseAccountCreateUpdateParameters
extends ARMResourceProperties

Parameters to create and update Cosmos DB database accounts.

Constructor Summary

Constructor	Description
DatabaseAccountCreateUpdateParameters()	Creates an instance of DatabaseAccountCreateUpdateParameters class.

Method Summary

Modifier and Type	Method and Description
java.util.List<Capability>	capabilities() Get list of Cosmos DB capabilities for the account.
ConnectorOffer	connectorOffer() Get the cassandra connector offer type for the Cosmos DB database C* account.
ConsistencyPolicy	consistencyPolicy() Get the consistency policy for the Cosmos DB account.
java.lang.String	databaseAccountOfferType() Get the offer type for the database.
java.lang.Boolean	disableKeyBasedMetadataWriteAccess() Get disable write operations on metadata resources (databases, containers, throughput) via account keys.
java.lang.Boolean	enableAutomaticFailover() Get enables automatic failover of the write region in the rare event that the region is unavailable due to an outage.
java.lang.Boolean	enableCassandraConnector() Get enables the cassandra connector on the Cosmos DB C* account.
java.lang.Boolean	enableMultipleWriteLocations() Get enables the account to write in multiple locations.
java.lang.String	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.
java.lang.Boolean	isVirtualNetworkFilterEnabled() Get flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountKind	kind() Get indicates the type of database account.
java.util.List<Location>	locations() Get an array that contains the georeplication locations enabled for the Cosmos DB account.
java.util.List<VirtualNetworkRule>	virtualNetworkRules() Get list of Virtual Network ACL rules configured for the Cosmos DB account.
DatabaseAccountCreateUpdateParameters	withCapabilities(List<Capability> capabilities) Set list of Cosmos DB capabilities for the account.
DatabaseAccountCreateUpdateParameters	withConnectorOffer(ConnectorOffer connectorOffer) Set the cassandra connector offer type for the Cosmos DB database C* account.
DatabaseAccountCreateUpdateParameters	withConsistencyPolicy(ConsistencyPolicy consistencyPolicy) Set the consistency policy for the Cosmos DB account.
DatabaseAccountCreateUpdateParameters	withDatabaseAccountOfferType(String databaseAccountOfferType) Set the offer type for the database.
DatabaseAccountCreateUpdateParameters	withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess) Set disable write operations on metadata resources (databases, containers, throughput) via account keys.
DatabaseAccountCreateUpdateParameters	withEnableAutomaticFailover(Boolean enableAutomaticFailover) Set enables automatic failover of the write region in the rare event that the region is unavailable due to an outage.
DatabaseAccountCreateUpdateParameters	withEnableCassandraConnector(Boolean enableCassandraConnector) Set enables the cassandra connector on the Cosmos DB C* account.
DatabaseAccountCreateUpdateParameters	withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations) Set enables the account to write in multiple locations.
DatabaseAccountCreateUpdateParameters	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.
DatabaseAccountCreateUpdateParameters	withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled) Set flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountCreateUpdateParameters	withKind(DatabaseAccountKind kind) Set indicates the type of database account.
DatabaseAccountCreateUpdateParameters	withLocations(List<Location> locations) Set an array that contains the georeplication locations enabled for the Cosmos DB account.
DatabaseAccountCreateUpdateParameters	withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules) Set list of Virtual Network ACL rules configured for the Cosmos DB account.

Methods inherited from com.microsoft.azure.ProxyResource

com.microsoft.azure.ProxyResource.id com.microsoft.azure.ProxyResource.name com.microsoft.azure.ProxyResource.type

Methods inherited from com.microsoft.azure.Resource

com.microsoft.azure.Resource.getTags com.microsoft.azure.Resource.location com.microsoft.azure.Resource.withLocation com.microsoft.azure.Resource.withTags

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals 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 java.lang.Object.wait

Constructor Details

DatabaseAccountCreateUpdateParameters

public DatabaseAccountCreateUpdateParameters()

Creates an instance of DatabaseAccountCreateUpdateParameters class.

Method Details

capabilities

public List capabilities()

Get list of Cosmos DB capabilities for the account.

Returns:

the capabilities value

connectorOffer

public ConnectorOffer connectorOffer()

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

Returns:

the connectorOffer value

consistencyPolicy

public ConsistencyPolicy consistencyPolicy()

Get the consistency policy for the Cosmos DB account.

Returns:

the consistencyPolicy value

databaseAccountOfferType

public String databaseAccountOfferType()

Get the offer type for the database.

Returns:

the databaseAccountOfferType value

disableKeyBasedMetadataWriteAccess

public Boolean disableKeyBasedMetadataWriteAccess()

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

Returns:

the disableKeyBasedMetadataWriteAccess value

enableAutomaticFailover

public Boolean 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.

Returns:

the enableAutomaticFailover value

enableCassandraConnector

public Boolean enableCassandraConnector()

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

Returns:

the enableCassandraConnector value

enableMultipleWriteLocations

public Boolean enableMultipleWriteLocations()

Get enables the account to write in multiple locations.

Returns:

the enableMultipleWriteLocations value

ipRangeFilter

public String 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.

Returns:

the ipRangeFilter value

isVirtualNetworkFilterEnabled

public Boolean isVirtualNetworkFilterEnabled()

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

Returns:

the isVirtualNetworkFilterEnabled value

kind

public DatabaseAccountKind kind()

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

Returns:

the kind value

locations

public List locations()

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

Returns:

the locations value

virtualNetworkRules

public List virtualNetworkRules()

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

Returns:

the virtualNetworkRules value

withCapabilities

public DatabaseAccountCreateUpdateParameters withCapabilities(List capabilities)

Set list of Cosmos DB capabilities for the account.

Parameters:

capabilities - the capabilities value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withConnectorOffer

public DatabaseAccountCreateUpdateParameters withConnectorOffer(ConnectorOffer connectorOffer)

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

Parameters:

connectorOffer - the connectorOffer value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withConsistencyPolicy

public DatabaseAccountCreateUpdateParameters withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)

Set the consistency policy for the Cosmos DB account.

Parameters:

consistencyPolicy - the consistencyPolicy value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withDatabaseAccountOfferType

public DatabaseAccountCreateUpdateParameters withDatabaseAccountOfferType(String databaseAccountOfferType)

Set the offer type for the database.

Parameters:

databaseAccountOfferType - the databaseAccountOfferType value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withDisableKeyBasedMetadataWriteAccess

public DatabaseAccountCreateUpdateParameters withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)

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

Parameters:

disableKeyBasedMetadataWriteAccess - the disableKeyBasedMetadataWriteAccess value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withEnableAutomaticFailover

public DatabaseAccountCreateUpdateParameters 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.

Parameters:

enableAutomaticFailover - the enableAutomaticFailover value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withEnableCassandraConnector

public DatabaseAccountCreateUpdateParameters withEnableCassandraConnector(Boolean enableCassandraConnector)

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

Parameters:

enableCassandraConnector - the enableCassandraConnector value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withEnableMultipleWriteLocations

public DatabaseAccountCreateUpdateParameters withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)

Set enables the account to write in multiple locations.

Parameters:

enableMultipleWriteLocations - the enableMultipleWriteLocations value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withIpRangeFilter

public DatabaseAccountCreateUpdateParameters 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.

Parameters:

ipRangeFilter - the ipRangeFilter value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withIsVirtualNetworkFilterEnabled

public DatabaseAccountCreateUpdateParameters withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)

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

Parameters:

isVirtualNetworkFilterEnabled - the isVirtualNetworkFilterEnabled value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withKind

public DatabaseAccountCreateUpdateParameters 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'.

Parameters:

kind - the kind value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withLocations

public DatabaseAccountCreateUpdateParameters withLocations(List locations)

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

Parameters:

locations - the locations value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

withVirtualNetworkRules

public DatabaseAccountCreateUpdateParameters withVirtualNetworkRules(List virtualNetworkRules)

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

Parameters:

virtualNetworkRules - the virtualNetworkRules value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.