Развертывание ресурсов с использованием шаблонов Resource Manager и Azure CLIDeploy resources with Resource Manager templates and Azure CLI

В этой статье объясняется, как использовать Azure CLI и шаблоны Resource Manager для развертывания ресурсов в Azure.This article explains how to use Azure CLI with Resource Manager templates to deploy your resources to Azure. Если вы не знакомы с основными понятиями, связанными с развертыванием решений Azure и управлением ими, см. обзор Azure Resource Manager.If you aren't familiar with the concepts of deploying and managing your Azure solutions, see Azure Resource Manager overview.

Чтобы выполнить этот пример, установите последнюю версию Azure CLI.To run this sample, install the latest version of the Azure CLI. Перед началом выполните команду az login, чтобы создать подключение к Azure.To start, run az login to create a connection with Azure.

Примеры для Azure CLI написаны для оболочки bash.Samples for the Azure CLI are written for the bash shell. Чтобы запустить этот пример в Windows PowerShell или командной строке, может потребоваться изменить элементы скрипта.To run this sample in Windows PowerShell or Command Prompt, you may need to change elements of the script.

Если у вас не установлен интерфейс командной строки Azure, можете использовать Cloud Shell.If you don't have Azure CLI installed, you can use the Cloud Shell.

Область развертыванияDeployment scope

Вы можете ориентироваться на развертывание либо в подписке Azure, либо в группу ресурсов в рамках подписки.You can target your deployment to either an Azure subscription or a resource group within a subscription. В большинстве случаев вы планируете развертывание в группе ресурсов.In most cases, you'll target deployment to a resource group. Используйте развертывания подписок для применения политик и назначений ролей в рамках подписки.Use subscription deployments to apply policies and role assignments across the subscription. Вы также можете использовать развертывания подписок для создания группы ресурсов и развертывания в ней ресурсов.You also use subscription deployments to create a resource group and deploy resources to it. В зависимости от области развертывания используются разные команды.Depending on the scope of the deployment, you use different commands.

Для развертывания в группе ресурсовиспользуйте команду AZ Group Deployment Create:To deploy to a resource group, use az group deployment create:

az group deployment create --resource-group <resource-group-name> --template-file <path-to-template>

Для развертывания в подпискеиспользуйте команду AZ Deployment Create:To deploy to a subscription, use az deployment create:

az deployment create --location <location> --template-file <path-to-template>

В настоящее время развертывания группы управления поддерживаются только в REST API.Currently, management group deployments are only supported through the REST API. См. статью развертывание ресурсов с помощью шаблонов диспетчер ресурсов и диспетчер ресурсов REST API.See Deploy resources with Resource Manager templates and Resource Manager REST API.

В примерах этой статьи используются развертывания групп ресурсов.The examples in this article use resource group deployments. Дополнительные сведения о развертывании подписок см. в статье Создание групп ресурсов и ресурсов на уровне подписки.For more information about subscription deployments, see Create resource groups and resources at the subscription level.

Развертывание локального шаблонаDeploy local template

При развертывании ресурсов в Azure выполните следующие действия:When deploying resources to Azure, you:

  1. Вход в учетную запись AzureSign in to your Azure account
  2. Создайте группу ресурсов, которая послужит в качестве контейнера для развертываемых ресурсов.Create a resource group that serves as the container for the deployed resources. Имя группы ресурсов может содержать только буквы, цифры, точки, знаки подчеркивания, дефисы и скобки.The name of the resource group can only include alphanumeric characters, periods, underscores, hyphens, and parenthesis. Оно может содержать до 90 знаков иIt can be up to 90 characters. не должно заканчиваться точкой.It can't end in a period.
  3. Разверните в группе ресурсов шаблон, определяющий ресурсы, которые необходимо создать.Deploy to the resource group the template that defines the resources to create

Шаблон может включать параметры, которые позволяют настроить развертывание.A template can include parameters that enable you to customize the deployment. Например, вы можете предоставить значения, предназначенные для конкретной среды (такой как среда разработки, тестирования и рабочая среда).For example, you can provide values that are tailored for a particular environment (such as dev, test, and production). Пример шаблона определяет параметр для номера SKU учетной записи хранения.The sample template defines a parameter for the storage account SKU.

В следующем примере создается группа ресурсов и развертывается шаблон с локального компьютера:The following example creates a resource group, and deploys a template from your local machine:

az group create --name ExampleGroup --location "Central US"
az group deployment create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.json \
  --parameters storageAccountType=Standard_GRS

Развертывание может занять несколько минут.The deployment can take a few minutes to complete. По завершении появится сообщение, содержащее результат:When it finishes, you see a message that includes the result:

"provisioningState": "Succeeded",

