Руководство по Создание и развертывание шаблона ARM

  • Статья

В этом руководстве рассматриваются шаблоны Azure Resource Manager (ARM). В нем показано, как создать изначальный шаблон и развернуть его в Azure. Здесь вы узнаете о структуре шаблона и средствах, необходимых для работы с шаблонами. Выполнения этой инструкции займет 12 минут, но фактическое время завершения зависит от того, сколько средств необходимо установить.

Этот учебник первый в серии. Работая с этой серией, вы будете пошагово изменять исходный шаблон, пока не изучите все основные компоненты шаблона ARM. Эти элементы являются стандартными блоками для более сложных шаблонов. Мы надеемся, что изучив всю серию, вы сможете уверенно создавать собственные шаблоны и будете готовы использовать шаблоны для автоматизации развертывания.

Если вы хотите узнать о преимуществах использования шаблонов и о том, почему их следует применять для автоматизации развертывания, ознакомьтесь с общими сведениями о шаблонах ARM. Чтобы узнать больше о шаблонах ARM с помощью управляемого набора модулей Microsoft Learn, см. статью Развертывание ресурсов и управление ими в Azure с помощью шаблонов JSON ARM.

Если у вас еще нет подписки Microsoft Azure, создайте бесплатную учетную запись, прежде чем начинать работу.

Совет

Если вы еще не знаете, как использовать шаблоны ARM, возможно, лучше сразу изучать Bicep. Bicep — это новый язык, который предлагает те же возможности, что и шаблоны ARM, но с более простым синтаксисом. Чтобы приступить к изучению Bicep, см. Краткое руководство. Создание BICEP-файлов с помощью Visual Studio Code.

Получение средств

Убедитесь, что у вас есть средства, необходимые для создания и развертывания шаблонов. Установите средства на локальном компьютере.

Редактор

Шаблоны — это файлы нотации объектов JavaScript (JSON). Для создания шаблонов нужен редактор JSON. Рекомендуем использовать Visual Studio Code с расширением средств Azure Resource Manager. Если необходимо установить эти средства, см. статью Краткое руководство. Создание шаблонов ARM с помощью Visual Studio Code.

Развертывание из командной строки

Для развертывания шаблона используйте Azure PowerShell или интерфейс командной строки (CLI) Azure. Если вы выберете Azure CLI, вам потребуется версия 2.37.0 или выше. Ознакомьтесь с инструкциями по установке:

После установки Azure PowerShell или Azure CLI убедитесь, что вы вошли в систему в первый раз. Дополнительные сведения см. в разделах для PowerShell или Azure CLI.

Важно!

Если вы используете Azure CLI, убедитесь, что у вас установлена версия 2.37.0 или выше. Если вы используете Azure PowerShell, убедитесь, что у вас установлена версия 7.2.4 или выше. Команды, приведенные в этом руководстве, не будут работать, если вы используете более ранние версии. Выполните команду az --version, чтобы узнать установленную версию.

Итак, все готово для начала изучения шаблонов.

Создание первого шаблона

  1. Откройте Visual Studio Code с установленным расширением инструментов обработчика ARM.

  2. В меню Файл щелкните Новый файл, чтобы создать файл.

  3. В меню Файл щелкните Сохранить как.

  4. Присвойте файлу имя azuredeploy и выберите расширение файла JSON. Полное имя файла — azuredeploy.json.

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

  6. Скопируйте следующий код JSON и вставьте его в файл.

    {
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": []
}

    Вот как должна выглядеть ваша среда Visual Studio Code:

    Снимок экрана: Visual Studio Code отображения пустого шаблона ARM со структурой JSON в редакторе.

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

    Файл JSON содержит следующие элементы:

    • $schema: расположение файла схемы JSON. В файле схемы описываются свойства, доступные в шаблоне. Например, схема определяет resources как одно из допустимых свойств шаблона. Не беспокойтесь, что для схемы указана дата 2019-04-01. Эта версия схемы обновлена и включает все новейшие функции. Дата схемы не изменилась, так как в ней отсутствуют критические изменения.
    • contentVersion: версия шаблона (например, 1.0.0.0). Для этого элемента можно предоставить любое значение. Это значение позволяет задокументировать важные изменения в шаблоне. При развертывании ресурсов с помощью шаблона это значение поможет убедиться, что используется правильный шаблон.
    • resources Содержит ресурсы, которые требуется развернуть или обновить. В настоящее время элемент пуст, но вы добавите ресурсы позже.

  7. Сохраните файл.

