Definir a 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 — 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: Componentes de um nome de recurso 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	Description
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
Nome do projeto, aplicativo ou serviço	Nome de um projeto, aplicativo ou serviço do qual o recurso faz parte. Exemplos: navigator, emissions, sharepoint, , hadoop
Ambiente	A fase do ciclo de vida do desenvolvimento da carga de trabalho suportada pelo recurso. Exemplos: prod, dev, qa, stage, , test
Location	A região ou provedor de nuvem onde o recurso é implantado. Exemplos: westus, eastus2, westeu, usva, , ustx
Função VM	Identificador da finalidade da VM. Exemplos: db (base de dados), ws (servidor web), ps (servidor de impressão)
Instância	A instância conta 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

Nota

Embora os nomes de máquina virtual (VM) no Azure possam ser maiores do que o nome NetBIOS permitido da VM, recomendamos que você os mantenha consistentes. Para obter mais informações e outras restrições, consulte Nomes de computadores.

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

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.

Por exemplo, uma rede virtual tem o escopo de um grupo de recursos, o que significa que pode haver apenas uma rede nomeada 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.

Diagrama 2: Níveis de escopo para nomes de recursos do Azure.

Regras de nomenclatura do Azure

As regras de nomenclatura do Azure variam dependendo do tipo de recurso. Ao definir uma convenção de nomenclatura, é importante entender as regras de nomenclatura do Azure para o tipo de recurso para evitar confusão e atrasar implantações.

Por exemplo, os nomes de recursos têm limites de comprimento. Recomendamos que você mantenha o comprimento dos componentes de nomenclatura curto para evitar exceder os limites de comprimento do nome do recurso.

Nota

Equilibrar o contexto de um nome com seu escopo e limite de comprimento é importante quando você desenvolve suas convenções de nomenclatura. Para obter mais informações, consulte Regras de nomenclatura e restrições para recursos do Azure.

Ao criar a sua convenção de nomenclatura, identifique as principais informações que pretende ver refletidas no nome de um recurso. Informações diferentes são relevantes para tipos de recursos diferentes. A lista a seguir fornece exemplos de informações úteis ao criar nomes de recursos.

Você pode abreviar nomes de recursos e nomear componentes como uma estratégia para reduzir o comprimento e a complexidade dos nomes de recursos. Encurtar nomes pode ser útil para qualquer um dos componentes de nomenclatura, mas é especialmente importante para ajudá-lo a manter os nomes de recursos dentro dos limites de comprimento de nome. Por exemplo, um nome de VM no Azure pode ser maior do que as restrições de nomenclatura do sistema operacional. Manter os nomes de VM do Azure mais curtos do que as restrições de nomenclatura do sistema operacional ajuda a criar consistência, melhorar a comunicação ao discutir recursos e reduzir a confusão quando você está trabalhando no portal do Azure enquanto está conectado à própria VM.

Componente de nomenclatura	Description
Tipo de recurso	Uma abreviatura que representa o tipo de recurso ou ativo do Azure. Este componente é frequentemente usado como um prefixo ou sufixo no nome. Para obter mais informações, consulte Abreviaturas recomendadas para tipos de recursos do Azure. Exemplos: rg, vm
Unidade de negócio	Divisão de nível superior da sua empresa que possui a subscrição ou carga de trabalho à qual pertence o recurso. Em organizações menores, este componente pode representar um único elemento organizacional de nível superior. Exemplos: fin, mktg, product, it, , corp
Nome do aplicativo ou serviço	Nome da aplicação, carga de trabalho ou serviço do qual o recurso faz parte. Exemplos: navigator, emissions, sharepoint, , hadoop
Finalidade da subscrição	Descrição resumida da finalidade da subscrição que contém o recurso. Muitas vezes dividido por ambiente ou cargas de trabalho específicas. Exemplos: prod, shared, client
Ambiente	A fase do ciclo de vida do desenvolvimento da carga de trabalho suportada pelo recurso. Exemplos: prod, dev, qa, stage, , test
Região	A região do Azure na qual o recurso é implementado. Exemplos: westus, eastus2, westeu, usva, , ustx

