Compartilhar via

Definir sua convenção de nomenclatura

As convenções de nomenclatura fornecem formatos padronizados para atribuir nomes a 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. Essas diretrizes fornecem uma base para que você possa se adaptar para se alinhar aos seus requisitos organizacionais.

Veja exemplos:Exemplos de nomes de recursos do Azure

Entender os 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, um banco de dados ou uma conta de armazenamento. Para estabelecer uma convenção de nomenclatura consistente do Azure, você precisa entender como o Azure funciona. Veja o que você precisa saber:

  1. Entenda a permanê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 permanecem constantes no nome. Use etiquetas 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 entender as limitações dos tipos de recursos com os quais você está trabalhando. Os nomes do Azure devem seguir três princípios gerais:

    • Os nomes precisam ser exclusivos no 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 no escopo definido. Cada tipo de recurso tem um nível de escopo específico que determina onde o nome deve ser exclusivo. Entender esses níveis de escopo garante convenções de nomenclatura adequadas e evita conflitos.

    Scope Descrição Exemplo
    Global Exclusivo em todo o Azure. Esse escopo se aplica aos recursos de 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 no grupo de recursos. Os 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 em uma rede virtual devem ter nomes exclusivos para impedir a sobreposição de segmento.

Escolher componentes de nomenclatura

A lista a seguir fornece exemplos de componentes de nomenclatura (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 abreviação que representa o tipo de recurso ou ativo do Azure. rg, vm, , stapp 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, , sharepointhadoop app-navigator-prod, vm-sharepoint-dev-001
Ambiente. Produção, desenvolvimento, garantia de qualidade, estágio, teste. prod, dev, qa, , stagetest app-navigator-prod, sqldb-dev
Região A região do Azure ou o local do provedor de nuvem em que o recurso é implantado. westus, eastus2, westeu, , usvaustx 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 têm 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. Padronizar a ordem do componente. Além de definir os componentes de nomenclatura, você também deve considerar a ordem na qual os componentes de nomenclatura estão listados.

  2. Escolha usar um delimitador ou não. Para melhorar a legibilidade, use um hífen - para separar 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 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. Use abreviações. Use abreviações 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 preferencial 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 esses exemplos ao definir sua convenção de nomenclatura do Azure. Os exemplos se baseiam nos componentes de nomenclatura e nas considerações descritas neste artigo.

IA e aprendizado de máquina

Tipo de ativo Scope 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
    		•

    Análise e IoT

    Tipo de ativo Scope Formato e exemplos
    Fábrica de dados do Azure Global adf-<carga de trabalho, aplicativo ou projeto>-<ambiente>

  • adf-navigator-prod
  • adf-emissions-dev
    		•
    Conta do Data Lake Storage Global dls<carga de trabalho, aplicativo ou projeto><ambiente>

  • dlsnavigatorprod
  • dlsemissionsdev
    		•
    Hub de IoT Global iot-<carga de trabalho, aplicativo ou projeto>-<ambiente>

  • iot-navigator-prod
  • iot-emissions-dev
    		•

    Computação e web

    Tipo de ativo Scope 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
    		•

    Bancos de dados

    Tipo de ativo Scope 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 de Cache do Azure para Redis Global redis-<carga de trabalho, aplicativo ou projeto>-<ambiente>

  • redis-navigator-prod
  • redis-emissions-dev
    		•

    Integração

    Tipo de ativo Scope Formato e exemplos
    Instância de serviço de API Management Global apim-<nome do aplicativo ou serviço>

    apim-navigator-prod
    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 de barramento de serviço Barramento de Serviço sbq-<carga de trabalho, aplicativo ou projeto>

  • sbq-navigator
    		•
    Tópico sobre Barramento de Serviço Barramento de Serviço sbt-<carga de trabalho, aplicativo ou projeto>

  • sbt-navigator
    		•

    Gerenciamento e governança

    Tipo de ativo Scope Formato e exemplos
    Grupo de gerenciamento Inquilino Forneça um GUID (identificador global exclusivo) para a ID do grupo de gerenciamento. Os nomes de exibição são editáveis e devem representar a função de 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-workload name/type-workload component (opcional)-environment (opcional)

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

    Rede

    Tipo de ativo Scope Formato e exemplos
    Rede virtual Grupo de recursos vnet-<finalidade da assinatura>-<região>-<###>

  • vnet-shared-eastus2-001
  • vnet-prod-westus-001
  • vnet-client-eastus2-001
    		•
    Sub-rede Rede virtual snet-<finalidade da 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>-<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 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 da assinatura>-<região>-<###>

  • lgw-shared-eastus2-001
  • lgw-prod-westus-001
  • lgw-client-eastus2-001
    		•
    Gateway da rede virtual Rede virtual vgw-<finalidade da assinatura>-<região>-<###>

  • vgw-shared-eastus2-001
  • vgw-prod-westus-001
  • vgw-client-eastus2-001
    		•
    Conexão de 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 de DNS Global <Registro DNS A para a VM>.<região>.cloudapp.azure.com

  • dc1.westus.cloudapp.azure.com
  • web1.eastus2.cloudapp.azure.com
    		•

    Segurança

    Tipo de ativo Scope Formato e exemplos
    Identidade gerenciada Grupo de recursos id-<nome de serviço ou aplicativo>-<ambiente>-<nome da região>-<###>

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

    Armazenamento

    Tipo de ativo Scope Formato e exemplos
    conta de armazenamento (uso geral) Global st<carga de trabalho, aplicativo ou projeto><###>

  • stnavigatordata001
  • stemissionsoutput001
    		•
    Registro de Contêiner do Azure Global cr<carga de trabalho, aplicativo ou projeto><ambiente><###>

  • crnavigatorprod001
    		•

    Próxima etapa

    Uma boa próxima etapa é definir sua estratégia de tagueamento.

    Defina sua estratégia de marcação

    • Last updated on