Package com.microsoft.azure.management.cosmosdb

Class DatabaseAccountUpdateParameters

java.lang.Object
com.microsoft.azure.management.cosmosdb.DatabaseAccountUpdateParameters
public class DatabaseAccountUpdateParameters extends Object
Parameters for patching Azure Cosmos DB database account properties.

  • Constructor Details

    • DatabaseAccountUpdateParameters

      public DatabaseAccountUpdateParameters()

  • Method Details

    • tags

      public Map<String,String> tags()
      Get the tags value.
      Returns:
      the tags value

    • withTags

      public DatabaseAccountUpdateParameters withTags(Map<String,String> tags)
      Set the tags value.
      Parameters:
      tags - the tags value to set
      Returns:
      the DatabaseAccountUpdateParameters object itself.

    • location

      public String location()
      Get the location of the resource group to which the resource belongs.
      Returns:
      the location value

    • withLocation

      public DatabaseAccountUpdateParameters withLocation(String location)
      Set the location of the resource group to which the resource belongs.
      Parameters:
      location - the location value to set
      Returns:
      the DatabaseAccountUpdateParameters object itself.

    • consistencyPolicy

      public ConsistencyPolicy consistencyPolicy()
      Get the consistency policy for the Cosmos DB account.
      Returns:
      the consistencyPolicy value

    • withConsistencyPolicy

      public DatabaseAccountUpdateParameters withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)
      Set the consistency policy for the Cosmos DB account.
      Parameters:
      consistencyPolicy - the consistencyPolicy value to set
      Returns:
      the DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters object itself.

    • isVirtualNetworkFilterEnabled

      public Boolean isVirtualNetworkFilterEnabled()
      Get flag to indicate whether to enable/disable Virtual Network ACL rules.
      Returns:
      the isVirtualNetworkFilterEnabled value

    • withIsVirtualNetworkFilterEnabled

      public DatabaseAccountUpdateParameters withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)
      Set flag to indicate whether to enable/disable Virtual Network ACL rules.
      Parameters:
      isVirtualNetworkFilterEnabled - the isVirtualNetworkFilterEnabled value to set
      Returns:
      the DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters object itself.

    • capabilities

      public List<Capability> capabilities()
      Get list of Cosmos DB capabilities for the account.
      Returns:
      the capabilities value

    • withCapabilities

      public DatabaseAccountUpdateParameters withCapabilities(List<Capability> capabilities)
      Set list of Cosmos DB capabilities for the account.
      Parameters:
      capabilities - the capabilities value to set
      Returns:
      the DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters object itself.

    • enableMultipleWriteLocations

      public Boolean enableMultipleWriteLocations()
      Get enables the account to write in multiple locations.
      Returns:
      the enableMultipleWriteLocations value

    • withEnableMultipleWriteLocations

      public DatabaseAccountUpdateParameters withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)
      Set enables the account to write in multiple locations.
      Parameters:
      enableMultipleWriteLocations - the enableMultipleWriteLocations value to set
      Returns:
      the DatabaseAccountUpdateParameters object itself.

    • enableCassandraConnector

      public Boolean enableCassandraConnector()
      Get enables the cassandra connector on the Cosmos DB C* account.
      Returns:
      the enableCassandraConnector value

    • withEnableCassandraConnector

      public DatabaseAccountUpdateParameters withEnableCassandraConnector(Boolean enableCassandraConnector)
      Set enables the cassandra connector on the Cosmos DB C* account.
      Parameters:
      enableCassandraConnector - the enableCassandraConnector value to set
      Returns:
      the DatabaseAccountUpdateParameters object itself.

    • 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

    • withConnectorOffer

      public DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters object itself.

    • disableKeyBasedMetadataWriteAccess

      public Boolean disableKeyBasedMetadataWriteAccess()
      Get disable write operations on metadata resources (databases, containers, throughput) via account keys.
      Returns:
      the disableKeyBasedMetadataWriteAccess value

    • withDisableKeyBasedMetadataWriteAccess

      public DatabaseAccountUpdateParameters 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 DatabaseAccountUpdateParameters object itself.