Развертывание удаленного шаблонаDeploy remote template

Шаблоны Resource Manager можно хранить не на локальном компьютере, а на внешнем источнике.Instead of storing Resource Manager templates on your local machine, you may prefer to store them in an external location. Вы можете хранить шаблоны в репозитории системы управления версиями (например, GitHub).You can store templates in a source control repository (such as GitHub). А также их можно хранить в учетной записи хранения Azure для общего доступа в организации.Or, you can store them in an Azure storage account for shared access in your organization.

Для развертывания внешнего шаблона используйте параметр template-uri.To deploy an external template, use the template-uri parameter. Используйте универсальный код ресурса (URI) в примере для развертывания примера шаблона из GitHub.Use the URI in the example to deploy the sample template from GitHub.

az group create --name ExampleGroup --location "Central US"
az group deployment create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-uri "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-storage-account-create/azuredeploy.json" \
  --parameters storageAccountType=Standard_GRS

В предыдущем примере для шаблона требуется общедоступный код URI, который подходит для большинства сценариев, так как шаблон не должен содержать конфиденциальные данные.The preceding example requires a publicly accessible URI for the template, which works for most scenarios because your template shouldn't include sensitive data. Если необходимо указать конфиденциальные данные (например, пароль администратора), то передайте это значение с помощью безопасного параметра.If you need to specify sensitive data (like an admin password), pass that value as a secure parameter. Но если вы не хотите, чтобы шаблон был общедоступным, можно защитить его, сохранив в закрытом контейнере хранилища.However, if you don't want your template to be publicly accessible, you can protect it by storing it in a private storage container. Сведения о развертывании шаблона, требующего маркер подписанного URL-адреса (SAS), см. в статье Развертывание частного шаблона Resource Manager с использованием токена SAS и Azure PowerShell.For information about deploying a template that requires a shared access signature (SAS) token, see Deploy private template with SAS token.

Развертывание шаблона из Cloud ShellDeploy template from Cloud Shell

Для развертывания шаблона можно использовать Cloud Shell.You can use Cloud Shell to deploy your template. Чтобы развернуть внешний шаблон, укажите URI шаблона точно так же, как и для любого внешнего развертывания.To deploy an external template, provide the URI of the template exactly as you would for any external deployment. Чтобы развернуть локальный шаблон, сначала необходимо загрузить шаблон для Cloud Shell в учетную запись хранения.To deploy a local template, you must first load your template into the storage account for your Cloud Shell. В этом разделе описывается, как загрузить шаблон в свою учетную запись облачной оболочки и развернуть его как локальный файл.This section describes how to load the template to your cloud shell account, and deploy it as a local file. Если вы еще не использовали Cloud Shell, ознакомьтесь со статьей Обзор Azure Cloud Shell, чтобы узнать о настройке службы.If you haven't used Cloud Shell, see Overview of Azure Cloud Shell for information about setting it up.

  1. Войдите на портале Azure.Sign in to the Azure portal.

  2. Выберите свою группу ресурсов Cloud Shell.Select your Cloud Shell resource group. Шаблон имени — cloud-shell-storage-<region>.The name pattern is cloud-shell-storage-<region>.

    Выбор группы ресурсов

  3. Выберите учетную запись хранения для Cloud Shell.Select the storage account for your Cloud Shell.

    Выбор учетной записи хранения

  4. Выберите Большие двоичные объекты.Select Blobs.

    Выберите "Большие двоичные объекты"

  5. Выберите + Container (+ Контейнер).Select + Container.

    Добавление контейнера

  6. Задайте контейнеру название и уровень доступа.Give your container a name and an access level. Образец шаблона в данной статье не содержит конфиденциальных сведений и поэтому разрешает анонимный доступ для чтения.The sample template in this article contains no sensitive information, so allow anonymous read access. Нажмите кнопку ОК.Select OK.

    Указание значений для контейнера

  7. Выберите созданный контейнер.Select the container you created.

    Выберите новый контейнер

  8. Щелкните Отправить.Select Upload.

    Отправка большого двоичного объекта

  9. Найдите и отправьте свой шаблон.Find and upload your template.

    Отправка файла

  10. После отправки выберите шаблон.After it has uploaded, select the template.

    Выберите новый шаблон

  11. Скопируйте URL-адрес.Copy the URL.

    Копирование URL-адреса

  12. Откройте командную строку.Open the prompt.

    Открытие Cloud Shell

В Cloud Shell введите следующие команды:In the Cloud Shell, use the following commands:

az group create --name examplegroup --location "South Central US"
az group deployment create --resource-group examplegroup \
  --template-uri <copied URL> \
  --parameters storageAccountType=Standard_GRS

