共用方式為

ARM 範本中的屬性反覆運用

  • 發行項

本文示範如何在 Azure Resource Manager 範本 (ARM 範本) 建立屬性的多個執行個體。 藉由將複製迴圈新增至範本中資源的屬性區段，您可以在部署期間動態設定屬性的項目數。 您也可以避免重複範本語法。

即使將複製迴圈套用至屬性，您還是只能搭配最上層資源使用複製迴圈。 若要瞭解如何將子資源變更為最上層資源，請參閱子資源的反覆運用。

您也可以搭配資源、變數和輸出使用複製迴圈。

提示

我們建議使用 Bicep，因為其提供的功能與 ARM 範本相同，而且語法更易於使用。 若要深入了解，請參閱迴圈。

語法

將 copy 元素新增至範本的資源區段，以設定屬性的項目數。 複製元素的一般格式如下：

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

針對 name，提供您想要建立資源屬性的名稱。

count 屬性可指定您希望屬性反覆運用的次數。

input 屬性可指定您想要重複的屬性。 您可以建立一個由 input 屬性中的值建構的元素陣列。

複製限制

次數不能超過 800。

次數不可為負數。 如果您使用最新版的 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 不支援次數為零。

屬性反覆運算

下列範例示範如何將複製迴圈套用至虛擬機器的 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 時，您必須提供反覆運用的名稱。 屬性反覆運用也支援位移引數。 位移必須在反覆運用的名稱之後，例如 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 利用虛擬機器部署數個資料磁碟。

下一步