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

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

Предварительные требования

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

Вам потребуется установить Visual Studio Code с расширением инструментов Resource Manager, а также либо Azure PowerShell, либо интерфейс командной строки Azure (Azure CLI). Дополнительные сведения см. в разделе об инструментах шаблона.

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

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

Замените {provide-unique-name} и фигурные скобки {} уникальным именем учетной записи хранения.

Важно!

Имя учетной записи хранения должно быть уникальным в среде Azure. Длина имени не должна превышать 24 символа, можно использовать только строчные буквы или цифры. В качестве префикса можно использовать такое имя, как store1, а затем добавить свои инициалы и текущую дату. Например, имя может быть следующим: store1abc06132022.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-09-01",
      "name": "{provide-unique-name}",
      "location": "eastus",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {
        "supportsHttpsTrafficOnly": true
      }
    }
  ]
}

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

Свойства ресурса

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

Каждый развернутый ресурс имеет как минимум следующие три свойства:

  • type. Тип ресурса. Это значение представляет собой сочетание пространства имен поставщика ресурсов и типа ресурса (например, Microsoft.Storage/storageAccounts).
  • apiVersion. Версия REST API, которая будет использована для создания ресурса. Каждый поставщик ресурсов опубликовал собственные версии API, поэтому это значение зависит от типа.
  • name. Имя ресурса.

Большинство ресурсов также имеют свойство location, которое задает регион, где развертывается ресурс.

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

В рамках этого учебника вы добавляете в шаблон учетную запись хранения. Версию API учетной записи хранения можно просмотреть на странице storageAccounts 2021-09-01. Обратите внимание, что вы добавляете не все свойства в свой шаблон. Многие из свойств являются необязательными. Поставщик ресурсов Microsoft.Storage может выпустить новую версию API, но развертываемая версия не должна изменяться. Вы можете продолжать использовать эту версию и знать, что результаты развертывания будут согласованы.

Если вы просматриваете более раннюю версию API , вы можете увидеть, что доступен меньший набор свойств.

Если вы решите изменить версию API для ресурса, убедитесь, что вы оценили свойства этой версии и соответствующим образом изменили свой шаблон.

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

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

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

New-AzResourceGroupDeployment `
  -Name addstorage `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile

Примечание

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

Далее показаны два возможных сбоя развертывания, с которыми вы можете столкнуться:

  • Error: Code=AccountNameInvalid; Message={provide-unique-name} не является допустимым именем учетной записи хранения. Имя учетной записи хранения должно содержать от 3 до 24 знаков и состоять только из цифр и строчных букв.

    В шаблоне замените {provide-unique-name} уникальным именем учетной записи хранения. Ознакомьтесь с разделом Добавление ресурса.

  • Имя "Error: Code=StorageAccountAlreadyTaken; Message=The storage account named store1abc09092019" уже занято.

    Попробуйте использовать другое имя учетной записи хранения в шаблоне.

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

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

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

  1. Войдите на портал Azure.
  2. В меню слева выберите Группы ресурсов.
  3. Установите флажок слева от myResourceGroup и выберите myResourceGroup
  4. Выберите группу ресурсов, в которую выполнено развертывание.
  5. Вы увидите, что учетная запись хранения развернута.
  6. Обратите внимание: на метке развертывания теперь указано: Развертывания: 2 выполнены успешно.

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

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

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

  1. На портале Azure в меню слева выберите Группа ресурсов.
  2. Введите имя группы ресурсов в поле Фильтр для любого поля....
  3. Установите флажок рядом с myResourceGroup и выберите myResourceGroup или имя выбранной группы ресурсов.
  4. В главном меню выберите Удалить группу ресурсов.

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

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