使用 Resource Manager 模板和 Azure CLI 部署资源

本文介绍了如何将 Azure CLI 与资源管理器模板配合使用将资源部署到 Azure。 如果不熟悉部署和管理 Azure 解决方案的概念,请参阅 Azure 资源管理器概述

所部署的 Resource Manager 模板可以是计算机上的本地文件,也可以是位于 GitHub 等存储库中的外部文件。 本文中部署的模板可在示例模板部分中找到,也可在 GitHub 中的存储帐户模板中找到。

若要运行此示例,请确保已安装最新的 Azure CLI 2.0。 若要开始,请运行 az login 以创建与 Azure 的连接。

Note

在运行 az login 之前,请先运行 az cloud set -n AzureChinaCloud 以更改云环境。 如果要切换回全球 Azure,请再次运行 az cloud set -n AzureCloud

此示例在 Bash shell 中正常工作。 有关在 Windows 客户端上运行 Azure CLI 脚本的选项,请参阅在 Windows 上安装 Azure CLI

部署本地模板

将资源部署到 Azure 时,执行以下操作:

  1. 登录到 Azure 帐户
  2. 创建用作已部署资源的容器的资源组。 资源组名称只能包含字母数字字符、句点、下划线、连字符和括号。 它最多可以包含 90 个字符。 它不能以句点结尾。
  3. 将定义了要创建的资源的模板部署到资源组

模板可以包括可用于自定义部署的参数。 例如,可以提供为特定环境(如开发环境、测试环境和生产环境)定制的值。 示例模板定义了存储帐户 SKU 的参数。

Note

在 Azure 中国区使用 Azure CLI 2.0 之前,请先运行 az cloud set -n AzureChinaCloud 来改变云环境。如果想切回国际版 Azure,请再次运行 az cloud set -n AzureCloud

以下示例将创建一个资源组,并从本地计算机部署模板:

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

部署可能需要几分钟才能完成。 完成之后,会看到一条包含以下结果的消息:

"provisioningState": "Succeeded",

部署外部模板

你可能更愿意将 Resource Manager 模板存储在外部位置,而不是存储在本地计算机上。 可以将模板存储在源控件存储库(例如 GitHub)中。 另外,还可以将其存储在 Azure 存储帐户中,以便在组织中共享访问。

若要部署外部模板,请使用 template-uri 参数。 使用示例中的 URI 从 GitHub 部署示例模板。

az group create --name ExampleGroup --location "China North"
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 可公开访问,它适用于大多数情况,因为模板应该不会包含敏感数据。 如果需要指定敏感数据(如管理员密码),请以安全参数的形式传递该值。 但是,如果不希望模板可公开访问,可以通过将其存储在专用存储容器中来保护它。 若要了解如何部署需要共享访问签名 (SAS) 令牌的模板,请参阅部署具有 SAS 令牌的专用模板

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

部署到多个资源组或订阅

通常情况下,将模板中的所有资源部署到单个资源组。 不过,在某些情况下,你可能希望将一组资源部署在一起但将其放置在不同的资源组或订阅中。 在单个部署中可以仅部署到五个资源组。 有关详细信息,将 Azure 资源部署到多个订阅或资源组

部署失败时,重新部署

对于失败的部署,可以指定从部署历史记录自动重新部署以前的部署。 若要使用此选项,部署必须具有唯一的名称,以便可以在历史记录中标识它们。 如果没有唯一名称,则当前失败的部署可能会覆盖历史记录中以前成功的部署。 只能将此选项用于根级别部署。 从嵌套模板进行的部署不可用于重新部署。

若要重新部署最后一个成功的部署,请将 --rollback-on-error 参数添加为标志。

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

若要重新部署某个特定部署,请使用 --rollback-on-error 参数并提供部署名称。

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

指定的部署必须已成功。

参数文件

你可能会发现,与在脚本中以内联值的形式传递参数相比,使用包含参数值的 JSON 文件更为容易。 参数文件必须采用以下格式:

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

请注意,parameters 部分包含与模板中定义的参数匹配的参数名称 (storageAccountType)。 参数文件包含该参数的值。 此值在部署期间自动传递给模板。 可以针对不同部署方案创建多个参数文件,然后传入相应的参数文件。

复制上面的示例,并将其保存为名为 storage.parameters.json 的文件。

若要传递本地参数文件,请使用 @ 指定名为 storage.parameters.json 的本地文件。

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

测试模板部署

若要测试模板和参数值而不实际部署任何资源,请使用 az group deployment validate

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

如果未检测到错误,则该命令将返回有关测试部署的信息。 需要特别注意的是,error 值为 null。

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

如果检测到错误,则该命令将返回一条错误消息。 例如,如果尝试为存储帐户 SKU 传递不正确的值,将返回以下错误:

{
  "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
}

如果模板有语法错误,该命令将返回一个错误,指示它无法分析该模板。 该消息会指出分析错误的行号和位置。

{
  "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
}

增量部署和完整部署

部署资源时,可以指定部署为增量更新还是完整更新。 这两种模式的主要区别是 Resource Manager 如何处理资源组中不在模板中的现有资源:

  • 在完整模式中,Resource Manager 删除资源组中已存在但尚未在模板中指定的资源。
  • 在增量模式中,Resource Manager 保留资源组中已存在但尚未在模板中指定的资源。

对于这两种模式,Resource Manager 都会尝试预配在模板中指定的所有资源。 如果资源已存在于资源组中且其设置未更改,该操作不会导致任何更改。 如果更改某个资源的设置,则会使用这些新设置预配资源。 如果尝试更新现有资源的位置或类型,则部署会失败并出现错误。 请改用所需的位置或类型部署新资源。

Resource Manager 默认使用增量模式。

为了说明增量模式和完整模式的差异,请考虑以下方案。

现有资源组包含:

  • 资源 A
  • 资源 B
  • 资源 C

模板定义:

  • 资源 A
  • 资源 B
  • 资源 D

在“增量”模式下部署时,资源组包含:

  • 资源 A
  • 资源 B
  • 资源 C
  • 资源 D

在“完整”模式下部署时,会删除资源 C。 该资源组包含:

  • 资源 A
  • 资源 B
  • 资源 D

若要使用完整模式,请使用 mode 参数:

az group deployment create \
    --name ExampleDeployment \
    --mode Complete \
    --resource-group ExampleGroup \
    --template-file storage.json \
    --parameters storageAccountType=Standard_GRS

示例模板

本文中的示例使用以下模板。 复制并将其另存为名为 storage.json 的文件。 若要了解如何创建此模板,请参阅创建第一个 Azure Resource Manager 模板

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageAccountType": {
      "type": "string",
      "defaultValue": "Standard_LRS",
      "allowedValues": [
        "Standard_LRS",
        "Standard_GRS",
        "Standard_ZRS",
        "Premium_LRS"
      ],
      "metadata": {
        "description": "Storage Account type"
      }
    }
  },
  "variables": {
    "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "name": "[variables('storageAccountName')]",
      "apiVersion": "2016-01-01",
      "location": "[resourceGroup().location]",
      "sku": {
          "name": "[parameters('storageAccountType')]"
      },
      "kind": "Storage", 
      "properties": {
      }
    }
  ],
  "outputs": {
      "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
      }
  }
}

后续步骤