Определение соглашения об именовании

Хорошее имя ресурса помогает быстро определить тип, связанную рабочую нагрузку, среду и регион Azure, где он работает. Для этого имена должны соответствовать согласованному формату — соглашению об именовании, состоящему из важных сведений о каждом ресурсе. Сведения в именах в идеале включают все необходимые экземпляры ресурсов. Например, общедоступный IP-адрес (PIP) рабочей нагрузки SharePoint в регионе "Западная часть США" может быть pip-sharepoint-prod-westus-001.

Diagram that shows the components of an Azure resource name.

Схема 1. компоненты имени ресурса Azure.

При создании соглашения об именовании определите ключевые фрагменты информации, которые необходимо записать в имени ресурса. Различные сведения относятся к разным типам ресурсов, а для каждого типа ресурсов можно использовать не все установленные компоненты именования. Создайте стандартное соглашение об именовании для вашей среды, которое легко следовать, кратко и полезно для распознавания информации, соответствующей развернутой ресурсу.

В следующем списке приведены примеры компонентов именования, которые полезны при создании имен ресурсов:

Компонент именования Description
Предприятие Имя верхнего уровня организации, обычно используемое в качестве высшей группы управления или в небольших организациях, часть соглашения об именовании. Пример: contoso
Подразделение или отдел Подразделение верхнего уровня вашей компании, владеющее подпиской или рабочей нагрузкой, к которой принадлежит ресурс. В небольших организациях этот компонент может представлять единый корпоративный, высокоуровневый организационный элемент. Примеры: fin, mktg, product, it, corp
Тип ресурса Сокращение, представляющее тип ресурса или файла Azure. Этот компонент часто является префиксом или суффиксом в имени. Дополнительные сведения см. в статье Рекомендуемые сокращения для типов ресурсов Azure. Примеры: rg, vm
Имя проекта, приложения или службы Имя проекта, приложения или службы, в которую входит ресурс. Примеры: navigator, emissions, sharepoint, hadoop
Среда Этап жизненного цикла разработки для рабочей нагрузки, поддерживаемой ресурсом. Примеры: prod, dev, qa, stage, test
Местонахождение Регион или поставщик облачных служб, в которых развернут ресурс. Примеры: westus, eastus2, westeu, usva, ustx
Роль виртуальной машины Идентификатор назначения виртуальной машины. Примеры: db (база данных), ws (веб-сервер), ps (сервер печати)
Экземпляр Число экземпляров для определенного ресурса, чтобы отличить его от других ресурсов, имеющих то же соглашение об именовании и компоненты именования. Примеры, , 01001

Примечание.

Хотя имена виртуальных машин в Azure могут быть длиннее разрешенного имени NetBIOS виртуальной машины, рекомендуется сохранить их согласованными. Дополнительные сведения и другие ограничения см. в разделе "Имена компьютеров".

Рекомендации по именованию

Помимо определения компонентов именования, необходимо также учитывать порядок, в котором перечислены компоненты именования и какие типы разделителей (если таковые имеются) должны отображаться между компонентами. Также учитывайте различные правила именования, связанные с типами ресурсов.

Область

Все типы ресурсов Azure имеют область, определяющие уровень этого ресурса. Кроме того, ресурс должен иметь уникальное имя в область.

Например, виртуальная сеть имеет область группы ресурсов, что означает, что в определенной группе ресурсов может быть только одна сетьvnet-prod-westus-001. Другие группы ресурсов также могут иметь имена виртуальных сетей vnet-prod-westus-001, но каждая группа ресурсов может иметь только одну с этим именем. Подсети ограничены виртуальными сетями, поэтому каждая подсеть в виртуальной сети должна иметь уникальное имя.

Некоторые имена ресурсов имеют глобальную область, например имя платформы как службы (PaaS), которая имеет общедоступную конечную точку или метку DNS виртуальной машины. Ресурс в глобальной область должен иметь имя, уникальное для всей платформы Azure.

