DatabaseAccountCreateUpdateParameters Class
- java.
lang. Object - com.
microsoft. azure. ProxyResource - com.
microsoft. azure. Resource - com.
microsoft. azure. management. cosmosdb. ARMResourceProperties - com.
microsoft. azure. management. cosmosdb. DatabaseAccountCreateUpdateParameters
- com.
- com.
- com.
- com.
public class DatabaseAccountCreateUpdateParameters
extends ARMResourceProperties
Parameters to create and update Cosmos DB database accounts.
Constructor Summary
Constructor | Description |
---|---|
DatabaseAccountCreateUpdateParameters() |
Creates an instance of Database |
Method Summary
Modifier and Type | Method and Description |
---|---|
java.util.List<Capability> |
capabilities()
Get list of Cosmos DB capabilities for the account. |
Connector |
connectorOffer()
Get the cassandra connector offer type for the Cosmos DB database C* account. |
Consistency |
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. |
Database |
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<Virtual |
virtualNetworkRules()
Get list of Virtual Network ACL rules configured for the Cosmos DB account. |
Database |
withCapabilities(List<Capability> capabilities)
Set list of Cosmos DB capabilities for the account. |
Database |
withConnectorOffer(ConnectorOffer connectorOffer)
Set the cassandra connector offer type for the Cosmos DB database C* account. |
Database |
withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)
Set the consistency policy for the Cosmos DB account. |
Database |
withDatabaseAccountOfferType(String databaseAccountOfferType)
Set the offer type for the database. |
Database |
withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)
Set disable write operations on metadata resources (databases, containers, throughput) via account keys. |
Database |
withEnableAutomaticFailover(Boolean enableAutomaticFailover)
Set enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. |
Database |
withEnableCassandraConnector(Boolean enableCassandraConnector)
Set enables the cassandra connector on the Cosmos DB C* account. |
Database |
withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)
Set enables the account to write in multiple locations. |
Database |
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. |
Database |
withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)
Set flag to indicate whether to enable/disable Virtual Network ACL rules. |
Database |
withKind(DatabaseAccountKind kind)
Set indicates the type of database account. |
Database |
withLocations(List<Location> locations)
Set an array that contains the georeplication locations enabled for the Cosmos DB account. |
Database |
withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)
Set list of Virtual Network ACL rules configured for the Cosmos DB account. |
Methods inherited from com.microsoft.azure.ProxyResource
Methods inherited from com.microsoft.azure.Resource
Methods inherited from java.lang.Object
Constructor Details
DatabaseAccountCreateUpdateParameters
public DatabaseAccountCreateUpdateParameters()
Creates an instance of DatabaseAccountCreateUpdateParameters class.
Method Details
capabilities
public List
Get list of Cosmos DB capabilities for the account.
Returns:
connectorOffer
public ConnectorOffer connectorOffer()
Get the cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'.
Returns:
consistencyPolicy
public ConsistencyPolicy consistencyPolicy()
Get the consistency policy for the Cosmos DB account.
Returns:
databaseAccountOfferType
public String databaseAccountOfferType()
Get the offer type for the database.
Returns:
disableKeyBasedMetadataWriteAccess
public Boolean disableKeyBasedMetadataWriteAccess()
Get disable write operations on metadata resources (databases, containers, throughput) via account keys.
Returns:
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:
enableCassandraConnector
public Boolean enableCassandraConnector()
Get enables the cassandra connector on the Cosmos DB C* account.
Returns:
enableMultipleWriteLocations
public Boolean enableMultipleWriteLocations()
Get enables the account to write in multiple locations.
Returns:
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:
isVirtualNetworkFilterEnabled
public Boolean isVirtualNetworkFilterEnabled()
Get flag to indicate whether to enable/disable Virtual Network ACL rules.
Returns:
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:
locations
public List
Get an array that contains the georeplication locations enabled for the Cosmos DB account.
Returns:
virtualNetworkRules
public List
Get list of Virtual Network ACL rules configured for the Cosmos DB account.
Returns:
withCapabilities
public DatabaseAccountCreateUpdateParameters withCapabilities(List
Set list of Cosmos DB capabilities for the account.
Parameters:
Returns:
withConnectorOffer
public DatabaseAccountCreateUpdateParameters withConnectorOffer(ConnectorOffer connectorOffer)
Set the cassandra connector offer type for the Cosmos DB database C* account. Possible values include: 'Small'.
Parameters:
Returns:
withConsistencyPolicy
public DatabaseAccountCreateUpdateParameters withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)
Set the consistency policy for the Cosmos DB account.
Parameters:
Returns:
withDatabaseAccountOfferType
public DatabaseAccountCreateUpdateParameters withDatabaseAccountOfferType(String databaseAccountOfferType)
Set the offer type for the database.
Parameters:
Returns:
withDisableKeyBasedMetadataWriteAccess
public DatabaseAccountCreateUpdateParameters withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)
Set disable write operations on metadata resources (databases, containers, throughput) via account keys.
Parameters:
Returns:
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:
Returns:
withEnableCassandraConnector
public DatabaseAccountCreateUpdateParameters withEnableCassandraConnector(Boolean enableCassandraConnector)
Set enables the cassandra connector on the Cosmos DB C* account.
Parameters:
Returns:
withEnableMultipleWriteLocations
public DatabaseAccountCreateUpdateParameters withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)
Set enables the account to write in multiple locations.
Parameters:
Returns:
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:
Returns:
withIsVirtualNetworkFilterEnabled
public DatabaseAccountCreateUpdateParameters withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)
Set flag to indicate whether to enable/disable Virtual Network ACL rules.
Parameters:
Returns:
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:
Returns:
withLocations
public DatabaseAccountCreateUpdateParameters withLocations(List
Set an array that contains the georeplication locations enabled for the Cosmos DB account.
Parameters:
Returns:
withVirtualNetworkRules
public DatabaseAccountCreateUpdateParameters withVirtualNetworkRules(List
Set list of Virtual Network ACL rules configured for the Cosmos DB account.
Parameters:
Returns:
Applies to
Azure SDK for Java
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for