DatabaseAccountGetProperties Class

Package:

com.azure.resourcemanager.cosmos.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.54.2

• java.lang.Object
• • com.azure.resourcemanager.cosmos.fluent.models.DatabaseAccountGetProperties

Implements

JsonSerializable<DatabaseAccountGetProperties>

public final class DatabaseAccountGetProperties
implements JsonSerializable<DatabaseAccountGetProperties>

Properties for the database account.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
AnalyticalStorageConfiguration	analyticalStorageConfiguration() Get the analyticalStorageConfiguration property: Analytical storage specific properties.
ApiProperties	apiProperties() Get the apiProperties property: API specific properties.
BackupPolicy	backupPolicy() Get the backupPolicy property: The object representing the policy for taking backups on an account.
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.
ConnectorOffer	connectorOffer() Get the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
ConsistencyPolicy	consistencyPolicy() Get the consistencyPolicy property: The consistency policy for the Cosmos DB database account.
List<CorsPolicy>	cors() Get the cors property: The CORS policy for the Cosmos DB database account.
CreateMode	createMode() Get the createMode property: Enum to indicate the mode of account creation.
String	customerManagedKeyStatus() Get the customerManagedKeyStatus property: Indicates the status of the Customer Managed Key feature on the account.
DatabaseAccountOfferType	databaseAccountOfferType() Get the databaseAccountOfferType property: The offer type for the Cosmos DB database account.
String	defaultIdentity() Get the defaultIdentity property: The default identity for accessing key vault used in features like customer managed keys.
DefaultPriorityLevel	defaultPriorityLevel() Get the defaultPriorityLevel property: Enum to indicate default Priority Level of request for Priority Based Execution.
Boolean	disableKeyBasedMetadataWriteAccess() Get the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
Boolean	disableLocalAuth() Get the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
String	documentEndpoint() Get the documentEndpoint property: The connection endpoint for the Cosmos DB database account.
Boolean	enableAnalyticalStorage() Get the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.
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.
Boolean	enableBurstCapacity() Get the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.
Boolean	enableCassandraConnector() Get the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
Boolean	enableFreeTier() Get the enableFreeTier property: Flag to indicate whether Free Tier is enabled.
Boolean	enableMultipleWriteLocations() Get the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
Boolean	enablePartitionMerge() Get the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.
Boolean	enablePerRegionPerPartitionAutoscale() Get the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.
Boolean	enablePriorityBasedExecution() Get the enablePriorityBasedExecution property: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account.
List<FailoverPolicy>	failoverPolicies() Get the failoverPolicies property: An array that contains the regions ordered by their failover priorities.
static DatabaseAccountGetProperties	fromJson(JsonReader jsonReader) Reads an instance of DatabaseAccountGetProperties from the JsonReader.
String	instanceId() Get the instanceId property: A unique identifier assigned to the database account.
List<IpAddressOrRange>	ipRules() Get the ipRules property: List of IpRules.
Boolean	isVirtualNetworkFilterEnabled() Get the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountKeysMetadata	keysMetadata() Get the keysMetadata property: The object that represents the metadata for the Account Keys of the Cosmos DB account.
String	keyVaultKeyUri() Get the keyVaultKeyUri property: The URI of the key vault.
String	keyVaultKeyUriVersion() Get the keyVaultKeyUriVersion property: The version of the Customer Managed Key currently being used by the account.
List<Location>	locations() Get the locations property: An array that contains all of the locations enabled for the Cosmos DB account.
MinimalTlsVersion	minimalTlsVersion() Get the minimalTlsVersion property: Indicates the minimum allowed Tls version.
NetworkAclBypass	networkAclBypass() Get the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.
List<String>	networkAclBypassResourceIds() Get the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
List<PrivateEndpointConnectionInner>	privateEndpointConnections() Get the privateEndpointConnections property: List of Private Endpoint Connections configured for the Cosmos DB account.
String	provisioningState() Get the provisioningState property: The status of the Cosmos DB account at the time the operation was called.
PublicNetworkAccess	publicNetworkAccess() Get the publicNetworkAccess property: Whether requests from Public Network are allowed.
List<Location>	readLocations() Get the readLocations property: An array that contains of the read locations enabled for the Cosmos DB account.
RestoreParameters	restoreParameters() Get the restoreParameters property: Parameters to indicate the information about the restore.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
List<VirtualNetworkRule>	virtualNetworkRules() Get the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
DatabaseAccountGetProperties	withAnalyticalStorageConfiguration(AnalyticalStorageConfiguration analyticalStorageConfiguration) Set the analyticalStorageConfiguration property: Analytical storage specific properties.
DatabaseAccountGetProperties	withApiProperties(ApiProperties apiProperties) Set the apiProperties property: API specific properties.
DatabaseAccountGetProperties	withBackupPolicy(BackupPolicy backupPolicy) Set the backupPolicy property: The object representing the policy for taking backups on an account.
DatabaseAccountGetProperties	withCapabilities(List<Capability> capabilities) Set the capabilities property: List of Cosmos DB capabilities for the account.
DatabaseAccountGetProperties	withCapacity(Capacity capacity) Set the capacity property: The object that represents all properties related to capacity enforcement on an account.
DatabaseAccountGetProperties	withConnectorOffer(ConnectorOffer connectorOffer) Set the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.
DatabaseAccountGetProperties	withConsistencyPolicy(ConsistencyPolicy consistencyPolicy) Set the consistencyPolicy property: The consistency policy for the Cosmos DB database account.
DatabaseAccountGetProperties	withCors(List<CorsPolicy> cors) Set the cors property: The CORS policy for the Cosmos DB database account.
DatabaseAccountGetProperties	withCreateMode(CreateMode createMode) Set the createMode property: Enum to indicate the mode of account creation.
DatabaseAccountGetProperties	withCustomerManagedKeyStatus(String customerManagedKeyStatus) Set the customerManagedKeyStatus property: Indicates the status of the Customer Managed Key feature on the account.
DatabaseAccountGetProperties	withDefaultIdentity(String defaultIdentity) Set the defaultIdentity property: The default identity for accessing key vault used in features like customer managed keys.
DatabaseAccountGetProperties	withDefaultPriorityLevel(DefaultPriorityLevel defaultPriorityLevel) Set the defaultPriorityLevel property: Enum to indicate default Priority Level of request for Priority Based Execution.
DatabaseAccountGetProperties	withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess) Set the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.
DatabaseAccountGetProperties	withDisableLocalAuth(Boolean disableLocalAuth) Set the disableLocalAuth property: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
DatabaseAccountGetProperties	withEnableAnalyticalStorage(Boolean enableAnalyticalStorage) Set the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.
DatabaseAccountGetProperties	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.
DatabaseAccountGetProperties	withEnableBurstCapacity(Boolean enableBurstCapacity) Set the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.
DatabaseAccountGetProperties	withEnableCassandraConnector(Boolean enableCassandraConnector) Set the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.
DatabaseAccountGetProperties	withEnableFreeTier(Boolean enableFreeTier) Set the enableFreeTier property: Flag to indicate whether Free Tier is enabled.
DatabaseAccountGetProperties	withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations) Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.
DatabaseAccountGetProperties	withEnablePartitionMerge(Boolean enablePartitionMerge) Set the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.
DatabaseAccountGetProperties	withEnablePerRegionPerPartitionAutoscale(Boolean enablePerRegionPerPartitionAutoscale) Set the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.
DatabaseAccountGetProperties	withEnablePriorityBasedExecution(Boolean enablePriorityBasedExecution) Set the enablePriorityBasedExecution property: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account.
DatabaseAccountGetProperties	withIpRules(List<IpAddressOrRange> ipRules) Set the ipRules property: List of IpRules.
DatabaseAccountGetProperties	withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled) Set the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.
DatabaseAccountGetProperties	withKeyVaultKeyUri(String keyVaultKeyUri) Set the keyVaultKeyUri property: The URI of the key vault.
DatabaseAccountGetProperties	withMinimalTlsVersion(MinimalTlsVersion minimalTlsVersion) Set the minimalTlsVersion property: Indicates the minimum allowed Tls version.
DatabaseAccountGetProperties	withNetworkAclBypass(NetworkAclBypass networkAclBypass) Set the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.
DatabaseAccountGetProperties	withNetworkAclBypassResourceIds(List<String> networkAclBypassResourceIds) Set the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
DatabaseAccountGetProperties	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Whether requests from Public Network are allowed.
DatabaseAccountGetProperties	withRestoreParameters(RestoreParameters restoreParameters) Set the restoreParameters property: Parameters to indicate the information about the restore.
DatabaseAccountGetProperties	withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules) Set the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.
List<Location>	writeLocations() Get the writeLocations property: An array that contains the write location for the Cosmos DB account.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DatabaseAccountGetProperties