Поздравляем, вы создали свой первый шаблон.

Вход в Azure

Чтобы начать работу с Azure PowerShell или Azure CLI, выполните вход, используя учетные данные Azure.

Выберите вкладки в следующих разделах кода, чтобы выбрать между Azure PowerShell и Azure CLI. Примеры интерфейса командной строки в этой статье написаны для оболочки bash.

Connect-AzAccount

Если у вас несколько подписок Azure, выберите ту, которую хотите использовать. Замените SubscriptionName своим именем подписки. Вместо имени подписки также можно использовать ее идентификатор.

Set-AzContext SubscriptionName

Создать группу ресурсов

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

Примечание

Примеры с Azure CLI написаны для оболочки Bash. Чтобы запустить этот пример в Windows PowerShell или командной строке, может потребоваться удалить косые черты и записать команду одной строкой, например:

az group create --name myResourceGroup --location "Central US"

New-AzResourceGroup `
  -Name myResourceGroup `
  -Location "Central US"

Развертывание шаблона

Для развертывания шаблона используйте либо Azure CLI, либо Azure PowerShell. Используйте группу ресурсов, созданную ранее. Присвойте имя развертыванию, чтобы его можно было легко найти в журнале развертываний. Для удобства также создайте переменную, в которой хранится путь к файлу шаблона. Эта переменная упрощает выполнение команд развертывания, так как вам не нужно повторно вводить путь при каждом развертывании. Замените {provide-the-path-to-the-template-file} и фигурные скобки {} путем к файлу шаблона.

$templateFile = "{provide-the-path-to-the-template-file}"
New-AzResourceGroupDeployment `
  -Name blanktemplate `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile

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

Примечание

Если развертывание завершается сбоем, используйте параметр verbose, чтобы получить сведения о создаваемых ресурсах. Используйте параметр debug, чтобы получить дополнительные сведения для отладки.

Проверка развертывания

Чтобы проверить развертывание, просмотрите группу ресурсов на портале Azure.

  1. Войдите на портал Azure.

  2. В меню слева выберите Группы ресурсов.

  3. Установите флажок слева от myResourceGroup и выберите myResourceGroup.

  4. Выберите группу ресурсов, созданную ранее. Имя по умолчанию — myResourceGroup. В группе ресурсов пока нет ресурсов, так как вы развернули пустой шаблон.

  5. Обратите внимание, что в середине раздела с общими сведениями, в области Основные компоненты отображается состояние развертывания рядом со списком Развернутые службы. Щелкните 1 Succeeded (1: Успешно).

    Снимок экрана: портал Azure с состоянием развертывания в разделе

  6. Отобразится журнал развертываний для группы ресурсов. Установите флажок слева от blanktemplate и выберите blanktemplate.

    Снимок экрана: портал Azure с журналом развертывания с выбранным развертыванием blanktemplate.

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

    Снимок экрана: портал Azure, показывающий сводку по развертыванию blanktemplate.

Очистка ресурсов

Если вы переходите к следующему учебнику, вам не нужно удалять группу ресурсов.

Если вы прекращаете работу, то можете удалить группу ресурсов.

  1. На портале Azure в меню слева выберите Группы ресурсов.

  2. Введите имя группы ресурсов в текстовое поле Фильтрация всех полей....

  3. Установите флажок рядом с myResourceGroup и выберите myResourceGroup или имя вашей группы ресурсов.

  4. В главном меню выберите Удалить группу ресурсов.

    Снимок экрана: портал Azure с выделенным параметром

Дальнейшие действия

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

Добавление ресурса