クイックスタート: ARM テンプレート JSON デプロイのトラブルシューティング

[アーティクル]
04/05/2023

このクイックスタートでは、Azure Resource Manager テンプレート (ARM テンプレート) JSON デプロイエラーのトラブルシューティング方法について説明します。エラーを含むテンプレートを設定し、エラーを修正する方法を学びます。

Azure Resource Manager テンプレートは JavaScript Object Notation (JSON) ファイルであり、プロジェクトのインフラストラクチャと構成が定義されています。このテンプレートでは、宣言型の構文が使用されています。デプロイしようとしているものを、デプロイを作成する一連のプログラミングコマンドを記述しなくても記述できます。

デプロイに関するエラーには 3 種類あります。

検証エラー デプロイ開始前に、ファイル中の構文エラーによって発生します。これらのエラーは、Visual Studio Code などのコードエディターで特定できます。
プレフライト検証エラーは、デプロイコマンドが実行されてもリソースがデプロイされない場合に発生します。これらのエラーは、デプロイを開始しなくても検出されます。たとえば、パラメーターの値が正しくない場合は、プレフライト検証でエラーが検出されます。
デプロイエラー Azure 環境におけるデプロイのプロセスで発生し、デプロイの進行状況を確認することでのみ検出できます。

どの種類のエラーでも、デプロイのトラブルシューティングに使用できるエラーコードが出力されます。検証とプレフライトのエラーはアクティビティログに表示されますが、デプロイ履歴には表示されません。

前提条件

このクイックスタートを実行するには、次のものが必要です。

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。
Visual Studio Code と最新の Azure Resource Manager ツール拡張機能。
最新バージョンの Azure PowerShell または Azure CLI をインストールします。

エラーがあるテンプレートの作成

次のテンプレートをコピーしてローカルに保存します。このファイルを使用して、検証エラー、プレフライトエラー、デプロイエラーのトラブルシューティングを行います。このクイックスタートでは、ファイルに troubleshoot.json という名前を付けていますが、任意の名前を使用できます。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameterss": {
    "storageAccountType": {
      "type": "string",
      "defaultValue": "Standard_LRS",
      "allowedValues": [
        "Standard_LRS",
        "Standard_GRS",
        "Standard_ZRS",
        "Premium_LRS"
      ]
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    },
    "prefixName": {
      "type": "string"
    }
  },
  "variables": {
    "storageAccountName": "[concat(parameters('prefixName'), uniquestring(resourceGroup().id))]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-04-01",
      "name": "[variables('storageAccountName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('storageAccountType')]"
      },
      "kind": "StorageV2",
      "properties": {}
    }
  ],
  "outputs": {
    "storageAccountName": {
      "type": "string",
      "value": "[variables('storageAccountName')]"
    },
    "vnetResult": {
      "type": "object",
      "value": "[reference(resourceId('Microsoft.Network/virtualNetworks', 'doesnotexist'), '2021-03-01', 'Full')]"
    }
  }
}

検証エラーを修正する

Visual Studio Code でファイルを開きます。 parameterss: の下の波線はエラーを示しています。検証エラーを表示するために、エラーにカーソルを合わせます。

Screenshot of Visual Studio Code highlighting a template validation error with a red wavy line under the misspelled 'parameterss:' in the code.

variables と resources に undefined parameter reference のエラーがあるのがわかります。テンプレートの検証エラーを表示するには、 [表示]>[Problems](問題) を選択します。

Screenshot of Visual Studio Code showing the Problems tab listing undefined parameter reference errors for 'variables' and 'resources' sections.

このすべてのエラーは、要素名のスペルが正しくないために発生します。

