Azure 仮想マシンのユーザーデータ

[アーティクル]
03/13/2023

ユーザーデータを使用すると、独自のスクリプトまたはメタデータを仮想マシンに渡すことができます。

"ユーザーデータ" とは

ユーザーデータは、プロビジョニング時に Azure 仮想マシンに挿入されるスクリプトまたは他のメタデータのセットです。仮想マシン上のどのアプリケーションも、プロビジョニング後に Azure Instance Metadata Service (IMDS) からユーザーデータにアクセスできます。

ユーザーデータは、カスタムデータの新しいバージョンであり、次のようなさらなる利点があります。

ユーザーデータは、プロビジョニング後に Azure Instance Metadata Service (IMDS) から取得できます。
ユーザーデータは永続的です。これは VM の有効期間中に使用できます。
VM を停止または再起動することなく、VM の外部からユーザーデータを更新できます。
ユーザーデータのクエリは、$expand オプション付きの GET VM/VMSS API を介して実行できます。

さらに、ユーザーデータがプロビジョニング時に追加されない場合でも、プロビジョニング後に追加できます。

セキュリティの警告

警告

ユーザーデータは暗号化されないため、VM 上の任意のプロセスでこのデータのクエリを実行できます。ユーザーデータに機密情報を格納しないでください。

新しいユーザーデータ機能を使用するには、必ず最新の Azure Resource Manager API を入手してください。コンテンツは、API に渡される前に base64 でエンコードする必要があります。そのサイズは 64 KB を超えることはできません。

Azure VM または VMSS のユーザーデータを作成する

新しい VM の作成時のユーザーデータの追加

こちらの Azure Resource Manager テンプレートを使用して、ユーザーデータを含む新しい VM を作成します。 REST API を使用している場合、単一 VM に対しては、VM を作成する PUT 要求と共に "properties" セクションに "UserData" を追加します。

{
  "name": "testVM",
  "location": "West US",
  "properties": {
    "hardwareProfile": {
      "vmSize": "Standard_A1"
    },
    "storageProfile": {
      "osDisk": {
        "osType": "Windows",
        "name": "osDisk",
        "createOption": "Attach",
        "vhd": {
          "uri": "http://myaccount.blob.core.windows.net/container/directory/blob.vhd"
        }
      }
    },
    "userData": "c2FtcGxlIHVzZXJEYXRh",
    "networkProfile": { "networkInterfaces" : [ { "name" : "nic1" } ] },
  }
}

新しい仮想マシンスケールセットを作成する際のユーザーデータの追加

REST API を使用して、仮想マシンスケールセットの作成時に PUT 要求と共に "virtualMachineProfile" セクションに "UserData" を追加します。

{
  "location": "West US",
  "sku": {
    "name": "Standard_A1",
    "capacity": 1
  },
  "properties": {
    "upgradePolicy": {
      "mode": "Automatic"
    },
    "virtualMachineProfile": {
      "userData": "VXNlckRhdGE=",
      "osProfile": {
        "computerNamePrefix": "TestVM",
        "adminUsername": "TestUserName",
        "windowsConfiguration": {
          "provisionVMAgent": true,
          "timeZone": "Dateline Standard Time"
        }
      },
      "storageProfile": {
        "osDisk": {
          "createOption": "FromImage",
          "caching": "ReadOnly"
        },
        "imageReference": {
          "publisher": "publisher",
          "offer": "offer",
          "sku": "sku",
          "version": "1.2.3"
        }
      },
      "networkProfile": {"networkInterfaceConfigurations":[{"name":"nicconfig1","properties":{"ipConfigurations":[{"name":"ip1","properties":{"subnet":{"id":"vmssSubnet0"}}}]}}]},
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": true,
          "storageUri": "https://crputest.blob.core.windows.net"
        }
      }
    },
    "provisioningState": 0,
    "overprovision": false,
    "uniqueId": "00000000-0000-0000-0000-000000000000"
  }
}

ユーザーデータの取得

VM 内で実行されているアプリケーションは、IMDS エンドポイントからユーザーデータを取得できます。詳細については、こちらの IMDS サンプルコードを参照してください。

お客様は、$expand=userData エンドポイントを使用して REST API を介してユーザーデータの既存の値を取得できます (要求本文は空のままでもかまいません)。

単一 VM:

GET "/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/virtualMachines/{VMName}?$expand=userData"

仮想マシンスケールセット:

GET "/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/virtualMachineScaleSets/{VMSSName}?$expand=userData"

仮想マシンスケールセット VM:

GET "/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/virtualMachineScaleSets/{VMSSName}/virtualmachines/{vmss instance id}?$expand=userData"

ユーザーデータの更新

REST API を使用すると、通常の PUT または PATCH 要求を使用してユーザーデータを更新できます。ユーザーデータは、VM を停止または再起動しなくても更新されます。

PUT "/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/ virtualMachines/{VMName}

PATCH "/subscriptions/{guid}/resourceGroups/{RGName}/providers/Microsoft.Compute/ virtualMachines/{VMName}

これらの要求の VM.Properties には、次のように目的の UserData フィールドが含まれている必要があります。

"properties": {
        "hardwareProfile": {
          "vmSize": "Standard_D1_v2"
        },
        "storageProfile": {
          "imageReference": {
            "sku": "2016-Datacenter",
            "publisher": "MicrosoftWindowsServer",
            "version": "latest",
            "offer": "WindowsServer"
          },
          "osDisk": {
            "caching": "ReadWrite",
            "managedDisk": {
              "storageAccountType": "StandardSSD_LRS"
            },
            "name": "vmOSdisk",
            "createOption": "FromImage"
          }
        },
        "networkProfile": {
          "networkInterfaces": [
            {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}",
              "properties": {
                "primary": true
              }
            }
          ]
        },
        "osProfile": {
          "adminUsername": "{your-username}",
          "computerName": "{vm-name}",
          "adminPassword": "{your-password}"
        },
        "diagnosticsProfile": {
          "bootDiagnostics": {
            "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net",
            "enabled": true
          }
        },
        "userData": "U29tZSBDdXN0b20gRGF0YQ=="
      }

Note

この場合に "userData" に空の文字列を渡すと、ユーザーデータは削除されます。

ユーザーデータとカスタムデータ

カスタムデータは、現在と同じように引き続き機能します。 IMDS からカスタムデータを取得できないことに注意してください。

既存の VM へのユーザーデータの追加

既存の VM または VMSS にユーザーデータがない場合でも、「ユーザーデータの更新」セクションで説明されているように、更新コマンドを使用して、この VM にユーザーデータを追加できます。必ず最新バージョンの Azure Resource Manager API にアップグレードしてください。

次のステップ

Azure Instance Metadata Service を試し、そのエンドポイントから VM インスタンスのメタデータとユーザーデータを取得する方法について確認します。

Azure 仮想マシンのユーザー データ

"ユーザー データ" とは

Azure VM または VMSS のユーザー データを作成する

ユーザー データの取得

ユーザー データの更新

ユーザー データとカスタム データ

既存の VM へのユーザー データの追加