Definir 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 em que ele é executado. Para fazer isso, os nomes devem seguir um formato consistente— uma convenção de nomenclatura — composta por informações importantes sobre cada recurso. Idealmente, as informações nos nomes 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 de produção do SharePoint 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 entender as limitações dos tipos de recursos com os quais você está trabalhando.

Para saber mais, consulte regras de nomenclatura e restrições 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 componentes de nomenclatura que são úteis ao construir nomes de recursos:

Componente de nomenclatura	Descrição
Organização	Nome de nível superior da organização, normalmente utilizado como o grupo de gerenciamento superior ou, em organizações menores, parte da convenção de nomenclatura. Exemplo: contoso
Unidade ou departamento de negócios	Divisão de nível superior da sua empresa que possui a assinatura ou a carga de trabalho à qual 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 abreviação que representa o tipo de recurso ou ativo do Azure. Esse componente geralmente é um prefixo ou sufixo no nome. Para obter mais informações, consulte Abreviações 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	A fase do ciclo de vida de desenvolvimento da carga de trabalho compatível com o recurso. Exemplos: prod, dev, qa, stage, test
Região	A região ou o provedor de nuvem em que 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 têm a mesma convenção de nomenclatura e componentes de nomenclatura. Exemplos, 01, 001

Considerações de nomenclatura

Além de definir os componentes de nomenclatura, você também deve considerar a ordem na qual os componentes de nomenclatura estão listados e que tipo de delimitadores (se houver) devem aparecer entre componentes. Também leve em conta as diferentes regras de nomenclatura associadas aos tipos de recursos.

Escopo

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: Exclusivo em todo o Azure.

  Exemplo: nome dos recursos de PaaS com pontos de extremidade IP públicos em todo o Azure, pois esse nome é o 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.

• Recurso únicodentro do recurso principal.

  Exemplo: todas as sub-redes em uma rede virtual devem ter nomes exclusivos para evitar a sobreposição de segmento.

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 PaaS (Plataforma como Serviço) 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 do 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ão e atrasos.

Por exemplo, os nomes de recursos para diferentes tipos de recursos podem ter limites de comprimento diferentes. Recomendamos que você mantenha o comprimento dos componentes de nomenclatura curto ou abrevie os nomes de recursos para evitar exceder os limites de comprimento do nome do recurso.

Ao construir sua convenção de nomenclatura, identifique as principais informações que você deseja refletir em um nome de recurso. Informações diferentes são relevantes para diferentes tipos de recursos.

Recomendações:

• Noções básicas sobre regras de nomenclatura e restrições: balancear o contexto de um nome com seu limite de escopo e comprimento é importante ao desenvolver suas convenções de nomenclatura. Para obter mais informações, consulte regras de nomenclatura e restrições para recursos do Azure.
• Usar abreviações de recursos recomendadas: abreviações podem ajudá-lo a manter os nomes de recursos dentro dos limites de comprimento e torná-los mais fáceis de ler. Para obter mais informações, consulte Abreviações 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 os nomes consistentes, embora os nomes de VM no Azure possam ser mais longos do que o nome NetBIOS permitido da VM. Para obter mais informações e outras restrições, consulte Convenções de nomenclatura no Active 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 esses exemplos ao definir sua convenção de nomenclatura. Os exemplos se baseiam 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 mais exemplos, veja a Ferramenta de Nomenclatura do Azure .

Nomes de exemplo: Geral

Tipo de ativo	Escopo	Formato e exemplos
Grupo de gerenciamento	Unidade de negócios e/ou ambiente	mg-<unidade de negócios>[-<ambiente>] mg-mktg mg-hr mg-corp-prod mg-fin-client
Assinatura	Contrato de conta/empresa	<unidade de negócios>-<finalidade de assinatura>-<###> mktg-prod-001 corp-shared-001 fin-client-001
Grupo de recursos	Subscrição	rg-<nome do aplicativo ou serviço>-<finalidade de assinatura>-<###> rg-mktgsharepoint-prod-001 rg-acctlookupsvc-shared-001 rg-ad-dir-services-shared-001
Instância de serviço do Gerenciamento de API	Global	apim-<nome do aplicativo ou serviço> apim-navigator-prod
Identidade gerenciada	Grupo de recursos	id-<nome de serviço ou aplicativo>-<ambiente>-<nome da região>-<###> id-appcn-keda-prod-eastus2-001

Nomes de exemplo: Rede

Tipo de ativo	Escopo	Formato e exemplos
Rede virtual	Grupo de recursos	vnet-<finalidade de assinatura>-<região>-<###> vnet-shared-eastus2-001 vnet-prod-westus-001 vnet-client-eastus2-001
Sub-rede	Rede virtual	snet-<finalidade de assinatura>-<região>-<###> snet-shared-eastus2-001 snet-prod-westus-001 snet-client-eastus2-001
NIC (adaptador de rede)	Grupo de recursos	nic-<##>-<nome da VM>-<finalidadede 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 do aplicativo>-<ambiente>-<região>-<###> pip-dc1-shared-eastus2-001 pip-hadoop-prod-westus-001
balanceador de carga (externo)	Grupo de recursos	lbe-<nome do aplicativo ou função>-<ambiente>-<###> lbe-navigator-prod-001 lbe-sharepoint-dev-001
Grupo de segurança de rede (NSG)	Sub-rede ou 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	lgw-<finalidade de assinatura>-<região>-<###> lgw-shared-eastus2-001 lgw-prod-westus-001 lgw-client-eastus2-001
Gateway de rede virtual	Rede virtual	vgw-<finalidade de assinatura>-<região>-<###> vgw-shared-eastus2-001 vgw-prod-westus-001 vgw-client-eastus2-001
Conexão VPN	Grupo de recursos	vcn-<finalidade da inscrição1>>-<região1>-para-<finalidade da inscrição2>>-<região2>- 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	Global	<registro DNS A para a VM>.<região>.cloudapp.azure.com dc1.westus.cloudapp.azure.com web1.eastus2.cloudapp.azure.com

Nomes de exemplo: Computação e Web

Tipo de ativo	Escopo	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
Aplicativo Web	Global	app-<carga de trabalho, aplicativo ou projeto>-<ambiente>-<###>.azurewebsites.net app-navigator-prod-001.azurewebsites.net app-accountlookup-dev-001.azurewebsites.net
Aplicativo de funções	Global	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	Escopo	Formato e exemplos
Banco de Dados SQL do Azure	Azure SQL Server	sqldb-<carga de trabalho, aplicativo ou projeto>-<ambiente> sqldb-users-prod sqldb-users-dev
Banco de dados do Azure Cosmos DB	Global	cosmos-<carga de trabalho, aplicativo ou projeto>-<ambiente> cosmos-navigator-prod cosmos-emissions-dev
Instância do Cache do Azure para Redis	Global	redis-<carga de trabalho, aplicativo ou projeto>-<ambiente> redis-navigator-prod redis-emissions-dev

Nomes de exemplo: Armazenamento

Tipo de ativo	Escopo	Formato e exemplos
conta de armazenamento (uso geral)	Global	st<carga de trabalho, aplicativo ou projeto><###> stnavigatordata001 stemissionsoutput001
Azure StorSimple	Global	ssimp<carga de trabalho, aplicativo ou projeto><ambiente> ssimpnavigatorprod ssimpemissionsdev
Registro de Contêiner do Azure	Global	cr<carga de trabalho, aplicativo ou projeto><ambiente><###> crnavigatorprod001

Nomes de exemplo: IA e machine learning

Tipo de ativo	Escopo	Formato e exemplos
Pesquisa de IA do Azure	Global	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	mlw-<carga de trabalho, aplicativo ou projeto>-<ambiente> mlw-navigator-prod mlw-emissions-dev

Nomes de exemplo: Análise e IoT

Tipo de ativo	Escopo	Formato e exemplos
Azure Analysis Services	Global	como nome do aplicativo<ambiente><> asnavigatorprod asemissionsdev
Azure Data Factory	Global	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	synw-<carga de trabalho, aplicativo ou projeto>-<ambiente> synw-navigator-prod synw-emissions-dev
Conta do Data Lake Storage	Global	dls<carga de trabalho, aplicativo ou projeto><ambiente> dlsnavigatorprod dlsemissionsdev
Hub IoT	Global	iot-<carga de trabalho, aplicativo ou projeto>-<ambiente> iot-navigator-prod iot-emissions-dev

Nomes de exemplo: Integração

Tipo de ativo	Escopo	Formato e exemplos
Namespace do Barramento de Serviço	Global	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 Barramento de Serviço	Barramento de Serviço	sbq-<carga de trabalho, aplicativo ou projeto> sbq-navigator
Tópico do Barramento de Serviço	Barramento de Serviço	sbt-<carga de trabalho, aplicativo ou projeto> sbt-navigator

Próxima etapa

Uma boa próxima etapa é examinar as abreviações recomendadas para recursos do Azure. As abreviações podem ajudá-lo a manter os nomes de recursos dentro dos limites de comprimento e torná-los mais fáceis de ler.

Abreviações para tipos de recursos