ARM テンプレートでのリソースの反復処理

2025-08-13

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

プロパティ、変数、および出力でコピーループを使用することもできます。

リソースがデプロイされるかどうかを指定する必要がある場合は、条件要素を参照してください。

ヒント

Bicep は ARM テンプレートと同じ機能を提供し、構文の方が使いやすいため、推奨されます。詳細については、ループを参照してください。

構文

テンプレートの resources セクションに copy 要素を追加して、リソースの複数のインスタンスをデプロイします。 copy要素には、次の一般的な形式があります。

"copy": {
  "name": "<name-of-loop>",
  "count": <number-of-iterations>,
  "mode": "serial" <or> "parallel",
  "batchSize": <number-to-deploy-serially>
}

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

modeプロパティとbatchSizeプロパティを使用して、リソースを並列または順番にデプロイするかどうかを指定します。これらのプロパティは、シリアルまたは並列で記述されています。

コピーの制限

カウントが 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 はサポートされていません。

コピーループで完全モードのデプロイを使用する場合は注意してください。完全モードでリソースグループに再デプロイすると、コピーループの解決後にテンプレートで指定されていないリソースはすべて削除されます。

リソースの反復処理

次の例では、 storageCount パラメーターで指定されたストレージアカウントの数を作成します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "___location": {
      "type": "string",
      "defaultValue": "[resourceGroup().___location]"
    },
    "storageCount": {
      "type": "int",
      "defaultValue": 3
    }
  },
  "resources": [
    {
      "copy": {
        "name": "storagecopy",
        "count": "[length(range(0, parameters('storageCount')))]"
      },
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[format('{0}storage{1}', range(0, parameters('storageCount'))[copyIndex()], uniqueString(resourceGroup().id))]",
      "___location": "[parameters('___location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "Storage",
      "properties": {}
    }
  ]
}

各リソースの名前には、ループ内の現在のイテレーションを返す copyIndex() 関数が含まれていることに注意してください。 copyIndex() は 0 から始まります。そのため、次の例を示します。

"name": "[format('storage{0}', copyIndex())]",

これらの名前を作成します。

ストレージ0
ストレージ1
ストレージ2

インデックス値をオフセットするには、copyIndex() 関数に値を渡します。反復回数はコピー要素で指定されますが、 copyIndex の値は指定された値によってオフセットされます。そのため、次の例を示します。

"name": "[format('storage{0}', copyIndex(1))]",

これらの名前を作成します。

ストレージ1
ストレージ2
ストレージ3

コピー操作は、配列内の各要素を反復処理できるため、配列を操作するときに役立ちます。配列の length 関数を使用して反復回数を指定し、配列内の現在のインデックスを取得する copyIndex します。

次の例では、パラメーターに指定された名前ごとに 1 つのストレージアカウントを作成します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageNames": {
      "type": "array",
      "defaultValue": [
        "contoso",
        "fabrikam",
        "coho"
      ]
    },
    "___location": {
      "type": "string",
      "defaultValue": "[resourceGroup().___location]"
    }
  },
  "resources": [
    {
      "copy": {
        "name": "storagecopy",
        "count": "[length(parameters('storageNames'))]"
      },
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[format('{0}{1}', parameters('storageNames')[copyIndex()], uniqueString(resourceGroup().id))]",
      "___location": "[parameters('___location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "Storage",
      "properties": {}
    }
  ]
}

デプロイされたリソースから値を返す場合は、出力セクションでコピーを使用できます。

シンボリック名を使用する

シンボリック名は、リソースコピーループに割り当てられます。ループインデックスは 0 から始まります。次の例では、 myStorages[1] リソースループ内の 2 番目のリソースを参照しています。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "languageVersion": "2.0",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "___location": {
      "type": "string",
      "defaultValue": "[resourceGroup().___location]"
    },
    "storageCount": {
      "type": "int",
      "defaultValue": 2
    }
  },
  "resources": {
    "myStorages": {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[format('{0}storage{1}', copyIndex(), uniqueString(resourceGroup().id))]",
      "___location": "[parameters('___location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "Storage",
      "properties": {},
      "copy": {
        "name": "storagecopy",
        "count": "[parameters('storageCount')]"
      }
    }
  },
  "outputs": {
    "storageEndpoint":{
      "type": "object",
      "value": "[reference('myStorages[1]').primaryEndpoints]"
    }
  }
}

インデックスがランタイム値の場合は、参照を自分で書式設定します。例えば次が挙げられます。

"outputs": {
  "storageEndpoint":{
    "type": "object",
    "value": "[reference(format('myStorages[{0}]', variables('runtimeIndex'))).primaryEndpoints]"
  }
}

