Defina sua convenção de nomenclatura
Um bom nome para um recurso ajuda você a identificar rapidamente seu tipo, sua carga de trabalho associada, seu ambiente e a região do Azure onde ele é executado. Para isso, os nomes devem seguir um formato consistente — uma convenção de nomenclatura — que é composto por informações importantes sobre cada recurso. As informações nos nomes idealmente incluem tudo o que você precisa para identificar instâncias específicas de recursos. Por exemplo, um endereço IP público (PIP) para uma carga de trabalho do SharePoint de produção na região Oeste dos EUA pode ser pip-sharepoint-prod-westus-001.
Diagrama 1: Exemplo de componentes em um nome de recurso do Azure.
Observação
Considere que nem todos os recursos do Azure podem seguir os mesmos padrões. Certifique-se de que compreende as limitações dos tipos de recursos com os quais está a trabalhar.
Para saber mais, consulte Regras e restrições de nomenclatura para recursos do Azure.
Componentes de nomenclatura recomendados
Ao construir sua convenção de nomenclatura, identifique as principais informações que deseja capturar em um nome de recurso. Informações diferentes são relevantes para diferentes tipos de recursos, e nem todos os componentes de nomenclatura estabelecidos podem ser usados para cada tipo de recurso. Estabeleça uma convenção de nomenclatura padrão para seu ambiente que seja fácil de seguir, concisa e útil para reconhecer informações relevantes para o recurso implantado.
A lista a seguir fornece exemplos de nomenclatura de componentes que são úteis quando você constrói nomes de recursos:
| Componente de nomenclatura | Descrição |
|---|---|
| Organização | Nome de nível superior da organização, normalmente utilizado como o grupo de gestão de topo ou, em organizações mais pequenas, parte da convenção de nomenclatura. Exemplo: contoso |
| Unidade de negócio ou departamento | Divisão de nível superior da sua empresa proprietária da subscrição ou da carga de trabalho a que o recurso pertence. Em organizações menores, esse componente pode representar um único elemento organizacional corporativo de nível superior. Exemplos: fin, mktg, product, it, corp |
| Tipo de recurso | Uma abreviatura que representa o tipo de recurso ou ativo do Azure. Este componente é geralmente um prefixo ou sufixo no nome. Para obter mais informações, consulte Abreviaturas recomendadas para tipos de recursos do Azure. Exemplos: rg, vm |
| Carga de trabalho, aplicativo ou projeto | Nome de uma carga de trabalho, aplicativo ou projeto do qual o recurso faz parte. Exemplos: navigator, emissions, sharepoint, hadoop |
| Ambiente | O estágio do ciclo de vida de desenvolvimento para a carga de trabalho suportada pelo recurso. Exemplos: prod, dev, qa, stage, test |
| Região | A região ou provedor de nuvem onde o recurso é implantado. Exemplos: westus, eastus2, westeu, usva, ustx |
| Instância | A contagem de instâncias para um recurso específico, para diferenciá-lo de outros recursos que utilizam a mesma convenção de nomenclatura e componentes de nomenclatura. Exemplos, 01001 |
Considerações sobre nomenclatura
Além de definir os componentes de nomenclatura, você também deve considerar a ordem em que os componentes de nomenclatura são listados e que tipo de delimitadores (se houver) devem aparecer entre os componentes. Tenha também em conta as diferentes regras de nomenclatura associadas aos tipos de recursos.
Âmbito de aplicação
Todos os tipos de recursos do Azure têm um escopo que define o nível desse recurso. Além disso, um recurso deve ter um nome exclusivo dentro de seu escopo.
Níveis de escopo para nomes de recursos do Azure:
Global: Único em todo o Azure.
Exemplo: Nome de recursos PaaS com pontos de extremidade IP públicos em todo o Azure, porque esse nome é o nome DNS público padrão inicial.
Grupo de recursos: Exclusivo dentro do grupo de recursos.
Exemplo: Todas as redes virtuais em um grupo de recursos devem ter um nome exclusivo para roteamento dentro desse grupo de recursos.
Resource: Exclusivo dentro do recurso pai.
Exemplo: Todas as sub-redes dentro de uma rede virtual devem ter nomes exclusivos para evitar a sobreposição de segmentos.
Diagrama 2: Níveis de escopo para nomes de recursos do Azure.
Por exemplo, uma rede virtual tem o escopo de um grupo de recursos, o que significa que pode haver apenas uma rede chamada vnet-prod-westus-001 em um grupo de recursos específico. Outros grupos de recursos também podem ter redes virtuais nomeadas vnet-prod-westus-001, mas cada grupo de recursos pode ter apenas uma com esse nome. As sub-redes têm como escopo redes virtuais, portanto, cada sub-rede dentro de uma rede virtual deve ter um nome distinto.
Alguns nomes de recursos têm um escopo global, como um nome para uma plataforma como serviço (PaaS) que tem um ponto de extremidade público ou um rótulo DNS de máquina virtual. Um recurso em um escopo global deve ter um nome exclusivo em toda a plataforma Azure.
Regras de nomenclatura do Azure
As regras de nomenclatura do Azure variam dependendo do tipo de recurso. É importante entender as regras de nomenclatura para cada tipo de recurso para evitar confusões e atrasos.
Por exemplo, nomes de recursos para diferentes tipos de recursos podem ter limites de comprimento diferentes. Recomendamos que mantenha os componentes de nomes curtos ou abrevie os nomes para evitar exceder os limites de comprimento dos nomes dos recursos.
Ao construir sua convenção de nomenclatura, identifique as principais informações que deseja refletir em um nome de recurso. Informações diferentes são relevantes para diferentes tipos de recursos.
Recomendações:
- Entenda as regras e restrições de nomenclatura: Equilibrar o contexto de um nome com seu escopo e limite de comprimento é importante ao desenvolver suas convenções de nomenclatura. Para obter mais informações, consulte Regras e restrições de nomenclatura para recursos do Azure.
- Use abreviaturas de recursos recomendadas: As abreviaturas podem ajudá-lo a manter os nomes dos recursos dentro dos limites de comprimento e torná-los mais fáceis de ler. Para obter mais informações, consulte Abreviaturas recomendadas para tipos de recursos do Azure.
- Considere a consistência de nomenclatura para VMs: Se você estiver trabalhando com VMs no Azure, recomendamos manter nomes consistentes, mesmo que os nomes de VM no Azure possam ser maiores do que o nome NetBIOS permitido da VM. Para obter mais informações e outras restrições, consulte Convenções de nomenclatura no Ative Directory para computadores, domínios, sites e UOs - Nomes de computador.
- Usar a Ferramenta de Nomenclatura do Azure: A Ferramenta de Nomenclatura do Azure é uma ferramenta que ajuda você a gerar nomes para recursos do Azure com base em uma convenção de nomenclatura. Para obter mais informações, consulte Ferramenta de Nomenclatura do Azure.
Nomes de exemplo
Considere estes exemplos ao definir sua convenção de nomenclatura. Os exemplos são baseados nos componentes de nomenclatura e nas considerações descritas neste artigo.
Os exemplos a seguir destinam-se a fornecer visualização de uma convenção de nomenclatura, mas as convenções reais variam de acordo com a organização. Para obter mais exemplos, consulte a Ferramenta de Nomenclatura do Azure.
Exemplos de nomes: Geral
| Tipo de ativo | Âmbito de aplicação | Formato e exemplos |
|---|---|---|
| Grupo de gestão | Unidade de negócio e/ou Meio Ambiente |
mg-<unidade de negócios>[-<ambiente>] mg-mktg mg-hr mg-corp-prod mg-fin-client |
| Assinatura | Conta / acordo corporativo |
<unidade de negócio>- finalidade de subscrição<->-<###> mktg-prod-001 corp-shared-001 fin-client-001 |
| Grupo de recursos | Subscrição |
RG-<nome do aplicativo ou serviço>- finalidade da assinatura<>-<###> rg-mktgsharepoint-prod-001 rg-acctlookupsvc-shared-001 rg-ad-dir-services-shared-001 |
| instância de serviço de gestão de API | A nível mundial |
apim-<nome da aplicação ou serviço> apim-navigator-prod |
| Identidade gerenciada | Grupo de recursos | ID <nome do aplicativo ou serviço>-<ambiente ->-<nome da região>-<###> id-appcn-keda-prod-eastus2-001 |
Nomes de exemplo: Rede
| Tipo de ativo | Âmbito de aplicação | Formato e exemplos |
|---|---|---|
| Rede virtual | Grupo de recursos |
vnet-<subscrição finalidade>-<região>-<###> vnet-shared-eastus2-001 vnet-prod-westus-001 vnet-client-eastus2-001 |
| Sub-rede | Rede virtual |
snet-<subscrição>-<região>-<###> snet-shared-eastus2-001 snet-prod-westus-001 snet-client-eastus2-001 |
| Interface de rede (NIC) | Grupo de recursos |
nic-<##>-<vm name>-<finalidade da assinatura>-<###> nic-01-dc1-shared-001 nic-02-vmhadoop1-prod-001 nic-02-vmtest1-client-001 |
| Endereço IP público | Grupo de recursos |
pip-<nome da vm ou nome do aplicativo>-<ambiente>-<região>-<###> pip-dc1-shared-eastus2-001 pip-hadoop-prod-westus-001 |
| Balanceador de carga (externo) | Grupo de recursos |
lbe-<nome da aplicação ou função>-<ambiente>-<###> lbe-navigator-prod-001 lbe-sharepoint-dev-001 |
| Grupo de segurança de rede (NSG) | Sub-rede ou Placa de Interface de Rede (NIC) |
nsg-<nome da política ou nome do aplicativo>-<###> nsg-weballow-001 nsg-rdpallow-001 nsg-sqlallow-001 nsg-dnsblocked-001 |
| Gateway de rede local | Portal virtual |
>de Finalidade da Subscrição LGW-<->da Região<-<###> lgw-shared-eastus2-001 lgw-prod-westus-001 lgw-client-eastus2-001 |
| Gateway de rede virtual | Rede virtual |
VGW-<Finalidade de Subscrição>-<região>-<###> vgw-shared-eastus2-001 vgw-prod-westus-001 vgw-client-eastus2-001 |
| Conexão VPN | Grupo de recursos |
vcn-<subscription1 purpose>>-<region1>-to-<subscription2 purpose>>-<region2>- vcn-shared-eastus2-to-shared-westus vcn-prod-eastus2-to-prod-westus |
| Tabela de rotas | Grupo de recursos |
rt-<nome da tabela de rotas> rt-navigator rt-sharepoint |
| rótulo DNS | A nível mundial |
<registro A do DNS para a VM>na região<>.cloudapp.azure.com dc1.westus.cloudapp.azure.com web1.eastus2.cloudapp.azure.com |
Exemplos de nomes: Computação e Web
| Tipo de ativo | Âmbito de aplicação | Formato e exemplos |
|---|---|---|
| Máquina virtual | Grupo de recursos |
vm-<carga de trabalho, aplicativo ou projeto>-<ambiente>-<###> vm-sql-test-001 vm-hadoop-prod-001 vm-sharepoint-dev-001 |
| do aplicativo Web | A nível mundial |
aplicativo-<carga de trabalho, aplicativo ou projeto>-<ambiente>-<###>.azurewebsites.net app-navigator-prod-001.azurewebsites.net app-accountlookup-dev-001.azurewebsites.net |
| da aplicação |
A nível mundial |
func-<carga de trabalho, aplicativo ou projeto>-<ambiente>-<###>.azurewebsites.net func-navigator-prod-001.azurewebsites.net func-accountlookup-dev-001.azurewebsites.net |
Nomes de exemplo: Bancos de dados
| Tipo de ativo | Âmbito de aplicação | Formato e exemplos |
|---|---|---|
| base de dados SQL do Azure | Azure SQL Server |
sqldb-<carga de trabalho, aplicativo ou projeto>-<ambiente> sqldb-users-prod sqldb-users-dev |
| Base de dados do Azure Cosmos DB | A nível mundial |
cosmos -<carga de trabalho, aplicativo ou projeto>-<ambiente> cosmos-navigator-prod cosmos-emissions-dev |
| Instância de Azure Cache para Redis | A nível mundial |
redis-<carga de trabalho, aplicativo ou projeto>-<ambiente> redis-navigator-prod redis-emissions-dev |
Nomes de exemplo: Armazenamento
| Tipo de ativo | Âmbito de aplicação | Formato e exemplos |
|---|---|---|
| Conta de armazenamento (uso geral) | A nível mundial |
<carga de trabalho, aplicação ou projeto><###> stnavigatordata001 stemissionsoutput001 |
| Azure StorSimple | A nível mundial |
ssimp<carga de trabalho, aplicativo ou projeto><ambiente> ssimpnavigatorprod ssimpemissionsdev |
| Registro de Contêiner do Azure | A nível mundial |
cr<carga de trabalho, aplicação ou projeto de ambiente><><###> crnavigatorprod001 |
Nomes de exemplo: IA e machine learning
| Tipo de ativo | Âmbito de aplicação | Formato e exemplos |
|---|---|---|
| Pesquisa de IA do Azure | A nível mundial |
SRCH-<carga de trabalho, aplicativo ou projeto>-<ambiente> srch-navigator-prod srch-emissions-dev |
| Serviço OpenAI do Azure | Grupo de recursos |
OAI -<carga de trabalho, aplicativo ou projeto>-<ambiente> oai-navigator-prod oai-emissions-dev |
| Espaço de trabalho do Azure Machine Learning | Grupo de recursos |
<carga de trabalho, aplicativo ou projeto>-<ambiente> mlw-navigator-prod mlw-emissions-dev |
Nomes de exemplo: Analytics e IoT
| Tipo de ativo | Âmbito de aplicação | Formato e exemplos |
|---|---|---|
| Azure Analysis Services | A nível mundial |
como nome da aplicação<ambiente><> asnavigatorprod asemissionsdev |
| Azure Data Factory | A nível mundial |
adf -<carga de trabalho, aplicativo ou projeto>-<ambiente> adf-navigator-prod adf-emissions-dev |
| espaços de trabalho do Azure Synapse Analytics | Grupo de recursos |
>de carga de trabalho, aplicativo ou projeto<synw -> de ambiente< synw-navigator-prod synw-emissions-dev |
| conta de Armazenamento Data Lake | A nível mundial |
DLS<carga de trabalho, aplicativo ou projeto><ambiente> dlsnavigatorprod dlsemissionsdev |
| hub IoT | A nível mundial |
carga de trabalho, aplicação ou projeto<- ambiente de><> IoT iot-navigator-prod iot-emissions-dev |
Nomes de exemplo: Integração
| Tipo de ativo | Âmbito de aplicação | Formato e exemplos |
|---|---|---|
| namespace do Service Bus | A nível mundial |
SBNS -<carga de trabalho, aplicativo ou projeto>-<ambiente>.servicebus.windows.net sbns-navigator-prod.servicebus.windows.net sbns-emissions-dev.servicebus.windows.net |
| fila do Service Bus | Bus de Serviço |
carga de trabalho, aplicativo ou projeto<> sbq sbq-navigator |
| tópico do Service Bus | Barramento de Serviço |
SBT -<carga de trabalho, aplicativo ou projeto> sbt-navigator |
Próximo passo
Uma boa próxima etapa é examinar as abreviaturas recomendadas para recursos do Azure. As abreviaturas podem ajudá-lo a manter os nomes dos recursos dentro dos limites de comprimento e torná-los mais fáceis de ler.