public DatabaseAccountGetProperties()

Creates an instance of DatabaseAccountGetProperties class.

Method Details

analyticalStorageConfiguration

public AnalyticalStorageConfiguration analyticalStorageConfiguration()

Get the analyticalStorageConfiguration property: Analytical storage specific properties.

Returns:

the analyticalStorageConfiguration value.

apiProperties

public ApiProperties apiProperties()

Get the apiProperties property: API specific properties.

Returns:

the apiProperties value.

backupPolicy

public BackupPolicy backupPolicy()

Get the backupPolicy property: The object representing the policy for taking backups on an account.

Returns:

the backupPolicy value.

capabilities

public List<Capability> capabilities()

Get the capabilities property: List of Cosmos DB capabilities for the account.

Returns:

the capabilities value.

capacity

public Capacity capacity()

Get the capacity property: The object that represents all properties related to capacity enforcement on an account.

Returns:

the capacity value.

connectorOffer

public ConnectorOffer connectorOffer()

Get the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.

Returns:

the connectorOffer value.

consistencyPolicy

public ConsistencyPolicy consistencyPolicy()

Get the consistencyPolicy property: The consistency policy for the Cosmos DB database account.

Returns:

the consistencyPolicy value.

cors

public List<CorsPolicy> cors()

Get the cors property: The CORS policy for the Cosmos DB database account.

Returns:

the cors value.

createMode

public CreateMode createMode()

Get the createMode property: Enum to indicate the mode of account creation.

Returns:

the createMode value.

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:

the customerManagedKeyStatus value.

databaseAccountOfferType

public DatabaseAccountOfferType databaseAccountOfferType()

Get the databaseAccountOfferType property: The offer type for the Cosmos DB database account. Default value: Standard.

Returns:

the databaseAccountOfferType value.

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:

the defaultIdentity value.

defaultPriorityLevel

public DefaultPriorityLevel defaultPriorityLevel()

Get the defaultPriorityLevel property: Enum to indicate default Priority Level of request for Priority Based Execution.

Returns:

the defaultPriorityLevel value.

disableKeyBasedMetadataWriteAccess

public Boolean disableKeyBasedMetadataWriteAccess()

Get the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.

Returns:

the disableKeyBasedMetadataWriteAccess value.

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:

the disableLocalAuth value.

documentEndpoint

public String documentEndpoint()

Get the documentEndpoint property: The connection endpoint for the Cosmos DB database account.

Returns:

the documentEndpoint value.

enableAnalyticalStorage

public Boolean enableAnalyticalStorage()

Get the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.

Returns:

the enableAnalyticalStorage value.

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:

the enableAutomaticFailover value.

enableBurstCapacity

public Boolean enableBurstCapacity()

Get the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.

Returns:

the enableBurstCapacity value.

enableCassandraConnector

public Boolean enableCassandraConnector()

Get the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.

Returns:

the enableCassandraConnector value.

enableFreeTier

public Boolean enableFreeTier()

Get the enableFreeTier property: Flag to indicate whether Free Tier is enabled.

Returns:

the enableFreeTier value.

enableMultipleWriteLocations

public Boolean enableMultipleWriteLocations()

Get the enableMultipleWriteLocations property: Enables the account to write in multiple locations.

Returns:

the enableMultipleWriteLocations value.

enablePartitionMerge

public Boolean enablePartitionMerge()

Get the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.

Returns:

the enablePartitionMerge value.

enablePerRegionPerPartitionAutoscale

public Boolean enablePerRegionPerPartitionAutoscale()

Get the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.

Returns:

the enablePerRegionPerPartitionAutoscale value.

enablePriorityBasedExecution

public Boolean enablePriorityBasedExecution()

Get the enablePriorityBasedExecution property: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account.

Returns:

the enablePriorityBasedExecution value.

failoverPolicies

public List<FailoverPolicy> failoverPolicies()

Get the failoverPolicies property: An array that contains the regions ordered by their failover priorities.

Returns:

the failoverPolicies value.

fromJson

public static DatabaseAccountGetProperties fromJson(JsonReader jsonReader)

Reads an instance of DatabaseAccountGetProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DatabaseAccountGetProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the DatabaseAccountGetProperties.

instanceId

public String instanceId()

Get the instanceId property: A unique identifier assigned to the database account.

Returns:

the instanceId value.

ipRules

public List<IpAddressOrRange> ipRules()

Get the ipRules property: List of IpRules.

Returns:

the ipRules value.

isVirtualNetworkFilterEnabled

public Boolean isVirtualNetworkFilterEnabled()

Get the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.

Returns:

the isVirtualNetworkFilterEnabled value.

keysMetadata

public DatabaseAccountKeysMetadata keysMetadata()

Get the keysMetadata property: The object that represents the metadata for the Account Keys of the Cosmos DB account.

Returns:

the keysMetadata value.

keyVaultKeyUri

public String keyVaultKeyUri()

Get the keyVaultKeyUri property: The URI of the key vault.

Returns:

the keyVaultKeyUri value.

keyVaultKeyUriVersion

public String keyVaultKeyUriVersion()

Get the keyVaultKeyUriVersion property: The version of the Customer Managed Key currently being used by the account.

Returns:

the keyVaultKeyUriVersion value.

locations

public List<Location> locations()

Get the locations property: An array that contains all of the locations enabled for the Cosmos DB account.

Returns:

the locations value.

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:

the minimalTlsVersion value.

networkAclBypass

public NetworkAclBypass networkAclBypass()

Get the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.

Returns:

the networkAclBypass value.

networkAclBypassResourceIds

public List<String> networkAclBypassResourceIds()

Get the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

Returns:

the networkAclBypassResourceIds value.

privateEndpointConnections

public List<PrivateEndpointConnectionInner> privateEndpointConnections()

Get the privateEndpointConnections property: List of Private Endpoint Connections configured for the Cosmos DB account.

Returns:

the privateEndpointConnections value.

provisioningState

public String provisioningState()

Get the provisioningState property: The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

Returns:

the provisioningState value.

publicNetworkAccess

public PublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: Whether requests from Public Network are allowed.

Returns:

the publicNetworkAccess value.

readLocations

public List<Location> readLocations()

Get the readLocations property: An array that contains of the read locations enabled for the Cosmos DB account.

Returns:

the readLocations value.

restoreParameters

public RestoreParameters restoreParameters()

Get the restoreParameters property: Parameters to indicate the information about the restore.

Returns:

the restoreParameters value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

virtualNetworkRules

public List<VirtualNetworkRule> virtualNetworkRules()

Get the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.

Returns:

the virtualNetworkRules value.

withAnalyticalStorageConfiguration

public DatabaseAccountGetProperties withAnalyticalStorageConfiguration(AnalyticalStorageConfiguration analyticalStorageConfiguration)

Set the analyticalStorageConfiguration property: Analytical storage specific properties.

Parameters:

analyticalStorageConfiguration - the analyticalStorageConfiguration value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withApiProperties

public DatabaseAccountGetProperties withApiProperties(ApiProperties apiProperties)

Set the apiProperties property: API specific properties.

Parameters:

apiProperties - the apiProperties value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withBackupPolicy

public DatabaseAccountGetProperties withBackupPolicy(BackupPolicy backupPolicy)

Set the backupPolicy property: The object representing the policy for taking backups on an account.

Parameters:

backupPolicy - the backupPolicy value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withCapabilities

public DatabaseAccountGetProperties withCapabilities(List<Capability> capabilities)

Set the capabilities property: List of Cosmos DB capabilities for the account.

Parameters:

capabilities - the capabilities value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withCapacity

public DatabaseAccountGetProperties withCapacity(Capacity capacity)

Set the capacity property: The object that represents all properties related to capacity enforcement on an account.

Parameters:

capacity - the capacity value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withConnectorOffer

public DatabaseAccountGetProperties withConnectorOffer(ConnectorOffer connectorOffer)

Set the connectorOffer property: The cassandra connector offer type for the Cosmos DB database C* account.

Parameters:

connectorOffer - the connectorOffer value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withConsistencyPolicy

public DatabaseAccountGetProperties withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)

Set the consistencyPolicy property: The consistency policy for the Cosmos DB database account.

Parameters:

consistencyPolicy - the consistencyPolicy value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withCors

public DatabaseAccountGetProperties withCors(List<CorsPolicy> cors)

Set the cors property: The CORS policy for the Cosmos DB database account.

Parameters:

cors - the cors value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withCreateMode

public DatabaseAccountGetProperties withCreateMode(CreateMode createMode)

Set the createMode property: Enum to indicate the mode of account creation.

Parameters:

createMode - the createMode value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withCustomerManagedKeyStatus

public DatabaseAccountGetProperties 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:

customerManagedKeyStatus - the customerManagedKeyStatus value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withDefaultIdentity

public DatabaseAccountGetProperties 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:

defaultIdentity - the defaultIdentity value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withDefaultPriorityLevel

public DatabaseAccountGetProperties withDefaultPriorityLevel(DefaultPriorityLevel defaultPriorityLevel)

Set the defaultPriorityLevel property: Enum to indicate default Priority Level of request for Priority Based Execution.

Parameters:

defaultPriorityLevel - the defaultPriorityLevel value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withDisableKeyBasedMetadataWriteAccess

public DatabaseAccountGetProperties withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)

Set the disableKeyBasedMetadataWriteAccess property: Disable write operations on metadata resources (databases, containers, throughput) via account keys.

Parameters:

disableKeyBasedMetadataWriteAccess - the disableKeyBasedMetadataWriteAccess value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withDisableLocalAuth

public DatabaseAccountGetProperties 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:

disableLocalAuth - the disableLocalAuth value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnableAnalyticalStorage

public DatabaseAccountGetProperties withEnableAnalyticalStorage(Boolean enableAnalyticalStorage)

Set the enableAnalyticalStorage property: Flag to indicate whether to enable storage analytics.

Parameters:

enableAnalyticalStorage - the enableAnalyticalStorage value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnableAutomaticFailover

public DatabaseAccountGetProperties 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:

enableAutomaticFailover - the enableAutomaticFailover value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnableBurstCapacity

public DatabaseAccountGetProperties withEnableBurstCapacity(Boolean enableBurstCapacity)

Set the enableBurstCapacity property: Flag to indicate enabling/disabling of Burst Capacity feature on the account.

Parameters:

enableBurstCapacity - the enableBurstCapacity value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnableCassandraConnector

public DatabaseAccountGetProperties withEnableCassandraConnector(Boolean enableCassandraConnector)

Set the enableCassandraConnector property: Enables the cassandra connector on the Cosmos DB C* account.

Parameters:

enableCassandraConnector - the enableCassandraConnector value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnableFreeTier

public DatabaseAccountGetProperties withEnableFreeTier(Boolean enableFreeTier)

Set the enableFreeTier property: Flag to indicate whether Free Tier is enabled.

Parameters:

enableFreeTier - the enableFreeTier value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnableMultipleWriteLocations

public DatabaseAccountGetProperties withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)

Set the enableMultipleWriteLocations property: Enables the account to write in multiple locations.

Parameters:

enableMultipleWriteLocations - the enableMultipleWriteLocations value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnablePartitionMerge

public DatabaseAccountGetProperties withEnablePartitionMerge(Boolean enablePartitionMerge)

Set the enablePartitionMerge property: Flag to indicate enabling/disabling of Partition Merge feature on the account.

Parameters:

enablePartitionMerge - the enablePartitionMerge value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnablePerRegionPerPartitionAutoscale

public DatabaseAccountGetProperties withEnablePerRegionPerPartitionAutoscale(Boolean enablePerRegionPerPartitionAutoscale)

Set the enablePerRegionPerPartitionAutoscale property: Flag to indicate enabling/disabling of PerRegionPerPartitionAutoscale feature on the account.

Parameters:

enablePerRegionPerPartitionAutoscale - the enablePerRegionPerPartitionAutoscale value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withEnablePriorityBasedExecution

public DatabaseAccountGetProperties withEnablePriorityBasedExecution(Boolean enablePriorityBasedExecution)

Set the enablePriorityBasedExecution property: Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account.

Parameters:

enablePriorityBasedExecution - the enablePriorityBasedExecution value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withIpRules

public DatabaseAccountGetProperties withIpRules(List<IpAddressOrRange> ipRules)

Set the ipRules property: List of IpRules.

Parameters:

ipRules - the ipRules value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withIsVirtualNetworkFilterEnabled

public DatabaseAccountGetProperties withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)

Set the isVirtualNetworkFilterEnabled property: Flag to indicate whether to enable/disable Virtual Network ACL rules.

Parameters:

isVirtualNetworkFilterEnabled - the isVirtualNetworkFilterEnabled value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withKeyVaultKeyUri

public DatabaseAccountGetProperties withKeyVaultKeyUri(String keyVaultKeyUri)

Set the keyVaultKeyUri property: The URI of the key vault.

Parameters:

keyVaultKeyUri - the keyVaultKeyUri value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withMinimalTlsVersion

public DatabaseAccountGetProperties 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:

minimalTlsVersion - the minimalTlsVersion value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withNetworkAclBypass

public DatabaseAccountGetProperties withNetworkAclBypass(NetworkAclBypass networkAclBypass)

Set the networkAclBypass property: Indicates what services are allowed to bypass firewall checks.

Parameters:

networkAclBypass - the networkAclBypass value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withNetworkAclBypassResourceIds

public DatabaseAccountGetProperties withNetworkAclBypassResourceIds(List<String> networkAclBypassResourceIds)

Set the networkAclBypassResourceIds property: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

Parameters:

networkAclBypassResourceIds - the networkAclBypassResourceIds value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withPublicNetworkAccess

public DatabaseAccountGetProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: Whether requests from Public Network are allowed.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withRestoreParameters

public DatabaseAccountGetProperties withRestoreParameters(RestoreParameters restoreParameters)

Set the restoreParameters property: Parameters to indicate the information about the restore.

Parameters:

restoreParameters - the restoreParameters value to set.

Returns:

the DatabaseAccountGetProperties object itself.

withVirtualNetworkRules

public DatabaseAccountGetProperties withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)

Set the virtualNetworkRules property: List of Virtual Network ACL rules configured for the Cosmos DB account.

Parameters:

virtualNetworkRules - the virtualNetworkRules value to set.

Returns:

the DatabaseAccountGetProperties object itself.

writeLocations

public List<Location> writeLocations()

Get the writeLocations property: An array that contains the write location for the Cosmos DB account.

Returns:

the writeLocations value.