"parameterss": {

エラーメッセージは、Template validation failed: Could not find member 'parameterss' on object of type 'Template'. Path 'parameterss', line 4, position 16 となっています。

parameters の ARM テンプレート構文は、parameters が正しい要素名であることを示しています。

検証エラーと undefined parameter reference エラーを修正するにはスペルを修正し、ファイルを保存します。

"parameters": {

プレフライトエラーを修正する

プレフライト検証エラーを作成するには、prefixName パラメーターに正しくない値を使用します。

このクイックスタートではリソースグループ名に troubleshootRG を使用していますが、任意の名前を使用できます。

Azure CLI
PowerShell

az group create --name troubleshootRG --location westus
az deployment group create \
  --resource-group troubleshootRG \
  --template-file troubleshoot.json \
  --parameters prefixName=long!!StoragePrefix

New-AzResourceGroup -Name troubleshootRG -Location westus
New-AzResourceGroupDeployment `
  -ResourceGroupName troubleshootRG `
  -TemplateFile troubleshoot.json `
  -prefixName long!!StoragePrefix

テンプレートはプレフライト検証に失敗し、デプロイが実行されません。 prefixName が 11 文字を超え、特殊文字と大文字を含んでいます。

ストレージ名は 3 から 24 文字までとし、小文字と数字のみを使用する必要があります。プレフィックス値によって無効なストレージ名が作成されました。詳細については、「ストレージアカウント名のエラーの解決」を参照してください。プレフライトエラーを修正するには、使用するプレフィックスを 11 文字以下にし、小文字または数字のみを含めます。

デプロイが実行されなかったため、デプロイ履歴はありません。

Screenshot of Azure resource group overview page displaying an empty deployment history section due to a preflight error.

アクティビティログにプレフライトエラーが表示されます。ログを選択するとエラーの詳細が表示されます。

Screenshot of Azure resource group activity log showing a preflight error entry with a red exclamation mark icon.

デプロイエラーを修正する

storage のような有効なプレフィックス値を使用してデプロイを実行します。

Azure CLI
PowerShell

az group create --name troubleshootRG --location westus
az deployment group create \
  --resource-group troubleshootRG \
  --template-file troubleshoot.json \
  --parameters prefixName=storage

New-AzResourceGroup -Name troubleshootRG -Location westus
New-AzResourceGroupDeployment `
  -ResourceGroupName troubleshootRG `
  -TemplateFile troubleshoot.json `
  -prefixName storage

デプロイが始まり、デプロイ履歴に表示されます。 outputs がリソースグループに存在しない仮想ネットワークを参照しているため、デプロイは失敗します。ただし、ストレージアカウントにはエラーがなかったため、リソースはデプロイされました。デプロイ履歴には、デプロイが失敗したことが表示されます。

Screenshot of Azure resource group overview page showing a failed deployment with a red exclamation mark icon in the deployment history section.

デプロイエラーを修正するには、有効なリソースを使用するように reference 関数を変更します。詳細については、「リソースが見つからないエラーを解決する」を参照してください。このクイックスタートでは、vnetResult の前のコンマとすべての vnetResult を削除します。ファイルを保存し、デプロイを再実行します。

"vnetResult": {
  "type": "object",
  "value": "[reference(resourceId('Microsoft.Network/virtualNetworks', 'doesnotexist'), '2021-03-01', 'Full')]"
}

検証、プレフライト、デプロイのエラーが修正された後、次のテンプレートによってストレージアカウントがデプロイされます。デプロイ履歴とアクティビティログに、デプロイが成功したことが表示されます。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageAccountType": {
      "type": "string",
      "defaultValue": "Standard_LRS",
      "allowedValues": [
        "Standard_LRS",
        "Standard_GRS",
        "Standard_ZRS",
        "Premium_LRS"
      ]
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    },
    "prefixName": {
      "type": "string"
    }
  },
  "variables": {
    "storageAccountName": "[concat(parameters('prefixName'), uniquestring(resourceGroup().id))]"
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2021-04-01",
      "name": "[variables('storageAccountName')]",
      "location": "[parameters('location')]",
      "sku": {
        "name": "[parameters('storageAccountType')]"
      },
      "kind": "StorageV2",
      "properties": {}
    }
  ],
  "outputs": {
    "storageAccountName": {
      "type": "string",
      "value": "[variables('storageAccountName')]"
    }
  }
}

リソースをクリーンアップする

Azure リソースが必要なくなったときは、リソースグループを削除します。

Azure CLI
PowerShell

az group delete --name troubleshootRG

Remove-AzResourceGroup -Name troubleshootRG

ポータルでリソースグループを削除するには、このステップに従います。

Azure portal で、検索ボックスに「リソースグループ」と入力します。
[名前でフィルター] フィールドに、リソースグループ名を入力します。
リソースグループ名を選択します。
[リソースグループの削除] を選択します。
削除を確認するには、リソースグループ名を入力して [削除] を選択します。

次のステップ

このクイックスタートでは、ARM テンプレートデプロイエラーのトラブルシューティング方法について説明しました。

よくある Azure デプロイエラーのトラブルシューティングに関する記事

クイック スタート: ARM テンプレート JSON デプロイのトラブルシューティング