Skip to content

Cosmos DB for Apache Cassandra account resources must use standard naming#

Operational Excellence · Cosmos DB for Apache Cassandra account · Rule · 2025_12 · Awareness

Cosmos DB for Apache Cassandra account resources without a standard naming convention may be difficult to identify and manage.

Description#

An effective naming convention allows operators to quickly identify resources, related systems, and their purpose. Identifying resources easily is important to improve operational efficiency, reduce the time to respond to incidents, and minimize the risk of human error.

Some of the benefits of using standardized tagging and naming conventions are:

  • They provide consistency and clarity for resource identification and discovery across the Azure Portal, CLIs, and APIs.
  • They enable filtering and grouping of resources for billing, monitoring, security, and compliance purposes.
  • They support resource lifecycle management, such as provisioning, decommissioning, backup, and recovery.

For example, if you come upon a security incident, it's critical to quickly identify affected systems, the functions that those systems support, and the potential business impact.

For Cosmos DB for Apache Cassandra account, the Cloud Adoption Framework (CAF) recommends using the coscas- prefix.

Requirements for Cosmos DB for Apache Cassandra account resource names:

  • Between 3 and 44 characters long.
  • Can include alphanumeric characters, hyphens, underscores, and periods (restrictions vary by resource type).
  • Resource names must be unique within their scope.

Recommendation#

Consider creating Cosmos DB for Apache Cassandra account resources with a standard name. Additionally consider using Azure Policy to only permit creation using a standard naming convention.

Examples#

Configure with Bicep#

To deploy accounts that pass this rule:

  • Set the name property to a string that matches the naming requirements.
  • Optionally, consider constraining name parameters with minLength and maxLength attributes.

For example:

Azure Bicep snippet
@minLength(3)
@maxLength(44)
@description('The name of the resource.')
param name string

@description('The location resources will be deployed.')
param location string = resourceGroup().location

resource cassandra 'Microsoft.DocumentDB/databaseAccounts@2025-04-15' = {
  name: name
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: [
      {
        name: 'EnableCassandra'
      }
    ]
    locations: [
      {
        locationName: location
        failoverPriority: 0
        isZoneRedundant: true
      }
    ]
    databaseAccountOfferType: 'Standard'
    minimalTlsVersion: 'Tls12'
    backupPolicy: {
      type: 'Periodic'
      periodicModeProperties: {
        backupIntervalInMinutes: 240
        backupRetentionIntervalInHours: 8
        backupStorageRedundancy: 'Geo'
      }
    }
  }
}

Configure with Azure Verified Modules

A pre-validated module supported by Microsoft is available from the Azure Bicep public registry. To reference the module, please use the following syntax:

br/public:avm/res/document-db/database-account:<version>

To use the latest version:

br/public:avm/res/document-db/database-account:0.9.0

Configure with Azure template#

To deploy accounts that pass this rule:

  • Set the name property to a string that matches the naming requirements.
  • Optionally, consider constraining name parameters with minLength and maxLength attributes.

For example:

Azure Template snippet
{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "name": {
      "type": "string",
      "minLength": 3,
      "maxLength": 44,
      "metadata": {
        "description": "The name of the resource."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "The location resources will be deployed."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.DocumentDB/databaseAccounts",
      "apiVersion": "2025-04-15",
      "name": "[parameters('name')]",
      "location": "[parameters('location')]",
      "kind": "GlobalDocumentDB",
      "properties": {
        "capabilities": [
          {
            "name": "EnableCassandra"
          }
        ],
        "locations": [
          {
            "locationName": "[parameters('location')]",
            "failoverPriority": 0,
            "isZoneRedundant": true
          }
        ],
        "databaseAccountOfferType": "Standard",
        "minimalTlsVersion": "Tls12",
        "backupPolicy": {
          "type": "Periodic",
          "periodicModeProperties": {
            "backupIntervalInMinutes": 240,
            "backupRetentionIntervalInHours": 8,
            "backupStorageRedundancy": "Geo"
          }
        }
      }
    }
  ]
}

Notes#

This rule does not check if Cosmos DB for Apache Cassandra account resource names are unique.

Rule configuration#

AZURE_COSMOS_CASSANDRA_NAME_FORMAT

To configure this rule set the AZURE_COSMOS_CASSANDRA_NAME_FORMAT configuration value to a regular expression that matches the required format.

For example:

configuration:
  AZURE_COSMOS_CASSANDRA_NAME_FORMAT: '^coscas-'

Comments