ARM テンプレートを使用したリソースグループへのデプロイ

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

この記事では、デプロイのスコープをリソースグループに限定する方法について説明します。デプロイには、Azure Resource Manager テンプレート (ARM テンプレート) を使用します。この記事では、デプロイ操作でリソースグループを超えてスコープを拡張する方法についても説明します。

ヒント

ARM テンプレートと同じ機能を備え、構文も使いやすいため、Bicep をお勧めします。詳しくは、「リソースグループの展開」をご覧ください。

サポートされているリソース

ほとんどのリソースは、リソースグループにデプロイできます。使用可能なリソースのリストについては、ARM テンプレートのリファレンスを参照してください。

スキーマ

テンプレートでは、以下のスキーマを使用します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  ...
}

パラメーターファイルの場合は、次を使用します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  ...
}

デプロイコマンド

リソースグループにデプロイするには、リソースグループのデプロイコマンドを使用します。

Azure CLI
PowerShell

Azure CLI の場合は、az deployment group create を使用します。次の例では、リソースグループを作成するテンプレートがデプロイされます。 --resource-group パラメーターで指定するリソースグループは、ターゲットリソースグループです。

az deployment group create \
  --name demoRGDeployment \
  --resource-group ExampleGroup \
  --template-uri "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json" \
  --parameters storageAccountType=Standard_GRS

PowerShell デプロイコマンドには、New-AzResourceGroupDeployment を使用します。次の例では、リソースグループを作成するテンプレートがデプロイされます。 -ResourceGroupName パラメーターで指定するリソースグループは、ターゲットリソースグループです。

New-AzResourceGroupDeployment `
  -Name demoRGDeployment `
  -ResourceGroupName ExampleGroup `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json `
  -storageAccountType Standard_GRS

ARM テンプレートをデプロイするためのデプロイコマンドとオプションの詳細については、以下を参照してください。

デプロイのスコープ

リソースグループにデプロイする際には、リソースを以下にデプロイできます。

操作のターゲットリソースグループ
同じサブスクリプションまたは他のサブスクリプション内の他のリソースグループ
テナント内の任意のサブスクリプション
リソースグループのテナント

拡張リソースは、デプロイターゲットとは異なるターゲットにスコープ設定できます。

テンプレートをデプロイするユーザーは、特定のスコープにアクセスできる必要があります。

このセクションでは、異なるスコープを指定する方法について説明します。これらの異なるスコープを 1 つのテンプレートで結合することができます。

ターゲットリソースグループにスコープを設定する

リソースをターゲットリソースにデプロイするには、テンプレートのリソースセクションに目的のリソースを追加します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    resource-group-resources
  ],
  "outputs": {}
}

テンプレートの例については、「ターゲットリソースグループにデプロイする」を参照してください。

同じサブスクリプション内のリソースグループにスコープを設定する

同じサブスクリプション内の別のリソースグループにリソースをデプロイするには、入れ子になったデプロイを追加して、resourceGroup プロパティを含めます。サブスクリプション ID またはリソースグループを指定しない場合は、親テンプレートのサブスクリプションとリソースグループが使用されます。すべてのリソースグループは、デプロイの実行前に存在している必要があります。

次の例では、入れ子になったデプロイは demoResourceGroup という名前のリソースグループを対象としています。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2021-04-01",
      "name": "nestedDeployment",
      "resourceGroup": "demoResourceGroup",
      "properties": {
        "mode": "Incremental",
        "template": {
          resource-group-resources
        }
      }
    }
  ],
  "outputs": {}
}

テンプレートの例については、「複数のリソースグループにデプロイする」を参照してください。

別のサブスクリプション内のリソースグループにスコープを設定する

別のサブスクリプション内のリソースグループにリソースをデプロイするには、入れ子になったデプロイを追加し、 subscriptionId と resourceGroup の各プロパティを含めます。次の例では、入れ子になったデプロイは demoResourceGroup という名前のリソースグループを対象としています。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2021-04-01",
      "name": "nestedDeployment",
      "subscriptionId": "00000000-0000-0000-0000-000000000000",
      "resourceGroup": "demoResourceGroup",
      "properties": {
        "mode": "Incremental",
        "template": {
          resource-group-resources
        }
      }
    }
  ],
  "outputs": {}
}

テンプレートの例については、「複数のリソースグループにデプロイする」を参照してください。

サブスクリプションへのスコープ

リソースをサブスクリプションにデプロイするには、入れ子になったデプロイを追加して、subscriptionId プロパティを含めます。サブスクリプションには、ターゲットリソースグループのサブスクリプション、またはテナント内の他の任意のサブスクリプションを指定できます。また、入れ子になったデプロイについて location プロパティを設定します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2021-04-01",
      "name": "nestedDeployment",
      "location": "centralus",
      "subscriptionId": "0000000-0000-0000-0000-000000000000",
      "properties": {
        "mode": "Incremental",
        "template": {
          subscription-resources
        }
      }
    }
  ],
  "outputs": {}
}

