ARM テンプレートでの変数の反復処理

[アーティクル]
03/20/2024

この記事では、Azure Resource Manager テンプレート (ARM テンプレート) で 1 つの変数に対して複数の値を作成する方法について説明します。テンプレートの変数セクションに copy 要素を追加することにより、デプロイ時に変数の項目数を動的に設定できます。テンプレートの構文を繰り返す必要もありません。

リソース、リソース内のプロパティ、および出力でもコピーを使用できます。

ヒント

ARM テンプレートと同じ機能を備え、構文も使いやすいため、Bicep をお勧めします。詳細については、「ループ」を参照してください。

構文

この copy 要素には、次の一般的な形式があります。

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

name プロパティは、ループを識別する任意の値です。 count プロパティは、変数に必要な反復回数を指定します。

input プロパティは、繰り返すプロパティを指定します。 input プロパティの値から構築された要素の配列を作成します。それは、1 つのプロパティ (文字列など) にすることも、複数のプロパティを持つオブジェクトにすることもできます。

コピー制限

count は 800 を超えることはできません。

count は負の数値にすることはできません。 Azure CLI、PowerShell、または REST API の最新バージョンを使用してテンプレートをデプロイする場合、ゼロを指定できます。具体的には、次のものを使用する必要があります。

Azure PowerShell 2.6 以降
Azure CLI 2.0.74 以降
REST API バージョン 2019-05-10 以降
[Linked deployments](リンクされたデプロイ) には、デプロイリソースの種類に API バージョン 2019-05-10 以降を使用する必要があります

以前のバージョンの PowerShell、CLI、および REST API では、count の 0 をサポートしていません。

変数の反復処理

次の例では、文字列値の配列を作成する方法を示します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "itemCount": {
      "type": "int",
      "defaultValue": 5
    }
  },
  "variables": {
    "copy": [
      {
        "name": "stringArray",
        "count": "[parameters('itemCount')]",
        "input": "[concat('item', copyIndex('stringArray', 1))]"
      }
    ]
  },
  "resources": [],
  "outputs": {
    "arrayResult": {
      "type": "array",
      "value": "[variables('stringArray')]"
    }
  }
}

前のテンプレートは、次の値を持つ配列を返します。

[
  "item1",
  "item2",
  "item3",
  "item4",
  "item5"
]

次の例では、name、diskSizeGB、および diskIndex という 3 つのプロパティを持つオブジェクトの配列を作成する方法を示します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "itemCount": {
      "type": "int",
      "defaultValue": 5
    }
  },
  "variables": {
    "copy": [
      {
        "name": "objectArray",
        "count": "[parameters('itemCount')]",
        "input": {
          "name": "[concat('myDataDisk', copyIndex('objectArray', 1))]",
          "diskSizeGB": "1",
          "diskIndex": "[copyIndex('objectArray')]"
        }
      }
    ]
  },
  "resources": [],
  "outputs": {
    "arrayResult": {
      "type": "array",
      "value": "[variables('objectArray')]"
    }
  }
}

前の例は、次の値を持つ配列を返します。

[
  {
    "name": "myDataDisk1",
    "diskSizeGB": "1",
    "diskIndex": 0
  },
  {
    "name": "myDataDisk2",
    "diskSizeGB": "1",
    "diskIndex": 1
  },
  {
    "name": "myDataDisk3",
    "diskSizeGB": "1",
    "diskIndex": 2
  },
  {
    "name": "myDataDisk4",
    "diskSizeGB": "1",
    "diskIndex": 3
  },
  {
    "name": "myDataDisk5",
    "diskSizeGB": "1",
    "diskIndex": 4
  }
]

Note

変数の反復処理では、オフセット引数がサポートされます。オフセットは、copyIndex('diskNames', 1) など、反復処理の名前の後に指定する必要があります。オフセット値を指定しない場合、最初のインスタンスでは、既定値は 0 になります。

