ARM 模板中的属性迭代

Artículo
06/06/2023

本文介绍如何在 Azure 资源管理器模板（ARM 模板）中创建一个属性的多个实例。通过将复制循环添加到模板中资源的 properties 节，可以在部署过程中动态设置属性的项数。还可以避免重复模板语法。

你只能对顶级资源使用复制循环，即使在将复制循环应用到属性时也是如此。若要了解如何将子资源更改为顶级资源，请参阅子资源的迭代。

还可以将复制循环用于 resources、variables 和 outputs。

提示

我们建议使用 Bicep，因为它提供与 ARM 模板相同的功能，并且该语法更易于使用。若要了解详情，请参阅循环。

语法

将 copy 元素添加到模板的 resources 节以设置某个属性的项数。 copy 元素采用以下常规格式：

"copy": [
  {
    "name": "<name-of-property>",
    "count": <number-of-iterations>,
    "input": <values-for-the-property>
  }
]

对于 name，提供要创建的资源属性的名称。

count 属性指定要对该属性进行的迭代次数。

input 属性指定要重复的属性。可以创建一个由 input 属性中的值构造的元素数组。

复制限制

count 不能超过 800。

count 不能为负数。如果使用最新版本的 Azure CLI、PowerShell 或 REST API 部署模板，则它可以为零。具体而言，必须使用：

Azure PowerShell 2.6 或更高版本
Azure CLI 2.0.74 或更高版本
REST API 版本 2019-05-10 或更高版本
链接的部署必须将 API 版本 2019-05-10 或更高版本用于部署资源类型

更早版本的 PowerShell、CLI 和 REST API 不支持将 count 设为零。

属性迭代

以下示例演示如何将复制循环应用于虚拟机上的 dataDisks 属性：

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "numberOfDataDisks": {
      "type": "int",
      "minValue": 0,
      "maxValue": 16,
      "defaultValue": 3,
      "metadata": {
        "description": "The number of dataDisks to create."
      }
    },
    ...
  },
  "resources": [
    {
      "type": "Microsoft.Compute/virtualMachines",
      "apiVersion": "2022-11-01",
      ...
      "properties": {
        "storageProfile": {
          ...
          "copy": [
            {
              "name": "dataDisks",
              "count": "[parameters('numberOfDataDisks')]",
              "input": {
                "lun": "[copyIndex('dataDisks')]",
                "createOption": "Empty",
                "diskSizeGB": 1023
              }
            }
          ]
        }
        ...
      }
    }
  ]
}

请注意，在属性迭代中使用 copyIndex 时，必须提供迭代的名称。属性迭代还支持 offset 参数。偏移量必须在迭代名称之后，例如 copyIndex('dataDisks', 1)。

已部署的模板将成为：

{
  "name": "examplevm",
  "type": "Microsoft.Compute/virtualMachines",
  "apiVersion": "2020-06-01",
  "properties": {
    "storageProfile": {
      "dataDisks": [
        {
          "lun": 0,
          "createOption": "Empty",
          "diskSizeGB": 1023
        },
        {
          "lun": 1,
          "createOption": "Empty",
          "diskSizeGB": 1023
        },
        {
          "lun": 2,
          "createOption": "Empty",
          "diskSizeGB": 1023
        }
      ],
      ...

处理数组时可以使用复制操作，因为可对数组中的每个元素执行迭代操作。可以对数组使用 length 函数来指定迭代计数，并使用 copyIndex 来检索数组中的当前索引。

以下示例模板为作为数组传入的数据库创建故障转移组。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "primaryServerName": {
      "type": "string"
    },
    "secondaryServerName": {
      "type": "string"
    },
    "databaseNames": {
      "type": "array",
      "defaultValue": [
        "mydb1",
        "mydb2",
        "mydb3"
      ]
    }
  },
  "variables": {
    "failoverName": "[format('{0}/{1}failovergroups', parameters('primaryServerName'), parameters('primaryServerName'))]"
  },
  "resources": [
    {
      "type": "Microsoft.Sql/servers/failoverGroups",
      "apiVersion": "2015-05-01-preview",
      "name": "[variables('failoverName')]",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 60
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled"
        },
        "partnerServers": [
          {
            "id": "[resourceId('Microsoft.Sql/servers', parameters('secondaryServerName'))]"
          }
        ],
        "copy": [
          {
            "name": "databases",
            "count": "[length(parameters('databaseNames'))]",
            "input": "[resourceId('Microsoft.Sql/servers/databases', parameters('primaryServerName'), parameters('databaseNames')[copyIndex('databases')])]"
          }
        ]
      }
    }
  ],
  "outputs": {
  }
}

copy 元素是一个数组，因此，你可以为资源指定多个属性。

{
  "type": "Microsoft.Network/loadBalancers",
  "apiVersion": "2017-10-01",
  "name": "exampleLB",
  "properties": {
    "copy": [
      {
        "name": "loadBalancingRules",
        "count": "[length(parameters('loadBalancingRules'))]",
        "input": {
          ...
        }
      },
      {
        "name": "probes",
        "count": "[length(parameters('loadBalancingRules'))]",
        "input": {
          ...
        }
      }
    ]
  }
}

可将资源和属性迭代一起使用。按名称引用属性迭代。

{
  "type": "Microsoft.Network/virtualNetworks",
  "apiVersion": "2018-04-01",
  "name": "[format('{0}{1}', parameters('vnetname'), copyIndex())]",
  "copy":{
    "count": 2,
    "name": "vnetloop"
  },
  "location": "[resourceGroup().location]",
  "properties": {
    "addressSpace": {
      "addressPrefixes": [
        "[parameters('addressPrefix')]"
      ]
    },
    "copy": [
      {
        "name": "subnets",
        "count": 2,
        "input": {
          "name": "[format('subnet-{0}', copyIndex('subnets'))]",
          "properties": {
            "addressPrefix": "[variables('subnetAddressPrefix')[copyIndex('subnets')]]"
          }
        }
      }
    ]
  }
}

示例模板

以下示例显示了为一个属性创建多个值的常见方案。

模板	说明
数据磁盘数可变的 VM 部署	通过虚拟机部署多个数据磁盘。

后续步骤

若要完成教程，请参阅教程：使用 ARM 模板创建多个资源实例。
有关 copy 循环的其他用法，请参阅：
若要了解模板的各个部分，请参阅了解 ARM 模板的结构和语法。
若要了解如何部署模板，请参阅使用 ARM 模板和 Azure PowerShell 来部署资源。

Compartir a través de

ARM 模板中的属性迭代

语法

复制限制

属性迭代

示例模板

后续步骤

Recursos adicionales