Naming Conventions
The following table presents a guideline to how resources are to be named and what their names represent. It is important to follow the correct naming convention when creating resources.
Aspect | Example | Notes |
Environment | L / D | Identifies the environment for the resource. L:Live or D:Dev |
Location | S1 / S2 / S3 / WE / NE | Identifies the region into which the resource is deployed. S1, S2 and S3 are available on-premises. WE is for West Europe and NE for North Europe. |
Solution Alias | my_Project | Identifies the project name. Maximum 17 Characters. This is the Resource Group name |
Subscription Environment | Prod / Dev | Identifies the subscription environment. It can be either Production or Development. |
Subscription Type | Hybrid / Cloud-Only | Identifies the environment type it can be either Hybrid, or Cloud-Only (No access to MAGNET). |
Subnet Prefix | Frontend / Backend | Identifies the subnet’s name. Frontend routes to the Internet, and Backend routes to MAGNET via MITA’s Firewalls (eRFS for Network Access needed to communicate with any MAGNET services) . |
Identifier | WEB1 / MGMT, etc.. | To distinguish one resource from others of the same type. |
Resource | Pattern | Length Guidelines | Valid Characters | Example |
Virtual Network (Cloud-Only Subscriptions) | <SolutionAlias>-<Environment><Location>-vnet<1/2> | 2-64 | Alphanumeric, hyphen, underscore, and period | TestSolution-DS1-vnet1 |
Subnet | <SolutionAlias>-<SubnetPrefix>-<Environment><Location>-snet | 2-80 | Alphanumeric, hyphen, underscore, and period | TestSolution_1-FrontEnd-DS1-snet TestSolution_1-App-DS1-snet TestSolution_1-Data-DS1-snet TestSolution_1-Default-DS1-snet |
Network Security Group | <SolutionAlias>-<Identifier> – <Environment> <Location> – nsg | SolutionAlias = 17 Identifier = 4 Environment = 1 Location = 2 |
Alphanumeric, hyphen, underscore, and period |
TestSolution-0001-DS1-nsg (In case of multiple NSGs, replace the 0001 with an identifier of your choice as below: TestSolution-0002-DS1-nsg TestSolution-0003-DS1-nsg TestSolution-WEB1-DS1-nsg) |
Storage Account | <SolutionAlias><Identifier><Environment><Location>sa | SolutionAlias = 17 Identifier = 4 Environment = 1 Location = 2 |
Lower Case, Alphanumeric | devSolution1WEB1ds1sa |
Availability Set | <SolutionAlias>-<Identifier>-<Environment><Location>-as | SolutionAlias = 17 Identifier = 4 Environment = 1 Location = 2 |
Alphanumeric and hyphen | TestSolution-SQL-LS1-as |
Load Balancer | <SolutionAlias>-<Identifier>-<Environment><Location>-lb | SolutionAlias = 17 Identifier = 4 Environment = 1 Location = 2 |
Alphanumeric and hyphen | TestSolution-SQL-LS1-lb |
Virtual Machine Name (VMName) | VMDescription-<Environment><Location> | VMDescription = 6 Environment = 1 Location = 2 |
Alphanumeric and hyphen | WEBSRV-DS1 |
VM Data Disk | <VMName>-<Identifier>-md | Identifier = 4 | Alphanumeric, hyphen, underscore, and period | WEBSRV-DS1-data-md (In case of multiple disks, replace data with the identifier of your choice) |
VM OS Disk | <VMName>-os-md | Disk is created automatically with the VM | Alphanumeric, hyphen, underscore, and period | WEBSRV-DS1-os-md |
VM NIC | <VMName>- <Identifier>–nic | Identifier = 4 | Alphanumeric, hyphen, underscore, and period | WEBSRV-DS1-MGMT-nic (In case of multiple NICs, replace MGMT with an identifier of your choice) |
Public IP | <VMName>-<Identifier>-pip | Identifier = 4 | Alphanumeric, hyphen, underscore, and period | WEBSRV-DS1-MGMT-pip (In case of multiple Public IPs, replace MGMT with an identifier of your choice) |