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

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

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

ヒント

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

構文

copy 要素の一般的な形式は次のとおりです。

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

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

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

コピーの制限

カウントは 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 では、カウントの 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
  }
]

注

変数の反復では、オフセット引数がサポートされます。オフセットは、 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"
    }
  }
}

サンプルテンプレート

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

テンプレート	説明
変数のコピー	変数を反復処理するさまざまな方法を示します。
複数のセキュリティ規則	ネットワークセキュリティグループにいくつかのセキュリティ規則を展開します。パラメーターからセキュリティ規則を構築します。パラメーターについては、複数の NSG パラメーターファイルを参照してください。
変数を使用してストレージをコピーする	変数を反復処理し、複数のストレージアカウントを作成する方法の例。

次のステップ

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

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-05-01