Azure VM のカスタムデータを Windows で使ってみ隊

Azure VM を作成する際に [カスタムデータ] というパラメータがあります
Linux では cloud-init というキーワードで検索するとたくさん情報が出てきますが、Windows での事例が見つからなかったので試してみました

カスタムデータとは

Microsoft 公式から引用します

カスタムデータは、“プロビジョニング” と呼ばれる最初のスタートアップ時またはセットアップ時に、VM で使用できるようになります。プロビジョニングとは、VM の作成パラメーター (ホスト名、ユーザー名、パスワード、証明書、カスタムデータ、キーなど) を VM で使用できるようにするプロセスです。

ゲスト OS の自動化で利用することができる機能の1つです

利用するときは Base64 でエンコードが必要だそうです

カスタムデータを使用するには、変換を実行する CLI ツール (Azure CLI など) を使用していない限り、データを API に渡す前に、コンテンツを Base64 でエンコードする必要があります。

カスタムデータと Azure 仮想マシン - Azure Virtual Machines | Microsoft Learn

なお、Azure VM の自動化関連は下記にまとまっています
インフラストラクチャ自動化ツールを使用する - Azure Virtual Machines | Microsoft Learn

Windows での使い方

Base64 でエンコードすることに加えて、Windows では下記の記載があります

カスタムデータは、バイナリファイルとして %SYSTEMDRIVE%\AzureData\CustomData.bin に配置されますが、処理されません。このファイルを処理する場合は、カスタムイメージをビルドし、CustomData.bin を処理するコードを記述する必要があります。

カスタムデータと Azure 仮想マシン - Azure Virtual Machines | Microsoft Learn

ここまでの情報を踏まえて、Windows での使い方を試してみました

ざっくり手順

カスタムデータを Base64 でエンコード
カスタムデータを利用できるイメージを作成
エンコードしたファイルを VM 作成時に指定
VM にログインし、カスタムデータが正しく処理されているか確認

1. カスタムデータを Base64 でエンコード

カスタムデータとして VM に渡す処理を Base64 にエンコードしたテキストを作成します
今回はファイルを作成するだけのシンプルな例を示します

エンコード前のスクリプトは下記になります

1

Out-File -FilePath "C:\Temp\output.txt" -InputObject "Hello, World!" -Encoding utf8

DevToys を使って Base64 にエンコードします
結果は下記のようになります

T3V0LUZpbGUgLUZpbGVQYXRoICJDOlxUZW1wXG91dHB1dC50eHQiIC1JbnB1dE9iamVjdCAiSGVsbG8sIFdvcmxkISIgLUVuY29kaW5nIHV0Zjg=

2. カスタムデータを利用できるイメージを作成

処理の流れは以下の通りです

flowchart TD
    A[Windows にログイン] --> B["バッチファイル(ProcessCustomData.bat)を実行"]
    B --> C["PowerShell スクリプト(ProcessCustomData.ps1)を実行"]
    C --> D[カスタムデータをデコードし、実行]

イメージ作成用の Windows VM を作成し、下記のスクリプトを実行し必要なファイルを作成します

1
2
3
4
5
6
7
8
9


# ファイルのパスを指定
$path = "$env:ProgramData\Microsoft\Windows\Start Menu\Programs\StartUp\ProcessCustomData.bat"

# ファイルの内容を指定
$content = '@echo off
PowerShell -ExecutionPolicy Bypass -File "C:\Users\Public\Documents\ProcessCustomData.ps1"'

# ファイルに内容を書き込み
Set-Content -Path $path -Value $content

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


# ファイルのパスを指定
$path = "C:\Users\Public\Documents\ProcessCustomData.ps1"

# ファイルの内容を指定
$content = '# CustomData.bin のパス
$customDataPath = "C:\AzureData\CustomData.bin"

# CustomData.bin を読み込み、Base64 からデコード
$customData = Get-Content -Path $customDataPath -Raw
$decodedData = [System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String($customData))

# デコードされたデータをスクリプトとして実行
Invoke-Expression $decodedData'

# ファイルに内容を書き込み
Set-Content -Path $path -Value $content