Azure Resource Manager テンプレートの仮想マシン

[アーティクル]
10/15/2024

適用対象: ✔️ Windows VM

この記事では、仮想マシンに適用される、Azure Resource Manager テンプレートの側面について説明します。仮想マシンを作成するための完全なテンプレートについては、この記事では説明しません。完全なテンプレートには、ストレージアカウント、ネットワークインターフェイス、パブリック IP アドレス、および仮想ネットワークのリソース定義が必要です。これらのリソースをまとめて定義できる方法の詳細については、「Resource Manager テンプレートのチュートリアル」を参照してください。

VM リソースを含め、ギャラリーにはテンプレートが多数あります。テンプレートに含めることができるすべての要素をここで説明するわけではありません。

次の例では、指定された数の VM を作成するためのテンプレートの典型的なリソースセクションを示しています。

"resources": [
  {
    "apiVersion": "2016-04-30-preview",
    "type": "Microsoft.Compute/virtualMachines",
    "name": "[concat('myVM', copyindex())]",
    "location": "[resourceGroup().location]",
    "copy": {
      "name": "virtualMachineLoop",
      "count": "[parameters('numberOfInstances')]"
    },
    "dependsOn": [
      "[concat('Microsoft.Network/networkInterfaces/myNIC', copyindex())]"
    ],
    "properties": {
      "hardwareProfile": {
        "vmSize": "Standard_DS1"
      },
      "osProfile": {
        "computername": "[concat('myVM', copyindex())]",
        "adminUsername": "[parameters('adminUsername')]",
        "adminPassword": "[parameters('adminPassword')]"
      },
      "storageProfile": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2012-R2-Datacenter",
          "version": "latest"
        },
        "osDisk": {
          "name": "[concat('myOSDisk', copyindex())]",
          "caching": "ReadWrite",
          "createOption": "FromImage"
        },
        "dataDisks": [
          {
            "name": "[concat('myDataDisk', copyindex())]",
            "diskSizeGB": "100",
            "lun": 0,
            "createOption": "Empty"
          }
        ]
      },
      "networkProfile": {
        "networkInterfaces": [
          {
            "id": "[resourceId('Microsoft.Network/networkInterfaces',
              concat('myNIC', copyindex()))]"
          }
        ]
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": "true",
          "storageUri": "[concat('https://', variables('storageName'), '.blob.core.windows.net')]"
        }
      }
    },
    "resources": [
      {
        "name": "Microsoft.Insights.VMDiagnosticsSettings",
        "type": "extensions",
        "location": "[resourceGroup().location]",
        "apiVersion": "2016-03-30",
        "dependsOn": [
          "[concat('Microsoft.Compute/virtualMachines/myVM', copyindex())]"
        ],
        "properties": {
          "publisher": "Microsoft.Azure.Diagnostics",
          "type": "IaaSDiagnostics",
          "typeHandlerVersion": "1.5",
          "autoUpgradeMinorVersion": true,
          "settings": {
            "xmlCfg": "[base64(concat(variables('wadcfgxstart'),
            variables('wadmetricsresourceid'),
            concat('myVM', copyindex()),
            variables('wadcfgxend')))]",
            "storageAccount": "[variables('storageName')]"
          },
          "protectedSettings": {
            "storageAccountName": "[variables('storageName')]",
            "storageAccountKey": "[listkeys(variables('accountid'),
              '2015-06-15').key1]",
            "storageAccountEndPoint": "https://core.windows.net"
          }
        }
      },
      {
        "name": "MyCustomScriptExtension",
        "type": "extensions",
        "apiVersion": "2016-03-30",
        "location": "[resourceGroup().location]",
        "dependsOn": [
          "[concat('Microsoft.Compute/virtualMachines/myVM', copyindex())]"
        ],
        "properties": {
          "publisher": "Microsoft.Compute",
          "type": "CustomScriptExtension",
          "typeHandlerVersion": "1.7",
          "autoUpgradeMinorVersion": true,
          "settings": {
            "fileUris": [
              "[concat('https://', variables('storageName'),
                '.blob.core.windows.net/customscripts/start.ps1')]"
            ],
            "commandToExecute": "powershell.exe -ExecutionPolicy Unrestricted -File start.ps1"
          }
        }
      }
    ]
  }
]

