Skip to content

[RULE] Add new naming format rules #3548

@BernieWhite

Description

@BernieWhite

Existing rule

No response

Suggested rule

Added additional CAF naming rules that check the naming format of resources.

When implementing the rule use and update the following documentation in addition to the normal requirements for rules.

  • docs/setup/setup-naming-and-tagging.md
  • docs/setup/configuring-rules.md

Some examples of existing rules include:

  • Azure.AI.FoundryNaming
  • Azure.AppInsights.Naming
  • Azure.LB.Naming

These new rules will need tests and will be added to the 2025_12 rule set.

Add new naming format rules for the following resource types:

Resource Resource provider namespace Abbreviation
AKS cluster Microsoft.ContainerService/managedClusters aks
AKS system node pool Microsoft.ContainerService/managedClusters/agentPools (mode: System) npsystem
AKS user node pool Microsoft.ContainerService/managedClusters/agentPools (mode: User) np
Container apps Microsoft.App/containerApps ca
Container apps environment Microsoft.App/managedEnvironments cae
Container apps job Microsoft.App/jobs caj
Container registry Microsoft.ContainerRegistry/registries cr
Container instance Microsoft.ContainerInstance/containerGroups ci
Service Fabric cluster Microsoft.ServiceFabric/clusters sf
Service Fabric managed cluster Microsoft.ServiceFabric/managedClusters sfmc
Azure Cosmos DB for Apache Cassandra account Microsoft.DocumentDB/databaseAccounts coscas
Azure Cosmos DB for MongoDB account Microsoft.DocumentDB/databaseAccounts cosmon
Azure Cosmos DB for NoSQL account Microsoft.DocumentDb/databaseAccounts cosno
Azure Cosmos DB for Table account Microsoft.DocumentDb/databaseAccounts costab
Azure Cosmos DB for Apache Gremlin account Microsoft.DocumentDb/databaseAccounts cosgrm
Azure Cosmos DB PostgreSQL cluster Microsoft.DBforPostgreSQL/serverGroupsv2 cospos
Azure Cache for Redis instance Microsoft.Cache/Redis redis
Azure Managed Redis Microsoft.Cache/RedisEnterprise amr
Azure SQL Database server Microsoft.Sql/servers sql
Azure SQL database Microsoft.Sql/servers/databases sqldb
Azure SQL Elastic Job agent Microsoft.Sql/servers/jobAgents sqlja
Azure SQL Elastic Pool Microsoft.Sql/servers/elasticpool sqlep
MySQL database Microsoft.DBforMySQL/servers mysql
PostgreSQL database Microsoft.DBforPostgreSQL/servers psql
SQL Server Stretch Database Microsoft.Sql/servers/databases sqlstrdb
SQL Managed Instance Microsoft.Sql/managedInstances sqlmi
Azure Cosmos DB database Microsoft.DocumentDB/databaseAccounts/sqlDatabases cosmos

Pillar

Operational Excellence

Additional context

No response

Metadata

Metadata

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions