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 onde ele é executado. Para fazer 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 incluem idealmente 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: 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 você 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 nomeação 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 gerenciamento superior ou, em organizações menores, 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 assinatura ou da 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 saber mais, confira Abreviações 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 de desenvolvimento da carga de trabalho compatível com o recurso. Exemplos: prod, dev, qa, stage, test |
| Localidade | A região ou o provedor de nuvem onde o recurso está implantado. Exemplos: westus, eastus2, westeu, usva, ustx |
| Função VM | Identificador da finalidade da VM. Exemplos: db (banco de dados), ws (servidor web), ps (servidor de impressão) |
| 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 |
Observação
Embora os nomes de máquina virtual (VM) no Azure possam ser mais longos 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 computador.
Considerações sobre nomenclatura
Além de definir os componentes de nomenclatura, você também deve considerar a ordem em que os componentes de nomeação são listados e que tipo de delimitadores (se houver) devem aparecer entre os componentes. Leve também 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 em 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 escopo para redes virtuais, portanto, cada sub-rede em 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 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. Quando você define uma convenção de nomenclatura, é importante entender as regras de nomenclatura do Azure para o tipo de recurso para evitar confusão e atrasar as implantações.
Por exemplo, os nomes de recursos têm limites de comprimento. Recomendamos que você mantenha o comprimento dos componentes de nomeação curto para evitar exceder os limites de comprimento do nome do recurso.
Observação
Equilibrar o contexto de um nome com seu escopo e limite de comprimento é importante ao desenvolver suas convenções de nomenclatura. Para saber mais, confira Regras de nomenclatura e restrições para recursos do Azure.
Ao construir sua convenção de nomenclatura, identifique as principais partes de informações que você deseja refletir em um nome de recurso. Diferentes informações são relevantes para diferentes tipos de recurso. A lista a seguir fornece exemplos de informações úteis quando você cria 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 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 | Descrição |
|---|---|
| Tipo de recurso | Uma abreviação que representa o tipo de recurso ou ativo do Azure. Muitas vezes, esse componente é usado como um prefixo ou sufixo no nome. Para saber mais, confira Abreviações recomendadas para tipos de recursos do Azure. Exemplos: rg, vm |
| Unidade de negócios | Divisão de nível superior da sua empresa que tem 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 |
| Nome do aplicativo ou serviço | Nome do aplicativo, da carga de trabalho ou do serviço do qual o recurso faz parte. Exemplos: navigator, emissions, sharepoint, hadoop |
| Finalidade da assinatura | Descrição resumida da finalidade da assinatura 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 de desenvolvimento da carga de trabalho compatível com o recurso. Exemplos: prod, dev, qa, stage, test |
| Região | A região do Azure em que o recurso é implantado. Exemplos: westus, eastus2, westeu, usva, ustx |
Observação
Quando estiver pronto para nomear seus recursos e ativos, revise Abreviações 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.
Observação
Alguns desses exemplos de nomes usam um esquema de preenchimento com três dígitos (###), como mktg-prod-001.
O preenchimento aprimora a leitura e a classificação dos ativos quando eles são gerenciados em um CMDB (banco de dados de gerenciamento de configuração), uma ferramenta de Gerenciamento de Ativos de IT ou em 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 nomenclatura do inventário.
Infelizmente, a abordagem tradicional de preenchimento de ativos pode ser problemática em abordagens de infraestrutura como código que podem iterar por meio de ativos com base em um número não acolchoado. Essa abordagem é comum durante a implantação ou em tarefas de gerenciamento de configuração automatizadas. Esses scripts teriam que retirar rotineiramente o preenchimento e converter o número de preenchimento em um número real, o que retarda o desenvolvimento e o tempo de execução do script.
Escolha uma abordagem adequada para sua organização. O preenchimento mostrado aqui ilustra a importância de usar uma abordagem consistente para a numeração de estoque, 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: CMDB e soluções de gerenciamento de ativos 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 exemplos de nomes para tipos de recursos comuns do Azure em uma implantação de nuvem empresarial. Para obter mais exemplos, consulte a Ferramenta de Nomenclatura do Azure e o modelo de acompanhamento de nomenclatura e marcação.
Observação
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.
Nomes de exemplo: Geral
| Tipo de ativo | Escopo | Formato e exemplos |
|---|---|---|
| Grupo de gerenciamento | Unidade de negócio e/ou ambiente |
MG-Unidade<> de Negócios[-<Ambiente>] mg-mktg mg-hr mg-corp-prod mg-fin-client |
| Assinatura | Conta/Contrato Enterprise | <unidade> de negócio-finalidade> da< subscrição-<###> mktg-prod-001 corp-shared-001 fin-client-001 |
| Grupo de recursos | Assinatura | rg-app< ou nome> do 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 gerenciamento de API | Global | apim-<nome do aplicativo ou serviço> apim-navigator-prod |
| Identidade gerenciada | Grupo de recursos | id-app< ou nome do serviço-nome-ambiente-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-subscription< purpose-region>><-<###> vnet-shared-eastus2-001 vnet-prod-westus-001 vnet-client-eastus2-001 |
| Sub-rede | Rede virtual | snet-assinatura< finalidade-região>><-<###> snet-shared-eastus2-001 snet-prod-westus-001 snet-client-eastus2-001 |
| NIC (Adaptador de rede) | Grupo de recursos | nic-<##>-<vm nome-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 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 ambiente> de< função>-<###> lbe-navigator-prod-001 lbe-sharepoint-dev-001 |
| NSG (Grupo de segurança de rede) | Sub-rede ou NIC | nsg-<nome da política ou do aplicativo>-<###> nsg-weballow-001 nsg-rdpallow-001 nsg-sqlallow-001 nsg-dnsblocked-001 |
| Gateway de rede local | Gateway virtual | lgw-assinatura< finalidade-região>><-<###> lgw-shared-eastus2-001 lgw-prod-westus-001 lgw-client-eastus2-001 |
| Gateway de rede virtual | Rede virtual | vgw-assinatura< finalidade-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 | Nome da tabela RT-Route<> 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-vm< role-environment<>>-<###> vm-sql-test-001 vm-hadoop-prod-001 |
| Aplicativo Web | Global | app-project<, app ou service-environment>><-<###>.azurewebsites.net app-navigator-prod-001.azurewebsites.net app-accountlookup-dev-001.azurewebsites.net |
| Aplicativo de funções | 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 ativo | Escopo | Formato e exemplos |
|---|---|---|
| Banco 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 |
| Instância do Cache do Azure para Redis | Global | redis-projeto<, aplicativo ou ambiente de< serviço>> redis-navigator-prod redis-emissions-dev |
Nomes de exemplo: Armazenamento
| Tipo de ativo | Escopo | Formato e exemplos |
|---|---|---|
| Conta de armazenamento (uso geral) | Global | ST<projeto, aplicativo ou serviço><###> stnavigatordata001 stemissionsoutput001 |
| Azure StorSimple | Global | Ambiente de projeto, aplicativo ou serviço><SSIMP<> ssimpnavigatorprod ssimpemissionsdev |
| Registro de Contêiner do Azure | Global | <Ambiente>< de projeto, aplicativo ou serviço><de CR###> crnavigatorprod001 |
Nomes de exemplo: IA e aprendizado de máquina
| Tipo de ativo | Escopo | Formato e exemplos |
|---|---|---|
| Azure AI Search | Global | srch-projeto<, aplicativo ou serviço-ambiente><> srch-navigator-prod srch-emissions-dev |
| Serviço OpenAI do Azure | Grupo de recursos | oai-projeto<, aplicativo ou serviço-ambiente><> oai-navigator-prod oai-emissions-dev |
| Workspace do Azure Machine Learning | Grupo de recursos | mlw-projeto<, aplicativo ou serviço-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<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-project<, aplicativo ou ambiente de< serviço>> synw-navigator-prod synw-emissions-dev |
| Conta do Data Lake Storage | Global | Ambiente de projeto, aplicativo ou serviço><DLS<> dlsnavigatorprod dlsemissionsdev |
| Hub IoT | Global | IoT-projeto<, aplicativo ou ambiente de< serviço>> 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-projeto<, aplicativo ou ambiente> de< serviço.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-projeto<, aplicativo ou serviço> sbq-navigator |
| Tópico do Barramento de Serviço | Barramento de Serviço | sbt-projeto<, aplicativo ou serviço> sbt-navigator |