シンボリック名は dependsOn 配列で使用できます。シンボリック名がコピーループの場合、ループ内のすべてのリソースが依存関係として追加されます。詳細については、ループ内の依存リソースを参照してください。

シリアルまたは並列

既定では、Resource Manager によってリソースが並列に作成されます。テンプレート内のリソースの合計制限である 800 個を除き、並列にデプロイされるリソースの数に制限は適用されません。それらが作成される順序は保証されません。

ただし、リソースを順番にデプロイするように指定することもできます。たとえば、運用環境を更新する場合、更新を調整して、一度に特定の数だけが更新されるようにすることができます。

リソースの複数のインスタンスを順次デプロイするには、 mode を シリアル に設定し、一度にデプロイするインスタンスの数に batchSize します。シリアルモードでは、Resource Manager は、前のバッチが完了するまで 1 つのバッチを開始しないように、ループ内の以前のインスタンスに依存関係を作成します。

batchSizeの値は、copy 要素のcountの値を超えることはできません。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "___location": {
      "type": "string",
      "defaultValue": "[resourceGroup().___location]"
    }
  },
  "resources": [
    {
      "copy": {
        "name": "storagecopy",
        "count": 4,
        "mode": "serial",
        "batchSize": 2
      },
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2022-09-01",
      "name": "[format('{0}storage{1}', range(0, 4)[copyIndex()], uniqueString(resourceGroup().id))]",
      "___location": "[parameters('___location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "Storage",
      "properties": {}
    }
  ]
}

mode プロパティは、既定値である parallel も受け入れます。

子リソースの反復処理

子リソースにコピーループを使用することはできません。通常、別のリソース内で入れ子として定義するリソースの複数のインスタンスを作成するには、そのリソースを最上位のリソースとして作成する必要があります。型と名前のプロパティを使用して、親リソースとのリレーションシップを定義します。

たとえば、通常、データセットをデータファクトリ内の子リソースとして定義するとします。

{
  "resources": [
    {
      "type": "Microsoft.DataFactory/factories",
      "name": "exampleDataFactory",
      ...
      "resources": [
        {
          "type": "datasets",
          "name": "exampleDataSet",
          "dependsOn": [
            "exampleDataFactory"
          ],
          ...
        }
      ]
      ...
    }
  ]
}

複数のデータセットを作成するには、データファクトリの外部に移動します。データセットはデータファクトリと同じレベルである必要がありますが、データファクトリの子リソースです。型と名前のプロパティは、データセットとデータファクトリの間のリレーションシップを保持します。型はテンプレート内の位置から推論できなくなるため、完全修飾型を次の形式で指定する必要があります: {resource-provider-namespace}/{parent-resource-type}/{child-resource-type}。

データファクトリのインスタンスとの親子関係を確立するには、親リソース名を含むデータセットの名前を指定します。次の形式を使用します。{parent-resource-name}/{child-resource-name}

次の例は、実装を示しています。

"resources": [
{
  "type": "Microsoft.DataFactory/factories",
  "name": "exampleDataFactory",
  ...
},
{
  "type": "Microsoft.DataFactory/factories/datasets",
  "name": "[format('exampleDataFactory/exampleDataSet{0}', copyIndex())]",
  "dependsOn": [
    "exampleDataFactory"
  ],
  "copy": {
    "name": "datasetcopy",
    "count": "3"
  },
  ...
}]

サンプルテンプレート

次の例は、リソースまたはプロパティの複数のインスタンスを作成する一般的なシナリオを示しています。

テンプレート	説明
ストレージのコピー	名前にインデックス番号を持つ複数のストレージアカウントをデプロイします。
シリアルコピーストレージ	一度に複数のストレージアカウントをデプロイします。名前にはインデックス番号が含まれます。
配列を使用してストレージをコピーする	複数のストレージアカウントをデプロイします。名前には配列の値が含まれます。
リソースグループのコピー	複数のリソースグループをデプロイします。

次のステップ

コピーループで作成されたリソースへの依存関係を設定するには、 ARM テンプレートでリソースをデプロイする順序を定義する方法を参照してください。
チュートリアルを実行するには、ARM テンプレートを使用して複数のリソースインスタンスを作成する方法を 1 つ参照してください。
リソースのコピーについて説明する Microsoft Learn モジュールについては、高度な ARM テンプレート機能を使用して複雑なクラウドデプロイを管理する方法を参照してください。
コピーループのその他の用途については、次を参照してください。
入れ子になったテンプレートでコピーを使用する方法については、コピーの使用方法を参照してください。

次の方法で共有