Повторное развертывание при сбое развертыванияRedeploy when deployment fails

Эта функция также называется откатом при ошибке.This feature is also known as Rollback on error. Если развертывание завершается ошибкой, вы можете автоматически повторно развернуть ресурс, успешно развернутый ранее, из журнала развертывания.When a deployment fails, you can automatically redeploy an earlier, successful deployment from your deployment history. Чтобы запустить повторное развертывание, используйте параметр --rollback-on-error в команде развертывания.To specify redeployment, use the --rollback-on-error parameter in the deployment command. Эта функция полезна, если вы получили известное хорошее состояние развертывания инфраструктуры и хотите вернуться к этому состоянию.This functionality is useful if you've got a known good state for your infrastructure deployment and want to revert to this state. Существует ряд предостережений и ограничений.There are a number of caveats and restrictions:

  • Повторное развертывание выполняется точно так же, как было запущено ранее с теми же параметрами.The redeployment is run exactly as it was run previously with the same parameters. Изменить параметры невозможно.You can't change the parameters.
  • Предыдущее развертывание выполняется с использованием полного режима.The previous deployment is run using the complete mode. Все ресурсы, не входящие в предыдущее развертывание, удаляются, а для всех конфигураций ресурсов устанавливается предыдущее состояние.Any resources not included in the previous deployment are deleted, and any resource configurations are set to their previous state. Убедитесь, что вы полностью понимаете режимы развертывания.Make sure you fully understand the deployment modes.
  • Повторное развертывание влияет только на ресурсы, любые изменения данных не затрагиваются.The redeployment only affects the resources, any data changes aren't affected.
  • Эта функция поддерживается только для развертываний групп ресурсов, а не для развертываний на уровне подписки.This feature is only supported on Resource Group deployments, not subscription level deployments. Дополнительные сведения о развертывании уровня подписки см. в статье Создание групп ресурсов и ресурсов на уровне подписки.For more information about subscription level deployment, see Create resource groups and resources at the subscription level.

Для этого развертывания должны иметь уникальные имена, чтобы их можно было идентифицировать в журнале.To use this option, your deployments must have unique names so they can be identified in the history. Если у вас нет уникальных имен, текущее неудачное развертывание может перезаписать более раннее успешное развертывание, зафиксированное в журнале.If you don't have unique names, the current failed deployment might overwrite the previously successful deployment in the history. Этот параметр можно использовать только с развертываниями корневого уровня.You can only use this option with root level deployments. Повторное развертывание из вложенных шаблонов не поддерживается.Deployments from a nested template aren't available for redeployment.

Чтобы выполнить повторно последнее успешное развертывание, добавьте параметр --rollback-on-error в качестве флага.To redeploy the last successful deployment, add the --rollback-on-error parameter as a flag.

az group deployment create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.json \
  --parameters storageAccountType=Standard_GRS \
  --rollback-on-error

Чтобы выполнить повторно конкретное развертывание, используйте параметр --rollback-on-error и укажите имя развертывания.To redeploy a specific deployment, use the --rollback-on-error parameter and provide the name of the deployment.

az group deployment create \
  --name ExampleDeployment02 \
  --resource-group ExampleGroup \
  --template-file storage.json \
  --parameters storageAccountType=Standard_GRS \
  --rollback-on-error ExampleDeployment01

Указанное развертывание должно быть успешным.The specified deployment must have succeeded.

ПараметрыParameters

Чтобы передать значения параметров, можно использовать встроенные параметры или файл параметров.To pass parameter values, you can use either inline parameters or a parameter file. В предыдущих примерах в этой статье используются встроенные параметры.The preceding examples in this article show inline parameters.

Встроенные параметрыInline parameters

Чтобы передать встроенные параметры, укажите значения в parameters.To pass inline parameters, provide the values in parameters. Например, строки и массив передаются в шаблон из оболочки Bash следующим образом:For example, to pass a string and array to a template is a Bash shell, use:

az group deployment create \
  --resource-group testgroup \
  --template-file demotemplate.json \
  --parameters exampleString='inline string' exampleArray='("value1", "value2")'

При использовании Azure CLI в командной строке Windows (CMD) или PowerShell передайте массив в формате: exampleArray="['value1','value2']".If you are using Azure CLI with Windows Command Prompt (CMD) or PowerShell, pass the array in the format: exampleArray="['value1','value2']".

Можно также получить содержимое файла и предоставлять его в виде встроенного параметра.You can also get the contents of file and provide that content as an inline parameter.

az group deployment create \
  --resource-group testgroup \
  --template-file demotemplate.json \
  --parameters exampleString=@stringContent.txt exampleArray=@arrayContent.json

