{"id":4470,"date":"2022-11-30T12:08:49","date_gmt":"2022-11-30T20:08:49","guid":{"rendered":"https:\/\/SUMMALAI.COM\/?p=4470"},"modified":"2022-11-30T12:08:50","modified_gmt":"2022-11-30T20:08:50","slug":"how-to-define-naming-convention-in-azure","status":"publish","type":"post","link":"https:\/\/SUMMALAI.COM\/?p=4470","title":{"rendered":"How to Define Naming Convention in Azure"},"content":{"rendered":"\n

An effective naming convention consists of resource names from important information about each resource. A good name helps you quickly identify the resource’s type, associated workload, environment, and the Azure region hosting it. For example, a public IP resource for a production SharePoint workload in the West US region might be pip-sharepoint-prod-westus-001<\/code>.<\/p>\n\n\n\n

\"Diagram<\/figure>\n\n\n\n

Diagram 1: Components of an Azure resource name.<\/em><\/p>\n\n\n\n

<\/a>Recommended naming components<\/h3>\n\n\n\n

When you construct your naming convention, identify the key pieces of information you want to reflect in a resource name. Different information is relevant for different resource types, and not all established naming components can be used for each resource type. The intention is to have a standard naming convention for your environment that is easy to follow, concise, and useful for recognizing information that’s relevant to the deployed resource.<\/p>\n\n\n\n

The following list provides examples of naming components that are useful when you construct resource names:<\/p>\n\n\n\n

Naming component<\/th>Description<\/th><\/tr><\/thead>
Organization<\/strong><\/td>Top-level name of organization, normally utilized as top management group or, in smaller organizations, part of the naming convention. Example: contoso<\/code><\/td><\/tr>
Business unit or department<\/strong><\/td>Top-level division of your company that owns the subscription or workload the resource belongs to. In smaller organizations, this component might represent a single corporate top-level organizational element. Examples: fin<\/code>, mktg<\/code>, product<\/code>, it<\/code>, corp<\/code><\/td><\/tr>
Resource type<\/strong><\/td>An abbreviation that represents the type of Azure resource or asset. This component often is used as a prefix or suffix in the name. For more information, see Recommended abbreviations for Azure resource types<\/a>. Examples: rg<\/code>, vm<\/code><\/td><\/tr>
Project, application, or service name<\/strong><\/td>Name of a project, application, or service that the resource is a part of. Examples: navigator<\/code>, emissions<\/code>, sharepoint<\/code>, hadoop<\/code><\/td><\/tr>
Environment<\/strong><\/td>The stage of the development lifecycle for the workload that the resource supports. Examples: prod<\/code>, dev<\/code>, qa<\/code>, stage<\/code>, test<\/code><\/td><\/tr>
Location<\/strong><\/td>The region or cloud provider where the resource is deployed. Examples: westus<\/code>, eastus2<\/code>, westeu<\/code>, usva<\/code>, ustx<\/code><\/td><\/tr>
VM role<\/strong><\/td>Identifier for the purpose of the VM. Examples: db<\/code> (database), ws<\/code> (web server), ps<\/code> (print server)<\/td><\/tr>
Instance<\/strong><\/td>The instance count for a specific resource to identify more than one resource that has the same naming convention. Examples, 01<\/code>, 001<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

 Note<\/p>\n\n\n\n

Although virtual machine (VM) names in Azure can be longer than the allowed NetBIOS name of the VM, we recommend that you keep them consistent. For more information and for other restrictions, see Computer names<\/a>.<\/p>\n\n\n\n

<\/a>Naming considerations<\/h2>\n\n\n\n

In addition to defining the naming components, you must also consider the order in which the naming components should be listed, if and what type of delimiters you should use between components, and take into account the different naming rules associated with resources types.<\/p>\n\n\n\n

<\/a>Scope<\/h3>\n\n\n\n

All Azure resource types have a scope that defines the level of that resource and that the resource names must be unique. A resource must have a unique name within its scope.<\/p>\n\n\n\n

For example, a virtual network has a resource group scope, which means that there can be only one network named vnet-prod-westus-001<\/code> in a given resource group. Other resource groups could have their own virtual network named vnet-prod-westus-001<\/code>. Subnets are scoped to virtual networks, so each subnet within a virtual network must have a distinct name.<\/p>\n\n\n\n

Some resource names, such as PaaS services with public endpoints or virtual machine DNS labels, have global scopes, so they must be unique across the entire Azure platform.<\/p>\n\n\n\n

\"Diagram<\/figure>\n\n\n\n

Diagram 2: Scope levels for Azure resource names.<\/em><\/p>\n\n\n\n

<\/a>Azure naming rules<\/h3>\n\n\n\n

Azure naming rules vary depending on the resource type. When you define a naming convention, it’s important to understand Azure naming rules for the resource type to avoid confusion and delay deployments.<\/p>\n\n\n\n

For example, resource names have length limits. We recommend that you keep the length of naming components short to prevent exceeding resource name length limits.<\/p>\n\n\n\n

 Note<\/p>\n\n\n\n

Balancing the context of a name with its scope and name length limit is important when you develop your naming conventions. For more information, see Naming rules and restrictions for Azure resources<\/a>.<\/p>\n\n\n\n

When you construct your naming convention, identify the key pieces of information that you want to reflect in a resource name. Different information is relevant for different resource types. The following list provides examples of information that’s useful when you construct resource names.<\/p>\n\n\n\n

You can abbreviate resource names and naming components as a strategy to reduce the length and complexity of resource names. Shortening names can be useful for any of the naming components, but it’s especially important to help you keep resource names within name length limits. For example, a VM name in Azure can be longer than the OS naming restrictions. Keeping Azure VM names shorter than the naming restrictions of the OS helps create consistency, improve communication when discussing resources, and reduce confusion when you are working in the Azure portal while being signed in to the VM itself.<\/p>\n\n\n\n

Naming component<\/th>Description<\/th><\/tr><\/thead>
Resource type<\/strong><\/td>An abbreviation that represents the type of Azure resource or asset. This component is often used as a prefix or suffix in the name. For more information, see Recommended abbreviations for Azure resource types<\/a>.
Examples: rg<\/code>, vm<\/code><\/td><\/tr>
Business unit<\/strong><\/td>Top-level division of your company that owns the subscription or workload the resource belongs to. In smaller organizations, this component might represent a single corporate top-level organizational element.
Examples: fin<\/code>, mktg<\/code>, product<\/code>, it<\/code>, corp<\/code><\/td><\/tr>
Application or service name<\/strong><\/td>Name of the application, workload, or service that the resource is a part of.
Examples: navigator<\/code>, emissions<\/code>, sharepoint<\/code>, hadoop<\/code><\/td><\/tr>
Subscription purpose<\/strong><\/td>Summary description of the purpose of the subscription that contains the resource. Often broken down by environment or specific workloads.
Examples: prod<\/code>, shared<\/code>, client<\/code><\/td><\/tr>
Environment<\/strong><\/td>The stage of the development lifecycle for the workload that the resource supports.
Examples: prod<\/code>, dev<\/code>, qa<\/code>, stage<\/code>, test<\/code><\/td><\/tr>
Region<\/strong><\/td>The Azure region where the resource is deployed.
Examples: westus<\/code>, eastus2<\/code>, westeu<\/code>, usva<\/code>, ustx<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

 Note<\/p>\n\n\n\n

When you’re ready to name your resources and assets, review Recommended abbreviations for Azure resource types<\/a>.<\/p>\n\n\n\n

The following section provides example names for common Azure resource types in an enterprise cloud deployment.<\/p>\n\n\n\n

 Note<\/p>\n\n\n\n

Some of these example names use a three-digit padding scheme (###<\/code>), such as mktg-prod-001<\/code>.<\/p>\n\n\n\n

Padding improves readability and sorting of assets when those assets are managed in a configuration management database (CMDB), IT Asset Management tool, or traditional accounting tools. When the deployed asset is managed centrally as part of a larger inventory or portfolio of IT assets, the padding approach aligns with interfaces those systems use to manage inventory naming.<\/p>\n\n\n\n

Unfortunately, the traditional asset padding approach can prove problematic in infrastructure-as-code approaches that might iterate through assets based on a non-padded number. This approach is common during deployment or automated configuration management tasks. Those scripts would have to routinely strip the padding and convert the padded number to a real number, which slows script development and run time.<\/p>\n\n\n\n

Choose an approach that’s suitable for your organization. The padding shown here illustrates the importance of using a consistent approach to inventory numbering, rather than showing which approach is superior. Before choosing a numbering scheme, with or without padding, evaluate what will affect long-term operations more, CMDB and asset management solutions or code-based inventory management. Then, consistently follow the padding option that best fits your operational needs.<\/p>\n\n\n\n

The following section provides some example names for common Azure resource types in an enterprise cloud deployment. For additional examples, see the Azure Naming Tool<\/a> and the Naming and tagging tracking template<\/a>.<\/p>\n\n\n\n

 Note<\/p>\n\n\n\n

The following examples are intended to provide visualization of a naming convention, but actual conventions will vary by organization.<\/p>\n\n\n\n

<\/a>Example names: General<\/h3>\n\n\n\n
Asset type<\/th>Scope<\/th>Format and examples<\/th><\/tr><\/thead>
Management group<\/strong><\/td>Business unit and\/or
environment<\/td>		mg-<business unit>[-<environment>]<\/em>

mg-mktg<\/code>mg-hr<\/code>mg-corp-prod<\/code>mg-fin-client<\/code><\/td><\/tr>
Subscription<\/strong><\/td>Account \/ enterprise agreement<\/td><business unit>-<subscription purpose>-<###><\/em>

mktg-prod-001<\/code>corp-shared-001<\/code>fin-client-001<\/code><\/td><\/tr>
Resource group<\/strong><\/td>Subscription<\/td>rg-<app or service name>-<subscription purpose>-<###><\/em>

rg-mktgsharepoint-prod-001<\/code>rg-acctlookupsvc-shared-001<\/code>rg-ad-dir-services-shared-001<\/code><\/td><\/tr>
API management service instance<\/strong><\/td>Global<\/td>apim-<app or service name><\/em>

apim-navigator-prod<\/code><\/td><\/tr>
Managed identity<\/strong><\/td>Resource group<\/td>id-<app or service name>-<environment>-<region name>-<###><\/em>

id-appcn-keda-prod-eastus2-001<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/a>Example names: Networking<\/h3>\n\n\n\n
Asset type<\/th>Scope<\/th>Format and examples<\/th><\/tr><\/thead>
Virtual network<\/strong><\/td>Resource group<\/td>vnet-<subscription purpose>-<region>-<###><\/em>

vnet-shared-eastus2-001<\/code>vnet-prod-westus-001<\/code>vnet-client-eastus2-001<\/code><\/td><\/tr>
Subnet<\/strong><\/td>Virtual network<\/td>snet-<subscription purpose>-<region>-<###><\/em>

snet-shared-eastus2-001<\/code>snet-prod-westus-001<\/code>snet-client-eastus2-001<\/code><\/td><\/tr>
Network interface (NIC)<\/strong><\/td>Resource group<\/td>nic-<##>-<vm name>-<subscription purpose>-<###><\/em>

nic-01-dc1-shared-001<\/code>nic-02-vmhadoop1-prod-001<\/code>nic-02-vmtest1-client-001<\/code><\/td><\/tr>
Public IP address<\/strong><\/td>Resource group<\/td>pip-<vm name or app name>-<environment>-<region>-<###><\/em>

pip-dc1-shared-eastus2-001<\/code>pip-hadoop-prod-westus-001<\/code><\/td><\/tr>
Load balancer<\/strong><\/td>Resource group<\/td>lb-<app name or role>-<environment>-<###><\/em>

lb-navigator-prod-001<\/code>lb-sharepoint-dev-001<\/code><\/td><\/tr>
Network security group (NSG)<\/strong><\/td>Subnet or NIC<\/td>nsg-<policy name or app name>-<###><\/em>

nsg-weballow-001<\/code>nsg-rdpallow-001<\/code>nsg-sqlallow-001<\/code>nsg-dnsblocked-001<\/code><\/td><\/tr>
Local network gateway<\/strong><\/td>Virtual gateway<\/td>lgw-<subscription purpose>-<region>-<###><\/em>

lgw-shared-eastus2-001<\/code>lgw-prod-westus-001<\/code>lgw-client-eastus2-001<\/code><\/td><\/tr>
Virtual network gateway<\/strong><\/td>Virtual network<\/td>vgw-<subscription purpose>-<region>-<###><\/em>

vgw-shared-eastus2-001<\/code>vgw-prod-westus-001<\/code>vgw-client-eastus2-001<\/code><\/td><\/tr>
Site-to-Site connection<\/strong><\/td>Resource group<\/td>cn-<local gateway name>-to-<virtual gateway name><\/em>

cn-lgw-shared-eastus2-001-to-vgw-shared-eastus2-001<\/code>cn-lgw-shared-eastus2-001-to-vgw-shared-westus-001<\/code><\/td><\/tr>
VPN connection<\/strong><\/td>Resource group<\/td>cn-<subscription1 purpose>>-<region1>-to-<subscription2 purpose>>-<region2>-<\/em>

cn-shared-eastus2-to-shared-westus<\/code>cn-prod-eastus2-to-prod-westus<\/code><\/td><\/tr>
Route table<\/strong><\/td>Resource group<\/td>route-<route table name><\/em>

route-navigator<\/code>route-sharepoint<\/code><\/td><\/tr>
DNS label<\/strong><\/td>Global<\/td><DNS A record for VM>.<region>.cloudapp.azure.com<\/em>

dc1.westus.cloudapp.azure.com<\/code>web1.eastus2.cloudapp.azure.com<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/a>Example names: Compute and Web<\/h3>\n\n\n\n
Asset type<\/th>Scope<\/th>Format and examples<\/th><\/tr><\/thead>
Virtual machine<\/strong><\/td>Resource group<\/td>vm<vm role><environment><###><\/em>

vmsqltest001<\/code>vmhadoopprod001<\/code><\/td><\/tr>
Web app<\/strong><\/td>Global<\/td>app-<project, app or service>-<environment>-<###>.azurewebsites.net<\/em>

app-navigator-prod-001.azurewebsites.net<\/code>app-accountlookup-dev-001.azurewebsites.net<\/code><\/td><\/tr>
Function app<\/strong><\/td>Global<\/td>func-<project, app or service>-<environment>-<###>.azurewebsites.net<\/em>

func-navigator-prod-001.azurewebsites.net<\/code>func-accountlookup-dev-001.azurewebsites.net<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/a>Example names: Databases<\/h3>\n\n\n\n
Asset type<\/th>Scope<\/th>Format and examples<\/th><\/tr><\/thead>
Azure SQL database<\/strong><\/td>Azure SQL Database<\/td>sqldb-<project, app or service>-<environment><\/em>

sqldb-users-prod<\/code>sqldb-users-dev<\/code><\/td><\/tr>
Azure Cosmos DB database<\/strong><\/td>Global<\/td>cosmos-<project, app or service>-<environment><\/em>

cosmos-navigator-prod<\/code>cosmos-emissions-dev<\/code><\/td><\/tr>
Azure Cache for Redis instance<\/strong><\/td>Global<\/td>redis-<project, app or service>-<environment><\/em>

redis-navigator-prod<\/code>redis-emissions-dev<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/a>Example names: Storage<\/h3>\n\n\n\n
Asset type<\/th>Scope<\/th>Format and examples<\/th><\/tr><\/thead>
Storage account (general use)<\/strong><\/td>Global<\/td>st<project, app or service><###><\/em>

stnavigatordata001<\/code>stemissionsoutput001<\/code><\/td><\/tr>
Azure StorSimple<\/strong><\/td>Global<\/td>ssimp<project, app or service><environment><\/em>

ssimpnavigatorprod<\/code>ssimpemissionsdev<\/code><\/td><\/tr>
Azure Container Registry<\/strong><\/td>Global<\/td>cr<project, app or service><environment><###><\/em>

crnavigatorprod001<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/a>Example names: AI and machine learning<\/h3>\n\n\n\n
Asset type<\/th>Scope<\/th>Format and examples<\/th><\/tr><\/thead>
Azure Cognitive Search<\/strong><\/td>Global<\/td>srch-<project, app or service>-<environment><\/em>

srch-navigator-prod<\/code>srch-emissions-dev<\/code><\/td><\/tr>
Azure Cognitive Services<\/strong><\/td>Resource group<\/td>cog-<project, app or service>-<environment><\/em>

cog-navigator-prod<\/code>cog-emissions-dev<\/code><\/td><\/tr>
Azure Machine Learning workspace<\/strong><\/td>Resource group<\/td>mlw-<project, app or service>-<environment><\/em>

mlw-navigator-prod<\/code>mlw-emissions-dev<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/a>Example names: Analytics and IoT<\/h3>\n\n\n\n
Asset type<\/th>Scope<\/th>Format and examples<\/th><\/tr><\/thead>
Azure Data Factory<\/strong><\/td>Global<\/td>adf-<project, app or service>-<environment><\/em>

adf-navigator-prod<\/code>adf-emissions-dev<\/code><\/td><\/tr>
Azure Stream Analytics<\/strong><\/td>Resource group<\/td>asa-<project, app or service>-<environment><\/em>

asa-navigator-prod<\/code>asa-emissions-dev<\/code><\/td><\/tr>
Data Lake Storage account<\/strong><\/td>Global<\/td>dls<project, app or service><environment><\/em>

dlsnavigatorprod<\/code>dlsemissionsdev<\/code><\/td><\/tr>
IoT hub<\/strong><\/td>Global<\/td>iot-<project, app or service>-<environment><\/em>

iot-navigator-prod<\/code>iot-emissions-dev<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/a>Example names: Integration<\/h3>\n\n\n\n
Asset type<\/th>Scope<\/th>Format and Examples<\/th><\/tr><\/thead>
Service Bus<\/strong><\/td>Global<\/td>sb-<project, app or service>-<environment>.servicebus.windows.net<\/em>

sb-navigator-prod.servicebus.windows.net<\/code>sb-emissions-dev.servicebus.windows.net<\/code><\/td><\/tr>
Service Bus queue<\/strong><\/td>Service Bus<\/td>sbq-<query descriptor><\/em>

sbq-messagequery<\/code><\/td><\/tr>
Service Bus topic<\/strong><\/td>Service Bus<\/td>sbt-<query descriptor><\/em>

sbt-messagequery<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/p>\n\n\n\n

Ref: Define your naming convention – Cloud Adoption Framework | Microsoft Learn<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

An effective naming convention consists of resource names from important information about each resource. A good name helps you quickly identify the resource’s type, associated workload, environment, and the Azure region hosting it. For example, a public IP resource for a production SharePoint workload in the West US region might be pip-sharepoint-prod-westus-001. Diagram 1: Components of Read More<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[1249,10],"tags":[1405,1406],"class_list":["post-4470","post","type-post","status-publish","format-standard","hentry","category-azure-microsoft","category-microsoft","tag-define-naming-convention-in-azure","tag-naming-convention-in-azure"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=\/wp\/v2\/posts\/4470","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=4470"}],"version-history":[{"count":1,"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=\/wp\/v2\/posts\/4470\/revisions"}],"predecessor-version":[{"id":4471,"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=\/wp\/v2\/posts\/4470\/revisions\/4471"}],"wp:attachment":[{"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=4470"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=4470"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/SUMMALAI.COM\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=4470"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}