テンプレートの例については、「リソースグループの作成」を参照してください。

テナントへのスコープ

テナントでリソースを作成するには、scope を / に設定します。テンプレートをデプロイするユーザーには、テナントでデプロイするための必要なアクセス権が必要です。

入れ子になったデプロイを使用するには、scope と location を設定します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2021-04-01",
      "name": "nestedDeployment",
      "location": "centralus",
      "scope": "/",
      "properties": {
        "mode": "Incremental",
        "template": {
          tenant-resources
        }
      }
    }
  ],
  "outputs": {}
}

または、管理グループなどの一部のリソースの種類に対して、スコープを / に設定することもできます。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "mgName": {
      "type": "string",
      "defaultValue": "[concat('mg-', uniqueString(newGuid()))]"
    }
  },
  "resources": [
    {
      "type": "Microsoft.Management/managementGroups",
      "apiVersion": "2021-04-01",
      "name": "[parameters('mgName')]",
      "scope": "/",
      "location": "eastus",
      "properties": {}
    }
  ],
  "outputs": {
    "output": {
      "type": "string",
      "value": "[parameters('mgName')]"
    }
  }
}

詳細については、「管理グループ」を参照してください。

ターゲットリソースグループにデプロイする

リソースをターゲットリソースグループにデプロイするには、テンプレートのresources セクションにそれらのリソースを定義します。次のテンプレートでは、デプロイ操作で指定されているリソースグループにストレージアカウントが作成されます。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storagePrefix": {
      "type": "string",
      "minLength": 3,
      "maxLength": 11
    },
    "storageSKU": {
      "type": "string",
      "defaultValue": "Standard_LRS",
      "allowedValues": [
        "Standard_LRS",
        "Standard_GRS",
        "Standard_RAGRS",
        "Standard_ZRS",
        "Premium_LRS",
        "Premium_ZRS",
        "Standard_GZRS",
        "Standard_RAGZRS"
      ]
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "variables": {
    "uniqueStorageName": "[concat(parameters('storagePrefix'), uniqueString(resourceGroup().id))]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-09-01",
      "name": "[variables('uniqueStorageName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('storageSKU')]"
      },
      "kind": "StorageV2",
      "properties": {
        "supportsHttpsTrafficOnly": true
      }
    }
  ],
  "outputs": {
    "storageEndpoint": {
      "type": "object",
      "value": "[reference(variables('uniqueStorageName')).primaryEndpoints]"
    }
  }
}

複数のリソースグループにデプロイする

1 つの ARM テンプレートで複数のリソースグループにデプロイできます。親テンプレートとは異なるリソースグループをターゲットにするには、入れ子になったテンプレートまたはリンクされたテンプレートを使用します。デプロイリソースの種類に、入れ子になったテンプレートのデプロイ対象のサブスクリプション ID およびリソースグループの値を指定します。リソースグループは、異なるサブスクリプションに存在していても構いません。

Note

単一のデプロイで 800 のリソースグループにデプロイできます。通常、この制限は、親テンプレートに対しては 1 つのリソースグループを、入れ子になったデプロイまたはリンクされたデプロイでは最大 799 のリソースグループを指定してデプロイできることを意味します。ただし、親テンプレートが入れ子になったテンプレートまたはリンクされたテンプレートのみを含んでいて、親テンプレート自体はリソースをデプロイしない場合は、入れ子になったデプロイまたはリンクされたデプロイで最大 800 のリソースグループを含めることができます。

次の例では、2 つのストレージアカウントをデプロイします。最初のストレージアカウントは、デプロイ操作で指定されたリソースグループにデプロイされます。 2 番目のストレージアカウントは、secondResourceGroup および secondSubscriptionID パラメーターで指定されたリソースグループにデプロイされます。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storagePrefix": {
      "type": "string",
      "maxLength": 11
    },
    "secondResourceGroup": {
      "type": "string"
    },
    "secondSubscriptionID": {
      "type": "string",
      "defaultValue": ""
    },
    "secondStorageLocation": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "variables": {
    "firstStorageName": "[concat(parameters('storagePrefix'), uniqueString(resourceGroup().id))]",
    "secondStorageName": "[concat(parameters('storagePrefix'), uniqueString(parameters('secondSubscriptionID'), parameters('secondResourceGroup')))]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-04-01",
      "name": "[variables('firstStorageName')]",
      "location": "[resourceGroup().location]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "Storage",
      "properties": {
      }
    },
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2021-04-01",
      "name": "nestedTemplate",
      "resourceGroup": "[parameters('secondResourceGroup')]",
      "subscriptionId": "[parameters('secondSubscriptionID')]",
      "properties": {
        "mode": "Incremental",
        "template": {
          "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
          "contentVersion": "1.0.0.0",
          "parameters": {},
          "variables": {},
          "resources": [
            {
              "type": "Microsoft.Storage/storageAccounts",
              "apiVersion": "2021-04-01",
              "name": "[variables('secondStorageName')]",
              "location": "[parameters('secondStorageLocation')]",
              "sku": {
                "name": "Standard_LRS"
              },
              "kind": "Storage",
              "properties": {
              }
            }
          ]
        },
        "parameters": {}
      }
    }
  ]
}