Diagram that shows the scope levels for Azure resource names.

Схема 2. Уровни области для имен ресурсов Azure.

Правила именования Azure

Правила именования Azure зависят от типа ресурса. При определении соглашения об именовании важно понимать правила именования Azure для типа ресурса, чтобы избежать путаницы и задержки развертываний.

Например, имена ресурсов имеют ограничения длины. Рекомендуется ограничить длину компонентов именования короткими, чтобы предотвратить превышение ограничений длины имени ресурса.

Примечание.

Балансировка контекста имени с его область и ограничением длины важно при разработке соглашений об именовании. Дополнительные сведения см. в статье Правила и ограничения именования для ресурсов Azure.

При создании соглашения об именовании необходимо определить ключевые фрагменты информации, которые необходимо отразить в имени ресурса. К разным типам ресурсов относятся разные сведения. В следующем списке приведены примеры информации, полезной при создании имен ресурсов.

Имена ресурсов и компоненты именования можно сократить в качестве стратегии, чтобы уменьшить длину и сложность имен ресурсов. Сокращение имен может быть полезно для любого из компонентов именования, но особенно важно, чтобы вы могли хранить имена ресурсов в пределах ограничений длины имен. Например, имя виртуальной машины в Azure может превышать ограничения именования ОС. Сохранение имен виртуальных машин Azure короче ограничений именования ОС помогает создавать согласованность, улучшать взаимодействие при обсуждении ресурсов и уменьшать путаницу при работе с портал Azure при входе в саму виртуальную машину.

Компонент именования Description
Тип ресурса Сокращение, представляющее тип ресурса или файла Azure. Этот компонент часто используется в имени как префикс или суффикс. Дополнительные сведения см. в статье Рекомендуемые сокращения для типов ресурсов Azure.
Примеры: rg, vm
Бизнес-единица Подразделение высшего уровня компании, которому принадлежит подписка или рабочая нагрузка, к которой принадлежит ресурс. В небольших организациях этот компонент может представлять собой единый корпоративный организационный элемент верхнего уровня.
Примеры: fin, mktg, product, it, corp
Имя приложения или службы Имя приложения, рабочей нагрузки или службы, частью которой является ресурс.
Примеры: navigator, emissions, sharepoint, hadoop
Назначение подписки Краткое описание назначения подписки, содержащей ресурс. Часто разбиваются по среде или конкретным рабочим нагрузкам.
Примеры: prod, shared, client
Среда Этап жизненного цикла разработки для рабочей нагрузки, поддерживаемой ресурсом.
Примеры: prod, dev, qa, stage, test
Регион Регион Azure, в котором развернут ресурс.
Примеры: westus, eastus2, westeu, usva, ustx

Примечание.

Когда вы будете готовы назвать ресурсы и ресурсы, просмотрите рекомендуемые сокращены для типов ресурсов Azure.

В следующем разделе приведены примеры имен распространенных типов ресурсов Azure в развертывании корпоративного облака.

Примечание.