Получение значения параметра из файла полезно в тех случаях, когда есть необходимость предоставить значения конфигурации.Getting a parameter value from a file is helpful when you need to provide configuration values. Например, вы можете предоставить значения cloud-init для виртуальной машины Linux.For example, you can provide cloud-init values for a Linux virtual machine.

Файл ArrayContent.json имеет следующий формат:The arrayContent.json format is:

[
    "value1",
    "value2"
]

Файлы параметровParameter files

Вместо передачи параметров в виде встроенных значений в сценарии вам может быть проще использовать JSON-файл, содержащий значения параметров.Rather than passing parameters as inline values in your script, you may find it easier to use a JSON file that contains the parameter values. Файл параметров должен находиться в локальной среде.The parameter file must be a local file. Внешние файлы параметров не поддерживаются в Azure CLI.External parameter files aren't supported with Azure CLI.

Файл параметров должен быть в указанном ниже формате.The parameter file must be in the following format:

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
     "storageAccountType": {
         "value": "Standard_GRS"
     }
  }
}

Обратите внимание, что раздел parameters содержит имя параметра, которое совпадает с параметром, определенным в шаблоне (storageAccountType).Notice that the parameters section includes a parameter name that matches the parameter defined in your template (storageAccountType). Файл параметров содержит значение для параметра.The parameter file contains a value for the parameter. Во время развертывания это значение автоматически передается в шаблон.This value is automatically passed to the template during deployment. Вы можете создать несколько файлов параметров и передавать нужный файл параметров в зависимости от конкретной ситуации.You can create more than one parameter file, and then pass in the appropriate parameter file for the scenario.

Скопируйте предыдущий пример и сохраните его как файл с именем storage.parameters.json.Copy the preceding example and save it as a file named storage.parameters.json.

Для передачи локального файла параметров используйте @, чтобы указать локальный файл с именем storage.parameters.json.To pass a local parameter file, use @ to specify a local file named storage.parameters.json.

az group deployment create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.json \
  --parameters @storage.parameters.json

Приоритет параметровParameter precedence

Вы можете использовать в ходе одной операции развертывания как встроенные параметры, так и локальный файл параметров.You can use inline parameters and a local parameter file in the same deployment operation. Например, часть значений можно указать в локальном файле параметров, а другую часть — в команде развертывания.For example, you can specify some values in the local parameter file and add other values inline during deployment. Если значения для одного параметра указаны одновременно и в локальном файле параметров, и в командной строке, более высокий приоритет имеет значение из командной строки.If you provide values for a parameter in both the local parameter file and inline, the inline value takes precedence.

az group deployment create \
  --resource-group testgroup \
  --template-file demotemplate.json \
  --parameters @demotemplate.parameters.json \
  --parameters exampleArray=@arrtest.json

Тестовое развертывание шаблонаTest a template deployment

Чтобы проверить шаблон и значения параметров без фактического развертывания ресурсов, используйте az group deployment validate.To test your template and parameter values without actually deploying any resources, use az group deployment validate.

az group deployment validate \
  --resource-group ExampleGroup \
  --template-file storage.json \
  --parameters @storage.parameters.json

Если ошибок не обнаружено, то команда возвращает сведения о тестовом развертывании.If no errors are detected, the command returns information about the test deployment. В частности, обратите внимание, что error имеет значение null.In particular, notice that the error value is null.

{
  "error": null,
  "properties": {
      ...

Если обнаруживается ошибка, то команда возвращает сообщение об ошибке.If an error is detected, the command returns an error message. Например, попытка передать недопустимое значение для номера SKU учетной записи возвращает следующую ошибку:For example, passing an incorrect value for the storage account SKU, returns the following error:

{
  "error": {
    "code": "InvalidTemplate",
    "details": null,
    "message": "Deployment template validation failed: 'The provided value 'badSKU' for the template parameter 
      'storageAccountType' at line '13' and column '20' is not valid. The parameter value is not part of the allowed 
      value(s): 'Standard_LRS,Standard_ZRS,Standard_GRS,Standard_RAGRS,Premium_LRS'.'.",
    "target": null
  },
  "properties": null
}

Если шаблон содержит синтаксическую ошибку, команда возвращает сообщение об ошибке, указывающее, что ей не удалось проанализировать шаблон.If your template has a syntax error, the command returns an error indicating it couldn't parse the template. В сообщении указывается номер строки и позиция ошибки синтаксического анализа.The message indicates the line number and position of the parsing error.

{
  "error": {
    "code": "InvalidTemplate",
    "details": null,
    "message": "Deployment template parse failed: 'After parsing a value an unexpected character was encountered:
      \". Path 'variables', line 31, position 3.'.",
    "target": null
  },
  "properties": null
}

Следующие шагиNext steps