Partilhar via

Defina sua convenção de nomenclatura

As convenções de nomenclatura fornecem formatos padronizados para atribuir nomes aos recursos do Azure. Cada organização precisa de uma convenção de nomenclatura personalizada que atenda aos requisitos do Azure e às necessidades específicas de adoção da nuvem. Esta orientação fornece uma base que você pode adaptar para se alinhar com seus requisitos organizacionais.

Veja exemplos:Exemplos de nomes de recursos do Azure

Compreender nomes de recursos no Azure

Um nome de recurso do Azure é o identificador atribuído a uma instância específica de um recurso do Azure, como um aplicativo Web, banco de dados ou conta de armazenamento. Para estabelecer uma convenção de nomenclatura do Azure consistente, você precisa entender como o Azure funciona. Eis o que necessita de saber:

  1. Compreenda a persistência do nome. A maioria dos nomes de recursos do Azure não pode ser alterada após a criação. Inclua apenas informações que permaneçam constantes no nome. Use tags para capturar outros detalhes.

  2. Entenda as regras de nomenclatura do Azure. Há regras de nomenclatura para cada recurso do Azure. Nem todos os nomes de 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. Os nomes do Azure devem seguir três princípios gerais:

    • Os nomes precisam ser exclusivos dentro do escopo do recurso do Azure (varia de acordo com o recurso).
    • Os nomes precisam atender aos requisitos de comprimento (varia de acordo com o recurso).
    • Os nomes só podem conter caracteres válidos (varia de acordo com o recurso).

  3. Entenda o escopo do nome do Azure. Os nomes de recursos do Azure devem ser exclusivos dentro de seu escopo definido. Cada tipo de recurso tem um nível de escopo específico que determina onde o nome deve ser exclusivo. Compreender esses níveis de escopo garante convenções de nomenclatura adequadas e evita conflitos.

    Âmbito de aplicação Descrição Exemplo
    A nível mundial Único em todo o Azure. Esse escopo se aplica a recursos PaaS com pontos de extremidade IP públicos, pois seus nomes servem como o nome DNS público padrão inicial. Por exemplo, um aplicativo Web nomeado app-navigator-prod-001.azurewebsites.net deve ser globalmente exclusivo.
    Grupo de recursos Exclusivo dentro do grupo de recursos. Recursos no mesmo grupo não podem compartilhar o mesmo nome, mas nomes idênticos podem existir em grupos de recursos diferentes. Por exemplo, uma rede virtual nomeada vnet-prod-westus-001 pode existir em vários grupos de recursos, mas apenas uma vez dentro de um único grupo de recursos.
    Recurso Exclusivo dentro do recurso pai. Os recursos aninhados em outro recurso devem ter nomes exclusivos para evitar conflitos. Por exemplo, as sub-redes dentro de uma rede virtual devem ter nomes exclusivos para evitar a sobreposição de segmentos.

Escolher componentes de nomenclatura

A lista a seguir fornece exemplos de nomenclatura de componentes (o que incluir no nome) que são úteis para construir nomes de recursos do Azure:

Componente de nomenclatura Descrição Componente de exemplo Exemplo de recurso do Azure
Tipo de recurso Uma abreviatura que representa o tipo de recurso ou ativo do Azure. rg, vm, st, app rg-navigator-prod-001, vm-web-prod-001
Carga de trabalho, aplicativo ou projeto Nome de uma carga de trabalho, aplicativo ou projeto do qual o recurso faz parte. navigator, emissions, sharepoint, hadoop app-navigator-prod, vm-sharepoint-dev-001
Ambiente Produção, desenvolvimento, garantia de qualidade, estágio, teste. prod, dev, qa, stage, test app-navigator-prod, sqldb-dev
Região A região do Azure ou o local do provedor de nuvem onde o recurso é implantado. westus, eastus2, westeu, usva, ustx vnet-shared-eastus2-001, pip-hadoop-prod-westus-001
Número da 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. 01, 001 vm-sql-test-001, vm-sql-test-002

Desenvolva sua convenção de nomenclatura

Para construir sua convenção de nomenclatura do Azure, 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.

  1. Padronize a ordem dos componentes. Além de definir os componentes de nomenclatura, você também deve considerar a ordem em que os componentes de nomenclatura são listados.

  2. Escolha usar um delimitador ou não. Para melhorar a legibilidade, use um hífen - para separar os componentes de nomenclatura. No entanto, nem todos os recursos no Azure permitem que você use um delimitador. Se você precisar de consistência absoluta em todos os seus nomes de recursos do Azure, não use um hífen. Para muitos clientes, os benefícios de usar um delimitador superam alguma inconsistência na convenção de nomenclatura.

  3. Utilize abreviaturas. Use as abreviaturas de recursos do Azure para manter os nomes de recursos dentro dos limites de comprimento.

  4. Use a Ferramenta de Nomenclatura do Azure. A Ferramenta de Nomenclatura do Azure é uma ferramenta que ajuda você a gerar nomes para recursos do Azure. Você configura a ferramenta para usar sua convenção de nomenclatura preferida e ela gera nomes para seus recursos do Azure. Para obter mais informações, consulte Ferramenta de Nomenclatura do Azure.

Exemplo de nomes de recursos do Azure

Considere estes exemplos ao definir sua convenção de nomenclatura do Azure. Os exemplos são baseados nos componentes de nomenclatura e nas considerações descritas neste artigo.

IA e aprendizagem automática

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
    		•

    Analytics e IoT

    Tipo de ativo Âmbito de aplicação Formato e exemplos
    Fábrica de Dados do Azure A nível mundial adf -<carga de trabalho, aplicativo ou projeto>-<ambiente>

  • adf-navigator-prod
  • adf-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
    		•

    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 Function 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
    		•

    Bases 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
    		•

    Integração

    Tipo de ativo Âmbito de aplicação Formato e exemplos
    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
    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 Barramento 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
    		•

    Gestão e governação

    Tipo de ativo Âmbito de aplicação Formato e exemplos
    Grupo de gestão Tenant Forneça um identificador global exclusivo (GUID) para o ID do grupo de gerenciamento. Os nomes de exibição são editáveis e devem representar a função da plataforma ou os tipos de carga de trabalho dentro deles.
    Assinatura Conta do Azure ou contrato Enterprise Nome descritivo que se alinha aos padrões de TI. Você pode alterar o nome de exibição. Exemplo: (Unidade de Negócios (opcional)) (Função ou Carga de Trabalho) (Ambiente)

  • Marketing Web App Production
  • Connectivity
  • Security
    		•
    Grupo de recursos Subscrição RG-Nome da carga de trabalho/Tipo-componente de carga de trabalho (opcional)-Ambiente (opcional)

  • rg-webapp-prod
  • rg-webapp-database-dev
    		•

    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-<assinatura1 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 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
    		•

    Segurança

    Tipo de ativo Âmbito de aplicação Formato e exemplos
    Identidade gerenciada Grupo de recursos ID <nome do aplicativo ou serviço>-<ambiente ->-<nome da região>-<###>

  • id-appcn-keda-prod-eastus2-001
    		•

    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
    		•
    Registro de Contêiner do Azure A nível mundial cr<carga de trabalho, aplicação ou projeto de ambiente><><###>

  • crnavigatorprod001
    		•

    Próximo passo

    Um bom próximo passo é definir a sua estratégia de etiquetagem.

    Defina a sua estratégia de etiquetagem