resourceGroup を存在しないリソースグループの名前に設定すると、デプロイは失敗します。

前のテンプレートをテストし、その結果を確認するには、PowerShell または Azure CLI を使用します。

PowerShell
Azure CLI

2 つのストレージアカウントを同じサブスクリプション内の 2 つのリソースグループにデプロイするには、次を使用します。

$firstRG = "primarygroup"
$secondRG = "secondarygroup"

New-AzResourceGroup -Name $firstRG -Location southcentralus
New-AzResourceGroup -Name $secondRG -Location eastus

New-AzResourceGroupDeployment `
  -ResourceGroupName $firstRG `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/crosssubscription.json `
  -storagePrefix storage `
  -secondResourceGroup $secondRG `
  -secondStorageLocation eastus

2 つのストレージアカウントを 2 つのサブスクリプションにデプロイするには、次を使用します。

$firstRG = "primarygroup"
$secondRG = "secondarygroup"

$firstSub = "<first-subscription-id>"
$secondSub = "<second-subscription-id>"

Set-AzContext -Subscription $secondSub
New-AzResourceGroup -Name $secondRG -Location eastus

Set-AzContext -Subscription $firstSub
New-AzResourceGroup -Name $firstRG -Location southcentralus

New-AzResourceGroupDeployment `
  -ResourceGroupName $firstRG `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/crosssubscription.json `
  -storagePrefix storage `
  -secondResourceGroup $secondRG `
  -secondStorageLocation eastus `
  -secondSubscriptionID $secondSub

2 つのストレージアカウントを同じサブスクリプション内の 2 つのリソースグループにデプロイするには、次を使用します。

firstRG="primarygroup"
secondRG="secondarygroup"

az group create --name $firstRG --location southcentralus
az group create --name $secondRG --location eastus
az deployment group create \
  --name ExampleDeployment \
  --resource-group $firstRG \
  --template-uri https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/crosssubscription.json \
  --parameters storagePrefix=tfstorage secondResourceGroup=$secondRG secondStorageLocation=eastus

2 つのストレージアカウントを 2 つのサブスクリプションにデプロイするには、次を使用します。

firstRG="primarygroup"
secondRG="secondarygroup"

firstSub="<first-subscription-id>"
secondSub="<second-subscription-id>"

az account set --subscription $secondSub
az group create --name $secondRG --location eastus

az account set --subscription $firstSub
az group create --name $firstRG --location southcentralus

az deployment group create \
  --name ExampleDeployment \
  --resource-group $firstRG \
  --template-uri https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/crosssubscription.json \
  --parameters storagePrefix=storage secondResourceGroup=$secondRG secondStorageLocation=eastus secondSubscriptionID=$secondSub

リソースグループの作成

リソースグループのデプロイから、サブスクリプションのレベルに切り替えて、リソースグループを作成することができます。次のテンプレートでは、ストレージアカウントをターゲットリソースグループにデプロイし、指定されたサブスクリプションに新しいリソースグループを作成します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storagePrefix": {
      "type": "string",
      "maxLength": 11
    },
    "newResourceGroupName": {
      "type": "string"
    },
    "nestedSubscriptionID": {
      "type": "string"
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "variables": {
    "storageName": "[concat(parameters('storagePrefix'), uniqueString(resourceGroup().id))]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-04-01",
      "name": "[variables('storageName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "Storage",
      "properties": {
      }
    },
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2021-04-01",
      "name": "demoSubDeployment",
      "location": "westus",
      "subscriptionId": "[parameters('nestedSubscriptionID')]",
      "properties": {
        "mode": "Incremental",
        "template": {
          "$schema": "https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#",
          "contentVersion": "1.0.0.0",
          "parameters": {},
          "variables": {},
          "resources": [
            {
              "type": "Microsoft.Resources/resourceGroups",
              "apiVersion": "2021-04-01",
              "name": "[parameters('newResourceGroupName')]",
              "location": "[parameters('location')]",
              "properties": {}
            }
          ],
          "outputs": {}
        }
      }
    }
  ]
}

次のステップ

Microsoft Defender for Cloud のワークスペースの設定をデプロイする例については、deployASCwithWorkspaceSettings.json のページを参照してください。

ARM テンプレートを使用したリソース グループへのデプロイ

サポートされているリソース

スキーマ

デプロイ コマンド

デプロイのスコープ

ターゲット リソース グループにスコープを設定する

同じサブスクリプション内のリソース グループにスコープを設定する

別のサブスクリプション内のリソース グループにスコープを設定する