В некоторых примерах имен используется схема заполнения с тремя цифрами (###), например mktg-prod-001.

Заполнение улучшает удобочитаемость и сортировку ресурсов, если эти ресурсы управляются в базе данных управления конфигурацией (CMDB), средстве управления ИТ-ресурсами или традиционных средствах учета. Если управление развернутым ресурсом выполняется централизованно в рамках более крупного запаса или портфеля ИТ-ресурсов, следует использовать тот способ заполнения, который соответствует интерфейсам, используемым в системе управления наименования запасов.

К сожалению, традиционный подход к заполнению активов может оказаться проблематичным в подходах инфраструктуры как кода, которые могут выполнять итерацию по ресурсам на основе незаполнения номера. Такой подход часто встречается в задачах развертывания или автоматизированного управления конфигурацией. Скрипты должны будут регулярно убирать заполнение и преобразовывать заполненное число в реальное число, что замедляет разработку и выполнение скриптов.

Выберите подход, который подходит для вашей организации. Заполнение, показанное здесь, иллюстрирует важность использования согласованного подхода к нумеровкам инвентаризации, а не показывает, какой подход выше. Прежде чем выбирать схему нумерирования с заполнением или без нее, оцените, что повлияет на долгосрочные операции больше: CMDB и решения для управления активами или управление инвентаризацией на основе кода. Затем последовательно следуйте варианту заполнения, который лучше всего соответствует вашим операционным потребностям.

В следующем разделе приведены примеры имен распространенных типов ресурсов Azure в корпоративном облачном развертывании. Дополнительные примеры см. в средстве именования Azure и шаблоне отслеживания именования и тегов.

Примечание.

Следующие примеры предназначены для визуализации соглашения об именовании, но фактические соглашения зависят от организации.

Примеры имен: общие

Вид актива Область Формат и примеры
Группа управления Бизнес-подразделение и/или
environment
подразделение mg-business<>[-<environment>]

  • mg-mktg
  • mg-hr
  • mg-corp-prod
  • mg-fin-client
  • Подписка Соглашение об учетной записи/предприятии <Назначение> подписки на бизнес-единицу—<><###>

  • mktg-prod-001
  • corp-shared-001
  • fin-client-001
  • Группа ресурсов Подписка Назначение<> rg-app< или службы name-subscription><###>

  • rg-mktgsharepoint-prod-001
  • rg-acctlookupsvc-shared-001
  • rg-ad-dir-services-shared-001
  • Экземпляр службы управления API Глобальный apim — < имя приложения или службы>

    apim-navigator-prod
    Управляемое удостоверение Группа ресурсов id-app< или service name-environment-region<> name-<<>>###>

  • id-appcn-keda-prod-eastus2-001
  • Примеры имен: сетевые подключения

    Вид актива Область Формат и примеры
    Виртуальная сеть Группа ресурсов vnet-subscription-purpose-region<-<<>>###>

  • vnet-shared-eastus2-001
  • vnet-prod-westus-001
  • vnet-client-eastus2-001
  • Подсеть Виртуальная сеть snet-subscription-purpose-region<-<<>>###>

  • snet-shared-eastus2-001
  • snet-prod-westus-001
  • snet-client-eastus2-001
  • Сетевой интерфейс (сетевая карта) Группа ресурсов Назначение>< nic-<##>-<vm name-subscription><###>

  • nic-01-dc1-shared-001
  • nic-02-vmhadoop1-prod-001
  • nic-02-vmtest1-client-001
  • Общедоступный IP-адрес Группа ресурсов pip-<имя виртуальной машины или имя приложения>-<среда>-<регион>-<###>

  • pip-dc1-shared-eastus2-001
  • pip-hadoop-prod-westus-001
  • Подсистема балансировки нагрузки (внешняя) Группа ресурсов имя приложения lbe< или role-environment<>>-<###>

  • lbe-navigator-prod-001
  • lbe-sharepoint-dev-001
  • Группа безопасности сети (NSG) Подсеть или сетевая карта nsg-<имя политики или имя приложения>-<###>

  • nsg-weballow-001
  • nsg-rdpallow-001
  • nsg-sqlallow-001
  • nsg-dnsblocked-001
  • Шлюз локальной сети Виртуальный шлюз lgw-subscription-purpose-region<-<<>>###>

  • lgw-shared-eastus2-001
  • lgw-prod-westus-001
  • lgw-client-eastus2-001
  • Шлюз виртуальной сети Виртуальная сеть vgw-subscription-purpose-region<-<<>>###>

  • vgw-shared-eastus2-001
  • vgw-prod-westus-001
  • vgw-client-eastus2-001
  • VPN-подключение Группа ресурсов vcn-subscription1 назначение-region1-to-subscription2-region2<<>><<>>>>-

  • vcn-shared-eastus2-to-shared-westus
  • vcn-prod-eastus2-to-prod-westus
  • Таблица маршрутов Группа ресурсов Имя таблицы rt-route<>

  • rt-navigator
  • rt-sharepoint
  • метка DNS Глобальный <запись DNS A для виртуальной машины>.<регион>.cloudapp.azure.com

  • dc1.westus.cloudapp.azure.com
  • web1.eastus2.cloudapp.azure.com
  • Примеры имен: компьютер и интернет

    Вид актива Область Формат и примеры
    Виртуальная машина Группа ресурсов vm-vm< role-environment>><-<###>

  • vm-sql-test-001
  • vm-hadoop-prod-001
  • Веб-приложение Глобальный app-project<, app or service-environment>><-<##>.azurewebsites.net

  • app-navigator-prod-001.azurewebsites.net
  • app-accountlookup-dev-001.azurewebsites.net
  • Приложение-функция Глобальный func-project<, app or service-environment>><-<##>.azurewebsites.net

  • func-navigator-prod-001.azurewebsites.net
  • func-accountlookup-dev-001.azurewebsites.net
  • Примеры имен: базы данных

    Вид актива Область Формат и примеры
    База данных SQL Azure Azure SQL Server sqldb-project<, приложение или среда службы<>>

  • sqldb-users-prod
  • sqldb-users-dev
  • База данных Azure Cosmos DB Глобальный cosmos-project<, приложение или среда службы<>>

  • cosmos-navigator-prod
  • cosmos-emissions-dev
  • экземпляра кэша Azure для Redis Глобальный redis-project<, app or service-environment><>

  • redis-navigator-prod
  • redis-emissions-dev
  • Примеры имен: хранилище

    Вид актива Область Формат и примеры
    Учетная запись хранения (общего применения) Глобальный st<project, app or service><###>

  • stnavigatordata001
  • stemissionsoutput001
  • Azure StorSimple Глобальный Ssimp<project, app or service><environment>

  • ssimpnavigatorprod
  • ssimpemissionsdev
  • Реестр контейнеров Azure; Глобальный Cr<project, app or service><environment><###>

  • crnavigatorprod001
  • Примеры имен: AI и машинное обучение

    Вид актива Область Формат и примеры
    Поиск по искусственному интеллекту Azure Глобальный srch-project<, app or service-environment><>

  • srch-navigator-prod
  • srch-emissions-dev
  • Служба Azure OpenAI Группа ресурсов Oai-project<, приложение или среда службы<>>

  • oai-navigator-prod
  • oai-emissions-dev
  • Рабочая область машинного обучения Azure Группа ресурсов mlw-project<, приложение или среда службы<>>

  • mlw-navigator-prod
  • mlw-emissions-dev
  • Примеры имен: аналитика и Интернет вещей

    Вид актива Область Формат и примеры
    Azure Analysis Services; Глобальный среда<имени><приложения>

  • asnavigatorprod
  • asemissionsdev
  • Фабрика данных Azure Глобальный adf-project<, приложение или среда службы<>>

  • adf-navigator-prod
  • adf-emissions-dev
  • Рабочие области Azure Synapse Analytics Группа ресурсов synw-project<, приложение или среда службы<>>

  • synw-navigator-prod
  • synw-emissions-dev
  • Учетная запись хранения Data Lake Storage Глобальный dls<project, app or service><environment>

  • dlsnavigatorprod
  • dlsemissionsdev
  • Центр Интернета вещей Глобальный iot-project<, app or service-environment><>

  • iot-navigator-prod
  • iot-emissions-dev
  • Примеры имен: интеграция

    Вид актива Область Формат и примеры
    пространство имен служебная шина Глобальный sbns-project<, app or service-environment.servicebus.windows.net><>

  • sbns-navigator-prod.servicebus.windows.net
  • sbns-emissions-dev.servicebus.windows.net
  • очередь служебной шины Azure Cлужебная шина sbq-project<, приложение или служба>

  • sbq-navigator
  • Раздел служебной шины Cлужебная шина sbt-project<, приложение или служба>

  • sbt-navigator