DatabaseAccountCreateUpdateProperties Class
- java.
lang. Object - com.
azure. resourcemanager. cosmos. fluent. models. DatabaseAccountCreateUpdateProperties
- com.
Implements
public final class DatabaseAccountCreateUpdateProperties
implements JsonSerializable<DatabaseAccountCreateUpdateProperties>
Properties to create and update Azure Cosmos DB database accounts.
Constructor | Description |
---|---|
Database |
Creates an instance of Database |
Modifier and Type | Method and Description |
---|---|
Analytical |
analytical Get the analytical |
Api |
api Get the api |
Backup |
backup Get the backup |
List<Capability> |
capabilities()
Get the capabilities property: List of Cosmos DB capabilities for the account. |
Capacity |
capacity()
Get the capacity property: The object that represents all properties related to capacity enforcement on an account. |
Connector |
connector Get the connector |
Consistency |
consistency Get the consistency |
List<Cors |
cors()
Get the cors property: The CORS policy for the Cosmos DB database account. |
Create |
create Get the create |
String |
customer Get the customer |
String |
database Get the database |
String |
default Get the default |
Boolean |
disable Get the disable |
Boolean |
disable Get the disable |
Boolean |
enable Get the enable |
Boolean |
enable Get the enable |
Boolean |
enable Get the enable |
Boolean |
enable Get the enable |
Boolean |
enable Get the enable |
Boolean |
enable Get the enable |
Boolean |
enable Get the enable |
Boolean |
enable Get the enable |
static
Database |
from Reads an instance of Database |
List<Ip |
ip Get the ip |
Boolean |
is Get the is |
Database |
keys Get the keys |
String |
key Get the key |
List<Location> |
locations()
Get the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account. |
Minimal |
minimal Get the minimal |
Network |
network Get the network |
List<String> |
network Get the network |
Public |
public Get the public |
Restore |
restore Get the restore |
Json |
to |
void |
validate()
Validates the instance. |
List<Virtual |
virtual Get the virtual |
Database |
with Set the analytical |
Database |
with Set the api |
Database |
with Set the backup |
Database |
with Set the capabilities property: List of Cosmos DB capabilities for the account. |
Database |
with Set the capacity property: The object that represents all properties related to capacity enforcement on an account. |
Database |
with Set the connector |
Database |
with Set the consistency |
Database |
with Set the cors property: The CORS policy for the Cosmos DB database account. |
Database |
with Set the create |
Database |
with Set the customer |
Database |
with Set the default |
Database |
with Set the disable |
Database |
with Set the disable |
Database |
with Set the enable |
Database |
with Set the enable |
Database |
with Set the enable |
Database |
with Set the enable |
Database |
with Set the enable |
Database |
with Set the enable |
Database |
with Set the enable |
Database |
with Set the enable |
Database |
with Set the ip |
Database |
with Set the is |
Database |
with Set the key |
Database |
with Set the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account. |
Database |
with Set the minimal |
Database |
with Set the network |
Database |
with Set the network |
Database |
with Set the public |
Database |
with Set the restore |
Database |
with Set the virtual |
Methods inherited from java.lang.Object
DatabaseAccountCreateUpdateProperties
public DatabaseAccountCreateUpdateProperties()
Creates an instance of DatabaseAccountCreateUpdateProperties class.
analyticalStorageConfiguration
public AnalyticalStorageConfiguration analyticalStorageConfiguration()
Get the analyticalStorageConfiguration property: Analytical storage specific properties.
Returns:
apiProperties
public ApiProperties apiProperties()
Get the apiProperties property: API specific properties. Currently, supported only for MongoDB API.
Returns:
backupPolicy
public BackupPolicy backupPolicy()
Get the backupPolicy property: The object representing the policy for taking backups on an account.
Returns:
capabilities
public List
Get the capabilities property: List of Cosmos DB capabilities for the account.
Returns:
capacity
public Capacity capacity()
Get the capacity property: The object that represents all properties related to capacity enforcement on an account.
Returns:
connectorOffer
public ConnectorOffer connectorOffer()
Get the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
Returns:
consistencyPolicy
public ConsistencyPolicy consistencyPolicy()
Get the consistencyPolicy property: The consistency policy for the Cosmos DB account.
Returns:
cors
public List
Get the cors property: The CORS policy for the Cosmos DB database account.
Returns:
createMode
public CreateMode createMode()
Get the createMode property: Enum to indicate the mode of account creation.
Returns:
customerManagedKeyStatus
public String customerManagedKeyStatus()
Get the customerManagedKeyStatus property: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
Returns:
databaseAccountOfferType
public String databaseAccountOfferType()
Get the databaseAccountOfferType property: The offer type for the database.
Returns:
defaultIdentity
public String defaultIdentity()
Get the defaultIdentity property: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
Returns:
disableKeyBasedMetadataWriteAccess
public Boolean disableKeyBasedMetadataWriteAccess()
Get the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
Returns:
disableLocalAuth
public Boolean disableLocalAuth()
Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
Returns:
enableAnalyticalStorage
public Boolean enableAnalyticalStorage()
Get the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.
Returns:
enableAutomaticFailover
public Boolean enableAutomaticFailover()
Get the enableAutomaticFailover property: 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:
enableBurstCapacity
public Boolean enableBurstCapacity()
Get the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.
Returns:
enableCassandraConnector
public Boolean enableCassandraConnector()
Get the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
Returns:
enableFreeTier
public Boolean enableFreeTier()
Get the enableFreeTier property: Flag to indicate whether Free Tier is enabled.
Returns:
enableMultipleWriteLocations
public Boolean enableMultipleWriteLocations()
Get the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
Returns:
enablePartitionMerge
public Boolean enablePartitionMerge()
Get the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.
Returns:
enablePerRegionPerPartitionAutoscale
public Boolean enablePerRegionPerPartitionAutoscale()
Get the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.
Returns:
fromJson
public static DatabaseAccountCreateUpdateProperties fromJson(JsonReader jsonReader)
Reads an instance of DatabaseAccountCreateUpdateProperties from the JsonReader.
Parameters:
Returns:
Throws:
ipRules
public List
Get the ipRules property: List of IpRules.
Returns:
isVirtualNetworkFilterEnabled
public Boolean isVirtualNetworkFilterEnabled()
Get the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
Returns:
keysMetadata
public DatabaseAccountKeysMetadata keysMetadata()
Get the keysMetadata property: This property is ignored during the update/create operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.
Returns:
keyVaultKeyUri
public String keyVaultKeyUri()
Get the keyVaultKeyUri property: The URI of the key vault.
Returns:
locations
public List
Get the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account.
Returns:
minimalTlsVersion
public MinimalTlsVersion minimalTlsVersion()
Get the minimalTlsVersion property: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
Returns:
networkAclBypass
public NetworkAclBypass networkAclBypass()
Get the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.
Returns:
networkAclBypassResourceIds
public List
Get the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
Returns:
publicNetworkAccess
public PublicNetworkAccess publicNetworkAccess()
Get the publicNetworkAccess property: Whether requests from Public Network are allowed.
Returns:
restoreParameters
public RestoreParameters restoreParameters()
Get the restoreParameters property: Parameters to indicate the information about the restore.
Returns:
toJson
validate
public void validate()
Validates the instance.
virtualNetworkRules
public List
Get the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
Returns:
withAnalyticalStorageConfiguration
public DatabaseAccountCreateUpdateProperties withAnalyticalStorageConfiguration(AnalyticalStorageConfiguration analyticalStorageConfiguration)
Set the analyticalStorageConfiguration property: Analytical storage specific properties.
Parameters:
Returns:
withApiProperties
public DatabaseAccountCreateUpdateProperties withApiProperties(ApiProperties apiProperties)
Set the apiProperties property: API specific properties. Currently, supported only for MongoDB API.
Parameters:
Returns:
withBackupPolicy
public DatabaseAccountCreateUpdateProperties withBackupPolicy(BackupPolicy backupPolicy)
Set the backupPolicy property: The object representing the policy for taking backups on an account.
Parameters:
Returns:
withCapabilities
public DatabaseAccountCreateUpdateProperties withCapabilities(List
Set the capabilities property: List of Cosmos DB capabilities for the account.
Parameters:
Returns:
withCapacity
public DatabaseAccountCreateUpdateProperties withCapacity(Capacity capacity)
Set the capacity property: The object that represents all properties related to capacity enforcement on an account.
Parameters:
Returns:
withConnectorOffer
public DatabaseAccountCreateUpdateProperties withConnectorOffer(ConnectorOffer connectorOffer)
Set the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
Parameters:
Returns:
withConsistencyPolicy
public DatabaseAccountCreateUpdateProperties withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)
Set the consistencyPolicy property: The consistency policy for the Cosmos DB account.
Parameters:
Returns:
withCors
public DatabaseAccountCreateUpdateProperties withCors(List
Set the cors property: The CORS policy for the Cosmos DB database account.
Parameters:
Returns:
withCreateMode
public DatabaseAccountCreateUpdateProperties withCreateMode(CreateMode createMode)
Set the createMode property: Enum to indicate the mode of account creation.
Parameters:
Returns:
withCustomerManagedKeyStatus
public DatabaseAccountCreateUpdateProperties withCustomerManagedKeyStatus(String customerManagedKeyStatus)
Set the customerManagedKeyStatus property: Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
Parameters:
Returns:
withDefaultIdentity
public DatabaseAccountCreateUpdateProperties withDefaultIdentity(String defaultIdentity)
Set the defaultIdentity property: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
Parameters:
Returns:
withDisableKeyBasedMetadataWriteAccess
public DatabaseAccountCreateUpdateProperties withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)
Set the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
Parameters:
Returns:
withDisableLocalAuth
public DatabaseAccountCreateUpdateProperties withDisableLocalAuth(Boolean disableLocalAuth)
Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
Parameters:
Returns:
withEnableAnalyticalStorage
public DatabaseAccountCreateUpdateProperties withEnableAnalyticalStorage(Boolean enableAnalyticalStorage)
Set the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.
Parameters:
Returns:
withEnableAutomaticFailover
public DatabaseAccountCreateUpdateProperties withEnableAutomaticFailover(Boolean enableAutomaticFailover)
Set the enableAutomaticFailover property: 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:
withEnableBurstCapacity
public DatabaseAccountCreateUpdateProperties withEnableBurstCapacity(Boolean enableBurstCapacity)
Set the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.
Parameters:
Returns:
withEnableCassandraConnector
public DatabaseAccountCreateUpdateProperties withEnableCassandraConnector(Boolean enableCassandraConnector)
Set the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
Parameters:
Returns:
withEnableFreeTier
public DatabaseAccountCreateUpdateProperties withEnableFreeTier(Boolean enableFreeTier)
Set the enableFreeTier property: Flag to indicate whether Free Tier is enabled.
Parameters:
Returns:
withEnableMultipleWriteLocations
public DatabaseAccountCreateUpdateProperties withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)
Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
Parameters:
Returns:
withEnablePartitionMerge
public DatabaseAccountCreateUpdateProperties withEnablePartitionMerge(Boolean enablePartitionMerge)
Set the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.
Parameters:
Returns:
withEnablePerRegionPerPartitionAutoscale
public DatabaseAccountCreateUpdateProperties withEnablePerRegionPerPartitionAutoscale(Boolean enablePerRegionPerPartitionAutoscale)
Set the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.
Parameters:
Returns:
withIpRules
public DatabaseAccountCreateUpdateProperties withIpRules(List
Set the ipRules property: List of IpRules.
Parameters:
Returns:
withIsVirtualNetworkFilterEnabled
public DatabaseAccountCreateUpdateProperties withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)
Set the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
Parameters:
Returns:
withKeyVaultKeyUri
public DatabaseAccountCreateUpdateProperties withKeyVaultKeyUri(String keyVaultKeyUri)
Set the keyVaultKeyUri property: The URI of the key vault.
Parameters:
Returns:
withLocations
public DatabaseAccountCreateUpdateProperties withLocations(List
Set the locations property: An array that contains the georeplication locations enabled for the Cosmos DB account.
Parameters:
Returns:
withMinimalTlsVersion
public DatabaseAccountCreateUpdateProperties withMinimalTlsVersion(MinimalTlsVersion minimalTlsVersion)
Set the minimalTlsVersion property: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
Parameters:
Returns:
withNetworkAclBypass
public DatabaseAccountCreateUpdateProperties withNetworkAclBypass(NetworkAclBypass networkAclBypass)
Set the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.
Parameters:
Returns:
withNetworkAclBypassResourceIds
public DatabaseAccountCreateUpdateProperties withNetworkAclBypassResourceIds(List
Set the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
Parameters:
Returns:
withPublicNetworkAccess
public DatabaseAccountCreateUpdateProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)
Set the publicNetworkAccess property: Whether requests from Public Network are allowed.
Parameters:
Returns:
withRestoreParameters
public DatabaseAccountCreateUpdateProperties withRestoreParameters(RestoreParameters restoreParameters)
Set the restoreParameters property: Parameters to indicate the information about the restore.
Parameters:
Returns:
withVirtualNetworkRules
public DatabaseAccountCreateUpdateProperties withVirtualNetworkRules(List
Set the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
Parameters:
Returns: