last sync: 2025-Apr-29 17:44:12 Etc/UTC

Database Account - Microsoft Azure Resource type
microsoft.documentdb/databaseaccounts

Azure Resource Provider Resource provider (RP) - Microsoft DocumentDB [Microsoft.DocumentDB]
RP Microsoft.DocumentDB
RP display name Microsoft DocumentDB
Azure Resource Type
RP Resource types
Resource types: 177
Azure Policy Alias
RP aliases
RP aliases: 1112
Azure Policy definition
RP Azure Policy
Azure Policy definitions: 35
if: 35
then.deployment: 0
then.details: 0
then.existenceCondition: 0
then.operations: 0
Azure RBAC Role Based Access Control
RP RBAC operations
RP RBAC operations: 326
RP RBAC operationType action: 64
RP RBAC operationType delete: 39
RP RBAC operationType read: 161
RP RBAC operationType write: 62
Azure RBAC Role definition
RP RBAC Roles & Operation actions
Unique RBAC Roles: 24
RBAC Roles with action operationType: 11
RBAC Roles with delete operationType: 7
RBAC Roles with read operationType: 23
RBAC Roles with write operationType: 8
Azure Application
RP related 1st party Service Principals
RP related 1st party Service Principals: 6
• CosmosDBMongoClusterPrivateEndpoint (appId: e95a6071-4f90-4971-84e2-492d9323345b)
• CosmosDB Dedicated Instance (appId: 36e2398c-9dd3-4f29-9a72-d9f2cfc47ad9)
• Azure OSSRDBMS PostgreSQL Flexible Server AAD Authentication (appId: 5657e26c-cc92-45d9-bc47-9da6cfdb4ed9) [ JSON;CSV]
• Azure CosmosDB for PostgreSQL Microsoft EntraId (appId: ecafc2d9-cf1a-49a7-b60f-e44e34a988d2)
• Azure Cosmos DB Virtual Network To Network Resource Provider (appId: 57c0fc58-a83a-41d0-8ae9-08952659bdfd)
• Azure Cosmos DB (appId: a232010e-820c-4083-83bb-3ace5fc29d0b) [ JSON;CSV]
All Azure RPs Microsoft Learn
AzResourceTypesAdvertizer (Microsoft only)
Azure Resource Type Resource type (RT) - Database Account [microsoft.documentdb/databaseaccounts]
RT information
RT microsoft.documentdb/databaseaccounts
RT display name Database Account
RT type only
(without RP)
databaseAccounts
RT sub- Resource types sub-Resource types: 146
RT schema RT schema API versions: 44
All Microsoft Azure RTs AzResourceTypesAdvertizer
Aliases and Azure Policy
Azure Policy Alias
Aliases
aliases: 140
Azure Policy definition
Azure Policy
Azure Policy definitions: 27
if: 27
then.deployment: 0
then.details: 0
then.existenceCondition: 0
then.operations: 0
RBAC Operations and Roles & Roles related operation actions
Azure RBAC Role Based Access Control
RBAC operations
RBAC operations: 18
RBAC operationType action: 15
RBAC operationType delete: 1
RBAC operationType read: 1
RBAC operationType write: 1
Azure RBAC Role definition
RBAC Roles & Operation actions
Unique RBAC Roles: 23
RBAC Roles with action operationType: 7
RBAC Roles with delete operationType: 7
RBAC Roles with read operationType: 22
RBAC Roles with write operationType: 7
Capabilities & Locations
Azure Resource Diagnostic settings logs
Diagnostic logs
True
log-categories
Azure Resource Diagnostic settings metrics
Diagnostic metrics
True
metrics
Azure Customer-managed key
Customer-managed key (CMK) [experimental]
True
Microsoft Learn
Enforce Encryption with a customer-managed key (CMK) at scale
Azure Managed identity
System-Assigned-Resource-Identity
True
Azure Resource Mover
Cross-ResourceGroup-Resource-Move
True
Azure Resource Mover
Cross-Subscription-Resource-Move
True
Azure Resource Tags
Tags
True
Azure Extension
Extension
False
Azure Private Endpoint
Private-Endpoint
True
Azure Private Endpoint location Azure Private Endpoint location
Supported Locations for Private-Endpoint
Supported Locations for Private-Endpoint: 44
australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralindia, centralus, eastasia, eastus, eastus2, francecentral, germanywestcentral, indonesiacentral, israelcentral, italynorth, japaneast, japanwest, jioindiawest, koreacentral, koreasouth, mexicocentral, newzealandnorth, northcentralus, northeurope, norwayeast, polandcentral, qatarcentral, southafricanorth, southcentralus, southeastasia, southindia, spaincentral, swedencentral, switzerlandnorth, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2, westus3
Non supported Locations for Private-Endpoint Non supported Locations for Private-Endpoint: 14
brazilus, eastusstg, centraluseuap, eastus2euap, southcentralusstg, southafricawest, australiacentral2, jioindiacentral, francesouth, germanynorth, norwaywest, switzerlandwest, uaecentral, brazilsoutheast
Azure location
Location
True
Azure Resource type location Azure Resource type location
Locations
Locations: 43
australiacentral, australiaeast, australiasoutheast, brazilsouth, canadacentral, canadaeast, centralindia, centralus, eastasia, eastus, eastus2, francecentral, germanywestcentral, indonesiacentral, israelcentral, italynorth, japaneast, japanwest, koreacentral, koreasouth, mexicocentral, newzealandnorth, northcentralus, northeurope, norwayeast, polandcentral, qatarcentral, southafricanorth, southcentralus, southeastasia, southindia, spaincentral, swedencentral, switzerlandnorth, uaenorth, uksouth, ukwest, westcentralus, westeurope, westindia, westus, westus2, westus3
Not locations Not locations: 54
asia, asiapacific, australia, australiacentral2, brazil, brazilsoutheast, brazilus, canada, centraluseuap, centralusstage, eastasiastage, eastus2euap, eastus2stage, eastusstage, eastusstg, europe, france, francesouth, germany, germanynorth, global, india, indonesia, israel, italy, japan, jioindiacentral, jioindiawest, korea, mexico, newzealand, northcentralusstage, norway, norwaywest, poland, qatar, singapore, southafrica, southafricawest, southcentralusstage, southcentralusstg, southeastasiastage, spain, sweden, switzerland, switzerlandwest, taiwan, uae, uaecentral, uk, unitedstates, unitedstateseuap, westus2stage, westusstage
Assessment tooling
Azure Advisor
Azure Advisor
Azure Advisor recommendations: 40
Cost [Low] Save cost by using continuous backup with Fabric Mirroring
Cost [Medium] Consider taking action on your idle Azure Cosmos DB containers
Cost [Medium] Enable autoscale on your Azure Cosmos DB database or container
Cost [Medium] Migrate your Azure Cosmos DB API for MongoDB account to v4.2 to save on query/storage costs and utilize new features
Cost [Medium] Review the configuration of your Azure Cosmos DB free tier account
HighAvailability [High] Azure Cosmos DB requires using TLS 1.2 or later
HighAvailability [High] Configure Azure Cosmos DB containers with a partition key
HighAvailability [High] Critical issue - Upgrade to the current recommended version of the Java SDK v4
HighAvailability [High] Enable HA for your Production workload
HighAvailability [High] Enable Server Side Retry (SSR) on your Azure Cosmos DB's API for MongoDB account
HighAvailability [High] Enable zone redundancy for multi-region Cosmos DB accounts
HighAvailability [High] Hotfix - Upgrade to 2.6.14 version of the Async Java SDK v2 or to Java SDK v4
HighAvailability [High] Upgrade outdated Azure Cosmos DB SDK to the latest version
HighAvailability [Medium] Add a second region to your production workloads on Azure Cosmos DB
HighAvailability [Medium] Add at least one data center in another Azure region
HighAvailability [Medium] Avoid being rate limited for Control Plane operation
HighAvailability [Medium] Check linked Azure Key Vault hosting your encryption key
HighAvailability [Medium] Configure consistent indexing mode on Azure Cosmos DB containers
HighAvailability [Medium] Enable service managed failover for Cosmos DB account
HighAvailability [Medium] Upgrade old Azure Cosmos DB SDK to the latest version
HighAvailability [Medium] Upgrade your Azure Cosmos DB API for MongoDB account to v4.2 to save on query/storage costs and utilize new features
HighAvailability [Medium] Use static Cosmos DB client instances in your code and cache the names of databases and collections
HighAvailability [Medium] Use the new 3.6+ endpoint to connect to your upgraded Azure Cosmos DB's API for MongoDB account
OperationalExcellence [High] Enable partition merge to configure an optimal database partition layout
OperationalExcellence [Low] Enable near real-time analytics or reporting on your Azure Cosmos DB data
OperationalExcellence [Medium] Improve resiliency by migrating your Azure Cosmos DB accounts to continuous backup
OperationalExcellence [Medium] Migrate Azure Cosmos DB attachments to Azure Blob Storage
OperationalExcellence [Medium] Monitor Azure Cosmos DB data by using resource-specific diagnostic settings.
Performance [High] Configure your Azure Cosmos DB applications to use Direct connectivity in the SDK
Performance [Low] Take advantage of your database or container's idle throughput capacity to handle spikes of traffic
Performance [Medium] Add missing indexes to your Azure Cosmos DB container
Performance [Medium] Configure your Azure Cosmos DB query page size (MaxItemCount) to -1
Performance [Medium] Get notified when usage exceeds 90% within 12 hours
Performance [Medium] Optimize your Azure Cosmos DB indexing policy to only index what's needed
Performance [Medium] Use hierarchical partition keys for optimal data distribution
Security [Low] [Enable if required] Azure Cosmos DB accounts should use customer-managed keys to encrypt data at rest
Security [Medium] Azure Cosmos DB accounts should have firewall rules
Security [Medium] Azure Cosmos DB accounts should use Azure Active Directory as the only authentication method
Security [Medium] Azure Cosmos DB should disable public network access
Security [Medium] CosmosDB accounts should use private link
Azure Proactive Resilience Library v2 (APRLv2)
Azure Proactive Resilience Library v2 (APRLv2)
Azure Proactive Resilience Library v2 recommendations: 6
DisasterRecovery [High] Enable service-managed failover for multi-region accounts with single write region
DisasterRecovery [High] Configure continuous backup mode
HighAvailability [High] Configure at least two regions for high availability
HighAvailability [High] Enable availability zones
HighAvailability [High] Evaluate multi-region write capability
MonitoringAndAlerting [Medium] Monitor Cosmos DB health and set up alerts
PSRule for Azure
PSRule for Azure
PSRule for Azure rules: 7
Operational Excellence [Awareness] Use valid Cosmos DB account names
Reliability [Important] Enable continuous backup policy
Reliability [Important] Use paid tier for production workloads
Security [Critical] Cosmos DB account access keys are enabled
Security [Critical] Cosmos DB account minimum TLS version
Security [Critical] Disable public network access on Cosmos DB
Security [Important] Restrict user access to data operations in Azure Cosmos DB
Azure Quick Review (AZQR)
Azure Quick Review (AZQR)
Azure Quick Review (AZQR) recommendations: 12
DisasterRecovery [High] Configure continuous backup mode
DisasterRecovery [High] Enable service-managed failover for multi-region accounts with single write region
Governance [Low] CosmosDB Name should comply with naming conventions
Governance [Low] CosmosDB should have tags
HighAvailability [High] Configure at least two regions for high availability
HighAvailability [High] CosmosDB should have a SLA
HighAvailability [High] Enable availability zones
HighAvailability [High] Evaluate multi-region write capability
MonitoringAndAlerting [Low] CosmosDB should have diagnostic settings enabled
Security [High] CosmosDB should have local authentication disabled
Security [High] CosmosDB should have private endpoints enabled
Security [High] CosmosDB: disable write operations on metadata resources (databases, containers, throughput) via account keys
Infrastructure as Code (IaC)
ARM (Azure Resource Manager)
ARM (Azure Resource Manager) templates
ARM (Azure Resource Manager) template API versions: 44
latest
Azure Bicep
Bicep templates
Bicep template API versions: 44
latest
Terraform
Terraform provider
Terraform providers: 1
cosmosdb_account
AzAPI Terraform
AzAPI Terraform templates
AzAPI Terraform template API versions: 44
latest
Pulumi
Pulumi provider
Pulumi providers: 1
cosmosdb/databaseaccount
OpenTofu
OpenTofu provider
OpenTofu TF providers: 1
cosmosdb_account
Azure Verified Modules (AVM) Bicep Azure Verified Modules (AVM) Bicep
Azure Verified Modules (AVM) Bicep
CosmosDB Database Account
Azure Verified Modules (AVM) Terraform Azure Verified Modules (AVM) Terraform
Azure Verified Modules (AVM) Terraform
n/a
REST-API (Representational State Transfer - Application Programming Interface)
REST-API versions REST-API versions: 46
2024-12-01-preview
2024-11-15
2024-09-01-preview
2024-08-15
2024-05-15-preview
2024-05-15
2024-02-15-preview
2023-11-15-preview
2023-11-15
2023-09-15-preview
2023-09-15
2023-04-15
2023-03-15-preview
2023-03-15
2023-03-01-preview
2022-11-15-preview
2022-11-15
2022-08-15-preview
2022-08-15
2022-05-15-preview
2022-05-15
2022-02-15-preview
2021-11-15-preview
2021-10-15-preview
2021-10-15
2021-07-01-preview
2021-06-15
2021-05-15
2021-05-01-preview
2021-04-15
2021-04-01-preview
2021-03-15
2021-03-01-preview
2021-01-15
2020-09-01
2020-06-01-preview
2020-04-01
2020-03-01
2019-12-12
2019-08-01-preview
2019-08-01
2016-03-31
2016-03-19
2015-11-06
2015-04-08
2014-04-01
REST-API version default 2024-05-15-preview
API profiles API profiles: 2
2018-06-01-profile
2015-04-08
Resource naming
Azure Naming Tool
Azure Naming Tool
The Azure Naming Tool was created to help administrators define and manage their naming conventions, while providing a simple interface for users to generate a compliant name.
Resource naming details
{
  "property": "",
  "ShortName": "dbact",
  "scope": "global",
  "lengthMin": "3",
  "lengthMax": "44",
  "validText": "Lowercase letters, numbers, and hyphens. Start with lowercase letter or number.",
  "invalidText": "",
  "invalidCharacters": "",
  "invalidCharactersStart": "",
  "invalidCharactersEnd": "",
  "invalidCharactersConsecutive": "",
  "regx": "^[a-z0-9][a-z0-9-]{2,43}$",
  "staticValues": ""
}