Any recommendations about naming convention for an Azure resource

WeirdMan 340 Reputation points
2024-06-05T17:30:30.2333333+00:00

Is there any official guide for naming convention about the Azure resources?

Azure Synapse Analytics
Azure Synapse Analytics
An Azure analytics service that brings together data integration, enterprise data warehousing, and big data analytics. Previously known as Azure SQL Data Warehouse.
5,378 questions
Azure Data Factory
Azure Data Factory
An Azure service for ingesting, preparing, and transforming data at scale.
11,652 questions
0 comments No comments
{count} votes

Accepted answer
  1. Amira Bedhiafi 34,101 Reputation points Volunteer Moderator
    2024-06-05T17:37:04.63+00:00

    Based on the documentation :

    A good name for a resource helps you to quickly identify its type, its associated workload, its environment, and the Azure region where it runs. To do so, names should follow a consistent format—a naming convention—that is composed of important information about each resource. The information in the names ideally includes whatever you need to identify specific instances of resources. For example, a public IP address (PIP) for a production SharePoint workload in the West US region might be pip-sharepoint-prod-westus-001.

    More links :

    https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations

    https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules

    1 person found this answer helpful.
    0 comments No comments

3 additional answers

Sort by: Most helpful
  1. Marcin Policht 50,735 Reputation points MVP Volunteer Moderator
    2024-06-05T17:36:50.62+00:00

    Yep - in general, there are two considerations

    1. You need to be aware of the restrictions applicable to different Azure resources. Details at https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules
    2. Recommendations based on CAF - details at https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naming

    If the above response helps answer your question, remember to "Accept Answer" so that others in the community facing similar issues can easily find the solution. Your contribution is highly appreciated.

    hth

    Marcin

    1 person found this answer helpful.
    0 comments No comments

  2. Michael Taylor 60,331 Reputation points
    2024-06-05T17:39:16.0166667+00:00

    Not really. The problem is that some resources are global (to all of Azure) while others are specific to your subscription/resource group. Some resources must be allowable in a URL, others restrict the characters allowed (I think one even mandates lower case letters only), and yet others allow anything. On top of that some resources are limited to small sizes (e.g. 32). It is really frustrating. I recommend that for each resource you review the docs to see if they make a recommendation when they list the resource naming restrictions.

    The general recommendation, limited by the resource rules you are defining, is to use something descriptive and ideally include the environment (e.g. prod, staging). For example a calculator website might be called calculator-staging and calculator-prod whereas a storage container for books might be books-staging and books-prod. Since Azure Portal shows all resources it can get very confusing if you have a bunch of them so you must either filter by the type (e.g. storage container, storage account) or include that in the name as well. For example it is pretty common to see -rg added to resource group names.

    Bear in mind that some resource names may be publicly visible in URLs so don't put in anything sensitive.

    0 comments No comments

  3. EPNAdam 115 Reputation points
    2024-08-06T11:45:11.63+00:00

    +1 on the reply @Amira Bedhiafi where the naming convention describe under the Cloud Adoption Framework is a good start. We follow it with slight modifications. However, it is good to know that Azure Services can suddenly create resource groups and other resources that are violating your naming convention policies and you can't do anything about it. Kind of annoying.

    0 comments No comments

Your answer

Answers can be marked as Accepted Answers by the question author, which helps users to know the answer solved the author's problem.