Nota

Quando estiver pronto para nomear seus recursos e ativos, revise Abreviaturas recomendadas para tipos de recursos do Azure.

A seção a seguir fornece nomes de exemplo para tipos de recursos comuns do Azure em uma implantação de nuvem corporativa.

Nota

Alguns desses nomes de exemplo usam um esquema de preenchimento de três dígitos (###), como mktg-prod-001.

O preenchimento melhora a legibilidade e a classificação de ativos quando esses ativos são gerenciados em um banco de dados de gerenciamento de configuração (CMDB), ferramenta de gerenciamento de ativos de TI ou ferramentas de contabilidade tradicionais. Quando o ativo implantado é gerenciado centralmente como parte de um inventário ou portfólio maior de ativos de TI, a abordagem de preenchimento se alinha às interfaces que esses sistemas usam para gerenciar a nomeação de inventário.

Infelizmente, a abordagem tradicional de preenchimento de ativos pode ser problemática em abordagens de infraestrutura como código que podem iterar através de ativos com base em um número não acolchoado. Essa abordagem é comum durante a implantação ou tarefas automatizadas de gerenciamento de configuração. Esses scripts teriam que remover rotineiramente o preenchimento e converter o número acolchoado em um número real, o que retarda o desenvolvimento do script e o tempo de execução.

Escolha uma abordagem adequada para a sua organização. O preenchimento mostrado aqui ilustra a importância de usar uma abordagem consistente para a numeração de inventário, em vez de mostrar qual abordagem é superior. Antes de escolher um esquema de numeração, com ou sem preenchimento, avalie o que afetará mais as operações de longo prazo: soluções de gerenciamento de ativos e CMDB ou gerenciamento de estoque baseado em código. Em seguida, siga consistentemente a opção de preenchimento que melhor se adapta às suas necessidades operacionais.

A seção a seguir fornece alguns nomes de exemplo para tipos de recursos comuns do Azure em uma implantação de nuvem corporativa. Para obter mais exemplos, consulte a Ferramenta de Nomenclatura do Azure.

Nota

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.

Exemplos de nomes: Geral

Tipo de recurso	Âmbito	Formato e exemplos
Grupo de gestão	Unidade de negócio e/ou ambiente	MG-Unidade<> de Negócios[-<Ambiente>] mg-mktg mg-hr mg-corp-prod mg-fin-client
Subscrição	Conta / contrato de empresa	<Finalidade> da subscrição da unidade>< de negócio-<###> mktg-prod-001 corp-shared-001 fin-client-001
Grupo de recursos	Subscrição	RG-app< ou nome> do serviço-finalidade>< da subscrição-<###> rg-mktgsharepoint-prod-001 rg-acctlookupsvc-shared-001 rg-ad-dir-services-shared-001
Instância de serviço de gerenciamento de API	Global	apim-app< ou nome do serviço> apim-navigator-prod
Identidade gerida	Grupo de recursos	id-app< ou nome do serviço-ambiente-região><<> nome-<>###> id-appcn-keda-prod-eastus2-001

Nomes de exemplo: Rede

Tipo de recurso	Âmbito	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-finalidade<-<><>###> snet-shared-eastus2-001 snet-prod-westus-001 snet-client-eastus2-001
Interface de rede (NIC)	Grupo de recursos	nic-<##>-<vm nome-assinatura<> finalidade>-<###> nic-01-dc1-shared-001 nic-02-vmhadoop1-prod-001 nic-02-vmtest1-client-001
Endereço IP público	Grupo de recursos	nome pip-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-app< name ou role-environment>><-<###> 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	Gateway virtual	LGW-Subscrição< Finalidade-Região>><-<###> lgw-shared-eastus2-001 lgw-prod-westus-001 lgw-client-eastus2-001
Gateway de rede virtual	Rede virtual	vgw-subscrição< finalidade-região>><-<###> vgw-shared-eastus2-001 vgw-prod-westus-001 vgw-client-eastus2-001
Conexão VPN	Grupo de recursos	vcn-subscription1< finalidade-região1-para-assinatura2>>><< finalidade-região2->><> vcn-shared-eastus2-to-shared-westus vcn-prod-eastus2-to-prod-westus
Tabela de rotas	Grupo de recursos	Nome da tabela RT-Route<> rt-navigator rt-sharepoint
Rótulo DNS	Global	<DNS Um registro para 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 recurso	Âmbito	Formato e exemplos
Máquina virtual	Grupo de recursos	vm-vm< função-ambiente<>>-<###> vm-sql-test-001 vm-hadoop-prod-001
Aplicação Web	Global	app-project<, app ou service-environment>><-<###.>azurewebsites.net app-navigator-prod-001.azurewebsites.net app-accountlookup-dev-001.azurewebsites.net
Aplicação Função	Global	func-project<, app ou service-environment>><-<###.>azurewebsites.net func-navigator-prod-001.azurewebsites.net func-accountlookup-dev-001.azurewebsites.net

Nomes de exemplo: Bancos de dados

Tipo de recurso	Âmbito	Formato e exemplos
Base de dados SQL do Azure	Azure SQL Server	sqldb-project<, aplicativo ou ambiente de< serviço>> sqldb-users-prod sqldb-users-dev
Banco de dados do Azure Cosmos DB	Global	cosmos-projeto<, aplicativo ou serviço-ambiente><> cosmos-navigator-prod cosmos-emissions-dev
Cache do Azure para instância Redis	Global	redis-projeto<, aplicativo ou ambiente de< serviço>> redis-navigator-prod redis-emissions-dev

Nomes de exemplo: Armazenamento

Tipo de recurso	Âmbito	Formato e exemplos
Conta de armazenamento (uso geral)	Global	ST<projeto, aplicativo ou serviço><###> stnavigatordata001 stemissionsoutput001
Azure StorSimple	Global	Projeto, aplicativo ou ambiente de serviço><SSIMP<> ssimpnavigatorprod ssimpemissionsdev
Azure Container Registry	Global	<Projeto, aplicativo ou ambiente>< de serviço><CR###> crnavigatorprod001

Nomes de exemplo: IA e machine learning

Tipo de recurso	Âmbito	Formato e exemplos
Azure AI Search	Global	SRCH-projeto<, aplicativo ou ambiente de< serviço>> srch-navigator-prod srch-emissions-dev
Azure OpenAI Service	Grupo de recursos	OAI-projeto<, aplicativo ou serviço-ambiente><> oai-navigator-prod oai-emissions-dev
Espaço de trabalho do Azure Machine Learning	Grupo de recursos	mlw-projeto<, aplicativo ou ambiente de< serviço>> mlw-navigator-prod mlw-emissions-dev

Nomes de exemplo: Analytics e IoT

Tipo de recurso	Âmbito	Formato e exemplos
Azure Analysis Services	Global	como ambiente de<nome><de aplicativo> asnavigatorprod asemissionsdev
Fábrica de Dados do Azure	Global	adf-projeto<, aplicativo ou serviço-ambiente><> adf-navigator-prod adf-emissions-dev
Espaços de trabalho do Azure Synapse Analytics	Grupo de recursos	synw-projeto<, aplicativo ou ambiente de< serviço>> synw-navigator-prod synw-emissions-dev
Conta de armazenamento Data Lake	Global	Projeto, aplicativo ou ambiente de serviço><DLS<> dlsnavigatorprod dlsemissionsdev
Hub IoT	Global	IoT-projeto<, aplicativo ou serviço-ambiente><> iot-navigator-prod iot-emissions-dev

Nomes de exemplo: Integração

Tipo de recurso	Âmbito	Formato e exemplos
Namespace do Service Bus	Global	sbns-projeto<, aplicativo ou serviço-ambiente.servicebus.windows.net><> sbns-navigator-prod.servicebus.windows.net sbns-emissions-dev.servicebus.windows.net
Fila do Service Bus	Service Bus	SBQ-projeto<, aplicativo ou serviço> sbq-navigator
Tópico do Service Bus	Service Bus	SBT-projeto<, aplicativo ou serviço> sbt-navigator