Support for toggling features of an Azure Cosmos DB account

[andrewmetcalfbede]

Is there an existing issue for this?

• I have searched the existing issues

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Currently there doesn't appear to be a way to toggle anything under the Features tab of an Azure Cosmos DB account using Terraform.

Burst capacity in particular is what we'd like to be able to switch on

New or Affected Resource(s)/Data Source(s)

azurerm_cosmosdb_account

Potential Terraform Configuration

No response

References

No response

[AErmie]

An alternative work-around, until these features are supported in the Terraform provider, is to use the AzAPI provider.

If you've already deployed your CosmosDB account using Terraform, you will have to use the azapi_update_resource resource. Here's an example:

resource "azapi_update_resource" "cosmosdb_preview_features" {
  depends_on = [ 
    azurerm_cosmosdb_account.cosmosdb_account 
  ]

  type        = "Microsoft.DocumentDB/databaseAccounts@2024-02-15-preview"
  resource_id = azurerm_cosmosdb_account.cosmosdb_account.id
  
  body = jsonencode({
    properties = {
      enablePerRegionPerPartitionAutoscale = true
      enablePriorityBasedExecution = false
      enableBurstCapacity = false      
      enablePartitionMerge = false
      enableMaterializedViews = false
      diagnosticLogSettings = {
        enableFullTextQuery = "None"
      }
    }
  })
}

Note: The only properties I haven't been able to find (looking at an existing resource's template in the portal), is:

• Vector Search for NoSQL API
• Server Side Retry for Cassandra API

NoSQL API Example Features Properties

  body = jsonencode({
    properties = {
      enablePerRegionPerPartitionAutoscale = true
      enablePriorityBasedExecution = false
      enableBurstCapacity = false      
      enablePartitionMerge = false
      enableMaterializedViews = false
      diagnosticLogSettings = {
        enableFullTextQuery = "None"
      }
    }
  })

Cassandra API Example Features Properties

  body = jsonencode({
    properties = {
      enablePerRegionPerPartitionAutoscale = true
      enableBurstCapacity = false      
      enableMaterializedViews = false
      diagnosticLogSettings = {
        enableFullTextQuery = "None"
      }
    }
  })

Gremlin API Example Features Properties

  body = jsonencode({
    properties = {
      enablePerRegionPerPartitionAutoscale = true
      enableBurstCapacity = false      
      diagnosticLogSettings = {
        enableFullTextQuery = "None"
      }
    }
  })