Cosmos Database Database Account

This table represents the Cosmos Database Database Account resource from Microsoft Azure.

azure.document_db_database_account

Fields

TitleIDTypeData TypeDescription
_keycorestring
analytical_storage_configurationcorejsonAnalytical storage specific properties.
api_propertiescorejsonAPI specific properties.
backup_policycorejsonThe object representing the policy for taking backups on an account.
capabilitiescorejsonList of Cosmos DB capabilities for the account
capacitycorejsonThe object that represents all properties related to capacity enforcement on an account.
connector_offercorestringThe cassandra connector offer type for the Cosmos DB database C* account.
consistency_policycorejsonThe consistency policy for the Cosmos DB database account.
corscorejsonThe CORS policy for the Cosmos DB database account.
create_modecorestringEnum to indicate the mode of account creation.
customer_managed_key_statuscorestringIndicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
database_account_offer_typecorestringThe offer type for the Cosmos DB database account. Default value: Standard.
default_identitycorestringThe 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.
disable_key_based_metadata_write_accesscoreboolDisable write operations on metadata resources (databases, containers, throughput) via account keys
disable_local_authcoreboolOpt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
document_endpointcorestringThe connection endpoint for the Cosmos DB database account.
enable_analytical_storagecoreboolFlag to indicate whether to enable storage analytics.
enable_automatic_failovercoreboolEnables 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.
enable_burst_capacitycoreboolFlag to indicate enabling/disabling of Burst Capacity feature on the account
enable_cassandra_connectorcoreboolEnables the cassandra connector on the Cosmos DB C* account
enable_free_tiercoreboolFlag to indicate whether Free Tier is enabled.
enable_multiple_write_locationscoreboolEnables the account to write in multiple locations
enable_partition_mergecoreboolFlag to indicate enabling/disabling of Partition Merge feature on the account
failover_policiescorejsonAn array that contains the regions ordered by their failover priorities.
idcorestringThe unique resource identifier of the ARM resource.
identitycorejson
instance_idcorestringA unique identifier assigned to the database account
ip_rulescorejsonList of IpRules.
is_virtual_network_filter_enabledcoreboolFlag to indicate whether to enable/disable Virtual Network ACL rules.
key_vault_key_uricorestringThe URI of the key vault
keys_metadatacorejsonThe object that represents the metadata for the Account Keys of the Cosmos DB account.
kindcorestringIndicates the type of database account. This can only be set at database account creation.
locationcorestringThe location of the resource group to which the resource belongs.
locationscorejsonAn array that contains all of the locations enabled for the Cosmos DB account.
minimal_tls_versioncorestringIndicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
namecorestringThe name of the ARM resource.
network_acl_bypasscorestringIndicates what services are allowed to bypass firewall checks.
network_acl_bypass_resource_idscorearray<string>An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
private_endpoint_connectionscorejsonList of Private Endpoint Connections configured for the Cosmos DB account.
provisioning_statecorestring
public_network_accesscorestringWhether requests from Public Network are allowed
read_locationscorejsonAn array that contains of the read locations enabled for the Cosmos DB account.
resource_groupcorestring
restore_parameterscorejsonParameters to indicate the information about the restore.
subscription_idcorestring
subscription_namecorestring
system_datacorejsonThe system meta data relating to this resource.
tagscorehstore
typecorestringThe type of Azure resource.
virtual_network_rulescorejsonList of Virtual Network ACL rules configured for the Cosmos DB account.
write_locationscorejsonAn array that contains the write location for the Cosmos DB account.