Skip to content

2. Naming Conventions

Conventions

  • As much as possible, Resources and Resource Groups should use the <ar> prefix. This ensures that the resources that require unique naming across all Azure resources have lower chances of collision/conflicts.

  • As much as possible, Resources and Resource Groups should include the environment short name (eg. dev, uat, prod) immediately after the prefix.

  • As much as possible, use - (dash / minus) as a word separator for easier reading

  • As much as possible, include a self explanatory resource type / purpose in the name

Exceptions

  • Certain resources have length restrictions and/or allow only specific characters (eg. Storage Accounts, etc). In this case, the separator can be excluded

  • When the prefix and environment name are not providing a unique name combination for a resource, across all Azure resources, and a name collision occurs, it is acceptable to expand the prefix to <avocarisk>

  • When there is a single/shared resource across all environments, such as the container registry, and the resource name <avocarisk> is available, it can be used instead

  • When there is a single/shared resource used only in the dev environment, such as the PosgreSQL DB used for Sonar, and the part of the name can be excluded.