Note

この例では、以前に作成したストレージアカウントが使用されています。このストレージアカウントは、テンプレートからデプロイして作成することができました。この例では、テンプレートで定義されるネットワークインターフェイスとその依存リソースも使用されています。これらのリソースは、この例では示されていません。

API バージョン

テンプレートを使用してリソースをデプロイする際に、使用する API のバージョンを指定する必要があります。この例では、次の apiVersion 要素を使用して仮想マシンリソースを示しています。

"apiVersion": "2016-04-30-preview",

テンプレートで指定した API のバージョンに応じて、テンプレートで定義できるプロパティが変わります。通常は、テンプレートを作成するときに、最新の API バージョンを選択する必要があります。既存のテンプレートの場合、以前の API バージョンの使用を続けるか、テンプレートを最新版に更新して新しい機能を最大限に活用するか決定できます。

最新の API バージョンを取得するには、次の方法を使用してください。

パラメーターと変数

パラメーターを使用すると、テンプレートの実行時にテンプレートに値を指定することが簡単になります。この例では、次の parameters セクションが使用されています。

"parameters": {
  "adminUsername": { "type": "string" },
  "adminPassword": { "type": "securestring" },
  "numberOfInstances": { "type": "int" }
},

サンプルテンプレートをデプロイするときに、各 VM の管理者アカウントの名前とパスワード、作成する VM の数の値を入力します。テンプレートと共に管理される別のファイルでパラメーター値を指定したり、要求時に値を指定したりすることもできます。

変数を使用すると、テンプレート全体で繰り返し使用される値や時間の経過と共に変化する可能性がある値を、テンプレートで簡単に設定できます。この例では、次の variables セクションが使用されています。

"variables": {
  "storageName": "mystore1",
  "accountid": "[concat('/subscriptions/', subscription().subscriptionId,
    '/resourceGroups/', resourceGroup().name,
  '/providers/','Microsoft.Storage/storageAccounts/', variables('storageName'))]",
  "wadlogs": "<WadCfg>
    <DiagnosticMonitorConfiguration overallQuotaInMB=\"4096\" xmlns=\"http://schemas.microsoft.com/ServiceHosting/2010/10/DiagnosticsConfiguration\">
      <DiagnosticInfrastructureLogs scheduledTransferLogLevelFilter=\"Error\"/>
      <WindowsEventLog scheduledTransferPeriod=\"PT1M\" >
        <DataSource name=\"Application!*[System[(Level = 1 or Level = 2)]]\" />
        <DataSource name=\"Security!*[System[(Level = 1 or Level = 2)]]\" />
        <DataSource name=\"System!*[System[(Level = 1 or Level = 2)]]\" />
      </WindowsEventLog>",
  "wadperfcounters": "<PerformanceCounters scheduledTransferPeriod=\"PT1M\">
      <PerformanceCounterConfiguration counterSpecifier=\"\\Process(_Total)\\Thread Count\" sampleRate=\"PT15S\" unit=\"Count\">
        <annotation displayName=\"Threads\" locale=\"en-us\"/>
      </PerformanceCounterConfiguration>
    </PerformanceCounters>",
  "wadcfgxstart": "[concat(variables('wadlogs'), variables('wadperfcounters'),
    '<Metrics resourceId=\"')]",
  "wadmetricsresourceid": "[concat('/subscriptions/', subscription().subscriptionId,
    '/resourceGroups/', resourceGroup().name ,
    '/providers/', 'Microsoft.Compute/virtualMachines/')]",
  "wadcfgxend": "\"><MetricAggregation scheduledTransferPeriod=\"PT1H\"/>
    <MetricAggregation scheduledTransferPeriod=\"PT1M\"/>
    </Metrics></DiagnosticMonitorConfiguration>
    </WadCfg>"
},

サンプルテンプレートをデプロイすると、以前に作成したストレージアカウントの名前と識別子に変数の値が使用されています。変数は、診断拡張機能の設定の指定にも使用されています。 Azure Resource Manager テンプレートを作成するためのベストプラクティスに関する記事を参照すると、テンプレートでパラメーターと変数をどのように構成するかを決めるのに役立ちます。

リソースループ

アプリケーションに複数の仮想マシンが必要な場合は、テンプレートの copy 要素を使用できます。この省略可能な要素は、パラメーターとして指定した数の VM が作成されるまでループされます。

"copy": {
  "name": "virtualMachineLoop",
  "count": "[parameters('numberOfInstances')]"
},

また、この例では、リソースのいくつかの値を指定する際にループインデックスが使用されていることにも注意してください。たとえば、インスタンス数として 3 を入力した場合、オペレーティングシステムディスクの名前は、myOSDisk1、myOSDisk2、myOSDisk3 となります。

"osDisk": {
  "name": "[concat('myOSDisk', copyindex())]",
  "caching": "ReadWrite",
  "createOption": "FromImage"
}

Note

この例では、仮想マシンのマネージドディスクを使用します。

テンプレート内の 1 つのリソースに対してループを作成すると、他のリソースの作成時や他のリソースへのアクセス時にそのループを使用する必要が生じる可能性があることに注意してください。たとえば、複数の VM では同じネットワークインターフェイスを使用できないため、テンプレートでループして 3 つの VM を作成する場合は、3 つのネットワークインターフェイスもループによって作成しなければなりません。 VM にネットワークインターフェイスを割り当てる際は、それらを識別するためにループインデックスが使用されます。

"networkInterfaces": [ {
  "id": "[resourceId('Microsoft.Network/networkInterfaces',
    concat('myNIC', copyindex()))]"
} ]

依存関係

ほとんどのリソースは、正常に動作するために他のリソースに依存しています。仮想マシンは仮想ネットワークに関連付ける必要があり、そのためにはネットワークインターフェイスが必要です。 dependsOn 要素は、VM が作成される前にネットワークインターフェイスを使用できるようするために使用されます。

"dependsOn": [
  "[concat('Microsoft.Network/networkInterfaces/', 'myNIC', copyindex())]"
],

Resource Manager は、デプロイ中の他のリソースに依存していないすべてのリソースを並行してデプロイします。不要な依存関係を指定すると、意図せずにデプロイの速度を低下させる可能性があるため、依存関係を設定する際は注意してください。依存関係により、複数のリソースを連結できます。たとえば、ネットワークインターフェイスは、パブリック IP アドレスと仮想ネットワークリソースに依存します。

依存関係が必要かどうかは、どのように判断するのでしょうか。テンプレートで設定した値を確認してください。仮想マシンリソース定義内の要素が、同じテンプレートでデプロイされる他のリソースを指している場合は、依存関係が必要です。たとえば、このサンプルの仮想マシンは、次のようにネットワークプロファイルを定義しています。

"networkProfile": {
  "networkInterfaces": [ {
    "id": "[resourceId('Microsoft.Network/networkInterfaces',
      concat('myNIC', copyindex())]"
  } ]
},

このプロパティを設定するには、ネットワークインターフェイスが存在する必要があります。したがって、依存関係が必要です。 1 つのリソース (子) が他のリソース (親) の中で定義されている場合も、依存関係を設定する必要があります。たとえば、診断設定とカスタムスクリプト拡張機能は両方とも、仮想マシンの子リソースとして定義されています。これらは、仮想マシンが存在しないうちは、作成することができません。そのため、両方のリソースは、仮想マシンに依存しているとマークされます。

Profiles

いくつかのプロファイル要素は、仮想マシンリソースを定義する際に使用されます。必須のものもあれば、省略可能なものもあります。たとえば、hardwareProfile、osProfile、storageProfile、networkProfile 要素は必須で、diagnosticsProfile 要素は省略可能です。これらのプロファイルは、次のような設定を定義します。

ディスクとイメージ

Azure では、vhd ファイルはディスクまたはイメージを表すことができます。 vhd ファイルのオペレーティングシステムは、特定の VM に特化している場合はディスクと呼ばれます。 vhd ファイルのオペレーティングシステムが、多くの VM の作成に使用されるように一般化されている場合は、イメージと呼ばれます。

プラットフォームイメージから新しい仮想マシンと新しいディスクを作成する

VM を作成する場合は、どのオペレーティングシステムを使用するかを決める必要があります。新しい VM のオペレーティングシステムを定義するには、imageReference 要素を使用します。次の例では、Windows Server オペレーティングシステムの定義を示しています。

"imageReference": {
  "publisher": "MicrosoftWindowsServer",
  "offer": "WindowsServer",
  "sku": "2012-R2-Datacenter",
  "version": "latest"
},

Linux オペレーティングシステムを作成する場合は、次の定義を使用できます。

"imageReference": {
  "publisher": "Canonical",
  "offer": "UbuntuServer",
  "sku": "20.04.2-LTS",
  "version": "latest"
},

注意

必要に応じて、publisher、offer、sku、version の値を変更します。

オペレーティングシステムディスクの構成設定は、osDisk 要素で割り当てられます。この例では、キャッシュモードが ReadWrite に設定された新しいマネージドディスクを定義し、ディスクがプラットフォームイメージから作成されるようにします。

"osDisk": {
  "name": "[concat('myOSDisk', copyindex())]",
  "caching": "ReadWrite",
  "createOption": "FromImage"
},

既存のマネージドディスクから新しい仮想マシンを作成する

既存のディスクから仮想マシンを作成する場合は、imageReference 要素と osProfile 要素を削除し、次のディスク設定を定義します。

"osDisk": {
  "osType": "Windows",
  "managedDisk": {
    "id": "[resourceId('Microsoft.Compute/disks', [concat('myOSDisk', copyindex())])]"
  },
  "caching": "ReadWrite",
  "createOption": "Attach"
},

管理イメージから新しい仮想マシンを作成する

管理イメージから仮想マシンを作成する場合は、imageReference 要素を変更し、次のディスク設定を定義します。

"storageProfile": {
  "imageReference": {
    "id": "[resourceId('Microsoft.Compute/images', 'myImage')]"
  },
  "osDisk": {
    "name": "[concat('myOSDisk', copyindex())]",
    "osType": "Windows",
    "caching": "ReadWrite",
    "createOption": "FromImage"
  }
},

データディスクを接続する

必要に応じて、VM にデータディスクを追加することができます。ディスク数は、使用するオペレーティングシステムディスクのサイズによって異なります。 VM のサイズが Standard_DS1_v2 に設定されている場合、VM に追加できるデータディスクの最大数は 2 です。次の例では、各 VM に 1 つのマネージドデータディスクが追加されます。

"dataDisks": [
  {
    "name": "[concat('myDataDisk', copyindex())]",
    "diskSizeGB": "100",
    "lun": 0,
    "caching": "ReadWrite",
    "createOption": "Empty"
  }
],

拡張機能

拡張機能は個別のリソースですが、VM に密接に関係しています。拡張機能は、VM の子リソース、または個別のリソースとして追加できます。次の例は、VM に追加される診断の拡張機能を示しています。

{
  "name": "Microsoft.Insights.VMDiagnosticsSettings",
  "type": "extensions",
  "location": "[resourceGroup().location]",
  "apiVersion": "2016-03-30",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/myVM', copyindex())]"
  ],
  "properties": {
    "publisher": "Microsoft.Azure.Diagnostics",
    "type": "IaaSDiagnostics",
    "typeHandlerVersion": "1.5",
    "autoUpgradeMinorVersion": true,
    "settings": {
      "xmlCfg": "[base64(concat(variables('wadcfgxstart'),
      variables('wadmetricsresourceid'),
      concat('myVM', copyindex()),
      variables('wadcfgxend')))]",
      "storageAccount": "[variables('storageName')]"
    },
    "protectedSettings": {
      "storageAccountName": "[variables('storageName')]",
      "storageAccountKey": "[listkeys(variables('accountid'),
        '2015-06-15').key1]",
      "storageAccountEndPoint": "https://core.windows.net"
    }
  }
},

この拡張機能リソースは、storageName 変数と診断変数を使用して値を指定します。この拡張機能で収集するデータを変更する場合は、wadperfcounters 変数にさらに多くのパフォーマンスカウンターを追加できます。また、VM ディスクの格納場所とは異なるストレージアカウントに診断データを格納することもできます。

VM にインストールできる拡張機能は多数ありますが、最も便利なのは、おそらくカスタムスクリプト拡張機能でしょう。次の例では、start.ps1 という名前の PowerShell スクリプトが、各 VM で起動時に実行されます。

{
  "name": "MyCustomScriptExtension",
  "type": "extensions",
  "apiVersion": "2016-03-30",
  "location": "[resourceGroup().location]",
  "dependsOn": [
    "[concat('Microsoft.Compute/virtualMachines/myVM', copyindex())]"
  ],
  "properties": {
    "publisher": "Microsoft.Compute",
    "type": "CustomScriptExtension",
    "typeHandlerVersion": "1.7",
    "autoUpgradeMinorVersion": true,
    "settings": {
      "fileUris": [
        "[concat('https://', variables('storageName'),
          '.blob.core.windows.net/customscripts/start.ps1')]"
      ],
      "commandToExecute": "powershell.exe -ExecutionPolicy Unrestricted -File start.ps1"
    }
  }
}

start.ps1 スクリプトは、多くの構成タスクを実行できます。たとえば、この例で VM に追加されるデータディスクは、初期化されていないため、カスタムスクリプトを使用して初期化することができます。実行するスタートアップタスクが複数ある場合は、start.ps1 ファイルを使用して、Azure Storage 内の他の PowerShell スクリプトを呼び出すことができます。例では PowerShell を使用していますが、お使いのオペレーティングシステム上で利用可能な任意のスクリプト手法を使用してかまいません。

インストールした拡張機能の状態は、ポータルの [拡張機能] の設定で確認できます。

拡張機能の状態の確認

また、Get-AzVMExtension PowerShell コマンド、vm extension get Azure CLI コマンド、または Get extension information REST API を使用して、拡張機能の情報を取得することもできます。

デプロイメント

テンプレートをデプロイすると、Azure では、グループとしてデプロイしたリソースが追跡され、このデプロイされたグループに自動的に名前が割り当てられます。デプロイの名前は、テンプレートの名前と同じです。

デプロイ内のリソースの状態が気になる場合は、Azure portal でリソースグループを表示します。

デプロイ情報の取得

リソースの作成や既存のリソースの更新に同じテンプレートを使用しても問題はありません。コマンドを使用してテンプレートをデプロイする際は、使用するモードを指定することができます。モードは、Complete または Incremental に設定することができます。既定では、増分更新が実行されます。 Complete モードを使用する場合は、誤ってリソースを削除することがあるため、注意してください。モードを Complete に設定すると、Resource Manager は、テンプレートに含まれていない、リソースグループ内のリソースすべてを削除します。

次の手順

「Azure Resource Manager のテンプレートの作成」を使用して、独自のテンプレートを作成します。
「Resource Manager テンプレートで Windows 仮想マシンを作成する」を使用して作成したテンプレートをデプロイします。
作成した VM を管理する方法については、「Azure PowerShell モジュールを使用して Windows VM を作成および管理する」をご覧ください。
テンプレート内のリソースの種類の JSON 構文とプロパティについては、Azure Resource Manager テンプレートリファレンスを参照してください。

次の方法で共有

Azure Resource Manager テンプレートの仮想マシン

API バージョン

パラメーターと変数

リソースループ

依存関係

Profiles

ディスクとイメージ

プラットフォームイメージから新しい仮想マシンと新しいディスクを作成する

既存のマネージドディスクから新しい仮想マシンを作成する

管理イメージから新しい仮想マシンを作成する

データディスクを接続する

拡張機能

デプロイメント

次の手順

フィードバック

その他のリソース

次の方法で共有

Azure Resource Manager テンプレートの仮想マシン

API バージョン

パラメーターと変数

リソース ループ

依存関係

Profiles

ディスクとイメージ

プラットフォーム イメージから新しい仮想マシンと新しいディスクを作成する

既存のマネージド ディスクから新しい仮想マシンを作成する

管理イメージから新しい仮想マシンを作成する

データ ディスクを接続する

拡張機能

デプロイメント

次の手順

フィードバック

その他のリソース

リソースループ

プラットフォームイメージから新しい仮想マシンと新しいディスクを作成する

既存のマネージドディスクから新しい仮想マシンを作成する

データディスクを接続する