また、変数内で copy 要素を使用することもできます。次の例は、配列を値の 1 つとして持つオブジェクトを作成します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "itemCount": {
      "type": "int",
      "defaultValue": 5
    }
  },
  "variables": {
    "topLevelObject": {
      "sampleProperty": "sampleValue",
      "copy": [
        {
          "name": "disks",
          "count": "[parameters('itemCount')]",
          "input": {
            "name": "[concat('myDataDisk', copyIndex('disks', 1))]",
            "diskSizeGB": "1",
            "diskIndex": "[copyIndex('disks')]"
          }
        }
      ]
    }
  },
  "resources": [],
  "outputs": {
    "objectResult": {
      "type": "object",
      "value": "[variables('topLevelObject')]"
    }
  }
}

前の例は、次の値を持つオブジェクトを返します。

{
  "sampleProperty": "sampleValue",
  "disks": [
    {
      "name": "myDataDisk1",
      "diskSizeGB": "1",
      "diskIndex": 0
    },
    {
      "name": "myDataDisk2",
      "diskSizeGB": "1",
      "diskIndex": 1
    },
    {
      "name": "myDataDisk3",
      "diskSizeGB": "1",
      "diskIndex": 2
    },
    {
      "name": "myDataDisk4",
      "diskSizeGB": "1",
      "diskIndex": 3
    },
    {
      "name": "myDataDisk5",
      "diskSizeGB": "1",
      "diskIndex": 4
    }
  ]
}

次の例では、変数で copy を使用できるさまざまな方法を示します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {},
  "variables": {
    "disk-array-on-object": {
      "copy": [
        {
          "name": "disks",
          "count": 5,
          "input": {
            "name": "[concat('myDataDisk', copyIndex('disks', 1))]",
            "diskSizeGB": "1",
            "diskIndex": "[copyIndex('disks')]"
          }
        },
        {
          "name": "diskNames",
          "count": 5,
          "input": "[concat('myDataDisk', copyIndex('diskNames', 1))]"
        }
      ]
    },
    "copy": [
      {
        "name": "top-level-object-array",
        "count": 5,
        "input": {
          "name": "[concat('myDataDisk', copyIndex('top-level-object-array', 1))]",
          "diskSizeGB": "1",
          "diskIndex": "[copyIndex('top-level-object-array')]"
        }
      },
      {
        "name": "top-level-string-array",
        "count": 5,
        "input": "[concat('myDataDisk', copyIndex('top-level-string-array', 1))]"
      },
      {
        "name": "top-level-integer-array",
        "count": 5,
        "input": "[copyIndex('top-level-integer-array')]"
      }
    ]
  },
  "resources": [],
  "outputs": {
    "exampleObject": {
      "value": "[variables('disk-array-on-object')]",
      "type": "object"
    },
    "exampleArrayOnObject": {
      "value": "[variables('disk-array-on-object').disks]",
      "type" : "array"
    },
    "exampleObjectArray": {
      "value": "[variables('top-level-object-array')]",
      "type" : "array"
    },
    "exampleStringArray": {
      "value": "[variables('top-level-string-array')]",
      "type" : "array"
    },
    "exampleIntegerArray": {
      "value": "[variables('top-level-integer-array')]",
      "type" : "array"
    }
  }
}

サンプルテンプレート

次の例では、1 つの変数に対して複数の値を作成するための一般的なシナリオを示します。

Template	説明
Copy variables	変数を反復処理する各種の方法を示します。
Multiple security rules	ネットワークセキュリティグループに複数のセキュリティ規則をデプロイします。セキュリティ規則はパラメーターから構築されます。パラメーターについては、複数の NSG パラメーターファイルに関するページを参照してください。
Copy storage with variables	変数を反復処理し、複数のストレージアカウントを作成する方法の例。

次のステップ

チュートリアルについては、「チュートリアル:ARM テンプレートを使用した複数のリソースインスタンスの作成」を参照してください。
copy 要素のその他の使用方法については、以下を参照してください。
テンプレートのセクションの詳細については、「ARM テンプレートの構造と構文について」を参照してください。
テンプレートをデプロイする方法の詳細については、「ARM テンプレートと Azure PowerShell を使用したリソースのデプロイ」を参照してください。

ARM テンプレートでの変数の反復処理

構文

コピー制限

変数の反復処理

サンプル テンプレート

次のステップ

その他のリソース

サンプルテンプレート