You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It is used in example code within the Azure-Terraform module codebase.
This repository can be used as a template to create a private repository which would contain proprietary data within the custom.json file reflective of the organization in which it was to be used.
Overview
This repository contains a list of variables and standards for naming resources in Microsoft Azure. It serves these primary purposes:
A central location for development teams to research and collaborate on allowed values and naming conventions.
A single source of truth for data values used in policy enforcement, billing, and naming.
A RESTful data source for application requiring information on approved values, variables and names.
How to Use
This repository has four primary areas and their methods of use are described by the following:
README.md - The readme is the human readable documentation on the naming conventions, approved values, and variable names that developers will reference when creating inputs for modules and code.
custom.json - Data in json format to be RESTful sourced by applications. Contains a list of custom variable names, conventions, scope and approved values. The readme is generated automatically from this data.
entity.json - Data in json format to be sourced by applications. Contains an up-to-date list of Azure resources, conventions, scope and approved naming conventions. The readme is generated automatically from this data.
bin/run.py - A python script that scrapes the latest data from Microsoft merges with the existing json and adds new resources. It also generates this README doc from the custom and entity json.
How to Update
This information is meant to be a living source of truth for applications and policy and as such is expected to be versioned and updated. If you wish to add allowed values for any of the variables or need a naming convention that is not provided in this data, open an issue request agains this repo. Upon review the information will be updated and the policy engines will reflect the changes immediately.
Custom Entities
Custom entities are variables and allowed values that describe our business and purpose at the company and are the only approved values to be used in names and tags. This assures consistency and data integrity across all resources being named and tagged in Azure. If you would like to add additional allowed values, simply open an issue request against this repo and upon review the value will be added.
custom.applicationName
Full Text
Scope
Rule
Value
Contoso
global
az[12]
contoso
Kubernetes
global
az[12]
k8s
Secure Shell
global
az[12]
ssh
Docker
global
az[12]
docker
custom.azureRegion
Full Text
Scope
Rule
Value
East Asia
global
az[20]
eastasia
Southeast Asia
global
az[20]
southeastasia
Central US
global
az[20]
centralus
East US
global
az[20]
eastus
East US 2
global
az[20]
eastus2
West US
global
az[20]
westus
North Central US
global
az[20]
northcentralus
South Central US
global
az[20]
southcentralus
North Europe
global
az[20]
northeurope
West Europe
global
az[20]
westeurope
Japan West
global
az[20]
japanwest
Japan East
global
az[20]
japaneast
Brazil South
global
az[20]
brazilsouth
Australia East
global
az[20]
australiaeast
Australia Southeast
global
az[20]
australiasoutheast
South India
global
az[20]
southindia
Central India
global
az[20]
centralindia
West India
global
az[20]
westindia
Canada Central
global
az[20]
canadacentral
Canada East
global
az[20]
canadaeast
UK South
global
az[20]
uksouth
UK West
global
az[20]
ukwest
West Central US
global
az[20]
westcentralus
West US 2
global
az[20]
westus2
Korea Central
global
az[20]
koreacentral
Korea South
global
az[20]
koreasouth
France Central
global
az[20]
francecentral
France South
global
az[20]
francesouth
Australia Central
global
az[20]
australiacentral
Australia Central 2
global
az[20]
australiacentral2
UAE Central
global
az[20]
uaecentral
UAE North
global
az[20]
uaenorth
South Africa North
global
az[20]
southafricanorth
South Africa West
global
az[20]
southafricawest
Switzerland North
global
az[20]
switzerlandnorth
Switzerland West
global
az[20]
switzerlandwest
Germany North
global
az[20]
germanynorth
Germany West Central
global
az[20]
germanywestcentral
Norway West
global
az[20]
norwaywest
Norway East
global
az[20]
norwayeast
Brazil Southeast
global
az[20]
brazilsoutheast
US Gov Virginia
global
az[20]
usgovvirginia
US Gov Iowa
global
az[20]
usgoviowa
US DoD East
global
az[20]
usdodeast
US DoD Central
global
az[20]
usdodcentral
US Gov Texas
global
az[20]
usgovtexas
US Gov Arizona
global
az[20]
usgovarizona
custom.businessUnit
Full Text
Scope
Rule
Value
Back Office
global
az[12]
backoffice
Commercial
global
az[12]
commercial
Government
global
az[12]
government
Human Resources
global
az[12]
hr
Infrastructure
global
az[12]
infra
Security
global
az[12]
security
custom.environment
Full Text
Scope
Rule
Value
Sandbox
global
az[7]
sandbox
Development
global
az[7]
dev
Quality Assurance
global
az[7]
qa
User Acceptance Testing
global
az[7]
uat
Production
global
az[7]
prod
custom.market
Full Text
Scope
Rule
Value
United States
global
az[2]
us
United Kingdom
global
az[2]
uk
India
global
az[2]
in
Brazil
global
az[2]
br
China
global
az[2]
cn
custom.onPrem
Full Text
Scope
Rule
Value
Denver, CO
global
az[16]
denver
New York, NY
global
az[16]
nyc
Seattle, WA
global
az[16]
seattle
custom.productGroup
Full Text
Scope
Rule
Value
Contoso
global
az[12]
contoso
Information Security
global
az[12]
infosec
Core Networking
global
az[12]
networks
custom.productName
Full Text
Scope
Rule
Value
Contoso Web
global
az[16]
contosoweb
Contoso API
global
az[16]
contosoapi
custom.resourceGroupType
Full Text
Scope
Rule
Value
Shared Services
global
az[12]
shared
Application
global
az[12]
app
custom.serviceName
Full Text
Scope
Rule
Value
Apache Webserver
global
az[12]
apache
Cassandra
global
az[12]
cassandra
Elasticsearch
global
az[12]
es
Monolith
global
az[12]
mono
Oracle
global
az[12]
oracle
custom.subnetType
Full Text
Scope
Rule
Value
Application Gateway
global
A-Z[24]
azure-appgateway
VPN Gateway
global
A-Z[24]
azure-vpngateway
Azure Firewall
global
A-Z[24]
AzureFirewallSubnet
Redis Cache
global
A-Z[24]
azure-rediscache
Azure SQL Database
global
A-Z[24]
azure-sqldatabase
Azure Container Instance
global
A-Z[24]
azure-containers
API Management
global
A-Z[24]
azure-apimanagement
App Service Environment
global
A-Z[24]
azure-appservice
Azure Logic Apps
global
A-Z[24]
azure-logicapps
Azure Dedicated HSM
global
A-Z[24]
azure-dedicatedhsm
Azure Netapp Files
global
A-Z[24]
azure-netappfiles
IaaS Public
global
A-Z[24]
iaas-public
IaaS Outbound
global
A-Z[24]
iaas-outbound
IaaS Private
global
A-Z[24]
iaas-private
Azure Bastion Service
global
A-Z[24]
AzureBastionSubnet
custom.subscriptionType
Full Text
Scope
Rule
Value
Development
global
az[12]
dev
Non-Production
global
az[12]
nonprod
Production
global
az[12]
production
custom.virtualNetGwType
Full Text
Scope
Rule
Value
Express Route Connection
global
az[12]
expressroute
Virtual Private Network
global
az[12]
vpn
Azure Entities
Azure entities are entities as maintained by Microsoft Azure and should contain all possible resources that can be built along with Microsoft's rules for record length, scope, and allowed characters. Naming convention is specific to the company and takes into account the scope, length, and purpose to assure the name retains readability and conveys the most pertinent information about the resource to the reader. Examples are provided.