Documento para mapeamento e auxílio na utilização de nomes para objetos dentro do Azure, como Resource Groups, Service Plan, App etc. IMPORTANTE! Este documento tem a intenção de unificar os padrões e servir de base para alinhamentos entre os membro da equipe para a avlaiação e evolução do mesmo, sempre de forma colaborativa.
- Convenções
- Fontes
Por convenção a Microsoft trabalha com nomes em lowercase (caixa baixa) e case sensitive (maiúsculas e minúsculas, vulgo camelcase) e insensitive (apenas minúsculas), dessa forma o padrão a ser seguido segue os seguintes exemplos:
- Lower case: nome-ambiente-sigla
- Case sensitive: nomeCompleto-ambiente-sigla
- Case insensitive: nomecompleto-ambiente-sigla
Padrão recomendado pela MS:
<Company><Department (optional)><Product Line (optional)><Environment>
Contudo para facilitar a identidicação utilizaremos como separador padrão o ponto "." e no estilo case sensitive, segue:
Ex.: Empresa.Canal.Sistema
App Service Plan
Padrão no estilo case insensitive:
<service short name>-<environment>-asp
Ex.: canal-hml-asp
Resource Group
Padrão recomendado pela MS, no estilo case insensitive:
<service short name>-<environment>-rg
Ex.: canal-hml-rg
Tag
Padrão recomendado pela MS, no estilo case insensitive:
"key" : "value"
Ex.: "department" : "Central IT"
Para a key, utilizar: area-informacao
Ex.: empresa-solicitante, vsts-projeto
API App e Gateways
Padrão modificado da MS, onde fn é o radical adicionado para informação de app como API app, com a adição do ambiente, no estilo case insensitive:
api-< name >[-< enviroment >] e gateway-< squad >[-< enviroment >]
Ex.: api-aplicacao, api-aplicacao-hml e gateway-canal, gateway-canal-hml
Function App
Padrão modificado da MS, onde fn é o radical adicionado para informação de app como function, com a adição do ambiente, no estilo case insensitive:
fn-< name >[-< enviroment >]
Ex.: fn-aplicacao e fn-aplicacao-hml (hml quando ambiente de Homologação)
Virtual Machine
Padrão recomentado pela MS, com adição do tipo ao final, no estilo case insensitive:
<name>-<role>-<poolnmber>vm
Ex.: empresa-sql-vm001
Web App
Padrão modificado da MS, onde fn é o radical adicionado para informação de app como Web App, com a adição do ambiente, no estilo case insensitive:
<name>[-<enviroment>]
Ex.: portal e portal-hml (hml quando ambiente de Homologação)
Azure Data Warehouse
Padrão no estilo case insensitive:
<name>-dw
Ex.: empresanome-dw
Azure SQL Database
Padrão no estilo case insensitive:
<organization>[<poolnumber>]-<type>
Ex.: nome-db, ou sitescanal001-db
Azure SQL Server
Padrão no estilo case insensitive:
<organization><poolnumber>-<environment>-<type>
Ex.: empresanome001-prd-sqlsrv
Blob
Padrão recomentado pela MS, no estilo case sensitive:
<variable based on blob name>
Ex.: canalBlob
Storage
Padrão recomentado pela MS, no estilo lowercase, seguido de um número identificador:
<globally unique name><number>
Ex.:canal001
Table
Padrão recomentado pela MS com adição do hifem, no estilo case insensitive:
<service short name>-<context>
Ex.: canal-sites
Azure Application Gateway
Padrão recomentado pela MS, no estilo case insensitive:
<service or role>-agw
Ex.: canal-agw, empresa-agw
Public IP
Padrão recomentado pela MS, no estilo case insensitive:
<vm ou nome do serviço>-pip
Ex.: empresa-sql-vm001-pip
Subnet
Padrão recomentado pela MS, no estilo case insensitive:
<descriptive context>
Ex.: web
Virtual Network
Padrão recomentado pela MS, no estilo case insensitive:
<service short name>-vnet
Ex.: canal-vnet