com.microsoft.azure.management.cosmosdb

Class DatabaseAccountCreateUpdateParameters

java.lang.Object

com.microsoft.azure.Resource

com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters

public class DatabaseAccountCreateUpdateParameters
extends Resource

Parameters to create and update Cosmos DB database accounts.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<Capability>	capabilities() Get list of Cosmos DB capabilities for the account.
ConsistencyPolicy	consistencyPolicy() Get the consistency policy for the Cosmos DB account.
String	databaseAccountOfferType() Get the offer type for the database.
Boolean	enableAutomaticFailover() Get enables automatic failover of the write region in the rare event that the region is unavailable due to an outage.
Boolean	enableMultipleWriteLocations() Get enables the account to write in multiple locations.
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.
Boolean	isVirtualNetworkFilterEnabled() Get flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountKind	kind() Get indicates the type of database account.
List<Location>	locations() Get an array that contains the georeplication locations enabled for the Cosmos DB account.
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	withConsistencyPolicy(ConsistencyPolicy consistencyPolicy) Set the consistency policy for the Cosmos DB account.
DatabaseAccountCreateUpdateParameters	withDatabaseAccountOfferType(String databaseAccountOfferType) Set the offer type for the database.
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	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 class com.microsoft.azure.Resource

getTags, id, location, name, type, withLocation, withTags

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatabaseAccountCreateUpdateParameters

public DatabaseAccountCreateUpdateParameters()

Creates an instance of DatabaseAccountCreateUpdateParameters class.

Method Detail

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

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.

consistencyPolicy

public ConsistencyPolicy consistencyPolicy()

Get the consistency policy for the Cosmos DB account.

Returns:

the consistencyPolicy value

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.

locations

public List<Location> locations()

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

Returns:

the locations value

withLocations

public DatabaseAccountCreateUpdateParameters withLocations(List<Location> 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.

databaseAccountOfferType

public String databaseAccountOfferType()

Get the offer type for the database.

Returns:

the databaseAccountOfferType value

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.

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

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.

isVirtualNetworkFilterEnabled

public Boolean isVirtualNetworkFilterEnabled()

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

Returns:

the isVirtualNetworkFilterEnabled value

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.

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

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.

capabilities

public List<Capability> capabilities()

Get list of Cosmos DB capabilities for the account.

Returns:

the capabilities value

withCapabilities

public DatabaseAccountCreateUpdateParameters withCapabilities(List<Capability> capabilities)

Set list of Cosmos DB capabilities for the account.

Parameters:

capabilities - the capabilities value to set

Returns:

the DatabaseAccountCreateUpdateParameters object itself.

virtualNetworkRules

public List<VirtualNetworkRule> virtualNetworkRules()

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

Returns:

the virtualNetworkRules value

withVirtualNetworkRules

public DatabaseAccountCreateUpdateParameters withVirtualNetworkRules(List<VirtualNetworkRule> 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.

enableMultipleWriteLocations

public Boolean enableMultipleWriteLocations()

Get enables the account to write in multiple locations.

Returns:

the enableMultipleWriteLocations value

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.