Azure Portal を使って ARMテンプレートのデプロイをする際に KeyVaultのシークレットを参照する

Last updated at 2024-11-09Posted at 2023-08-22

はじめに

Azure Portal から、AVDをデプロイする際に、数多くの入力項目があるのですが、その際にドメイン管理者のパスワードやVM管理者のパスワードを手入力する必要があります。
そこで入力ミスがあると、時間を掛けてデプロイを待ったのに、パスワード入力ミスで失敗した・・・という事がありえます。

パラメータファイルに固定値のパスワードを記載すれば簡単なのですが、デプロイを運用者の人にやってもらうようなシチュエーションを考えると、セキュリティ的に問題があります。
そんなこともあって、KeyVault からパスワードを読み込ませる事を考えました。

私は、AVDで試していますが、VMを ARMテンプレートでデプロイする際にパスワードを読み込ませたいというシチュエーションの人にも応用していただけると思います。

本記事を参照いただく前に・・・

本記事を参照頂く前に、以下の記事を参照ください。

編集する元となるオリジナルの ARM テンプレートの入手方法や、本記事の内容を元にカスタマイズした結果の ARM テンプレートの内容まで記載されています。

ハマった点

公開情報を調べてみると、以下の記事が見つかります。
この通りにやれば良さそうに思うのですが、落とし穴がありました。

ここに書かれている内容は、Parameters.json に Reference関数を記載して KeyVaultのシークレットを参照する記載をする方法が説明されています。
しかし、これは Azure PowerShell や Azure CLI からコマンドを使ってデプロイする時にしか機能しないことが判りました。
Microsoftのサポートにも問合せをして確認済みです。

サポート回答より
Portal ではパスワードの入力が必須という条件で実装されており、Azure ポータルでデプロイを試みる場合、シークレットからパスワードを取得しているもののそれをそのまま受け入れる実装がございません。
そのため、シークレットからパスワードを取得するパラメーターをアップロード後、”保存” した後にパラメーターが戻され、パスワードが Null に設定される動作となります。

私の場合は、Azure Portal で「カスタムテンプレートデプロイ」の画面にパラメータを表示させて、手動で可変の値を変更したのちに「確認と作成」ボタンを押してデプロイさせたい訳です。
なので、この方法は使えません。

ARMテンプレートの概要（参考）

テンプレートファイル（Template.json）

Template.json は、以下で紹介されているセクションがあります。
ARMテンプレートをカスタマイズするには、まずこれを知っておく必要があります。
私の記事を理解いただくには、以下に記載した「パラメータ」と「リソース」だけ覚えておいてください。

パラメータ（parameters）
　項目名を用意して、初期値や選択肢の一覧を指定します。
変数（variables）
ユーザー定義関数（functions）
リソース（resources）
　パラメータや変数を参照して、記述された Azureリソースをデプロイします。
出力（outputs）

パラメータファイル（Parameters.json）

テンプレートファイルには、複数のセクションがありますが、パラメータファイルには Parameters セクションしかありません。
考え方としては、Template.json は固定で使い、可変となる値だけ Parameters.json に記載してデプロイの際に組み合わせて使用する設計となっているようです。

KeyVaultのシークレットを参照させるために考えたこと

結論としては、パラメータファイルや、テンプレートファイルの Parameters セクションに Reference関数で KeyVaultから値を参照しても引き渡すことができませんでした。
これは、MSサポートから案内があった通り、セキュリティ情報を Portal画面にテキストで表示させないための実装があるからです。

解決策としては、Reference関数を Resources セクションに書いてしまうということです。

Parameters セクションに記載された値は Portal の「カスタムテンプレートのデプロイ」で表示させる際に Null 値になってしまいますが、Resources セクションは「確認と作成」ボタンを押したあとのデプロイ時に処理されるセクションであり、画面表示を介さないためシークレット値を読み込ませるができるのです。

補足説明

パラメータファイルを使うとシークレット値を失う

以下の図のイメージで、パラメータファイルがシークレットを読み込みますが、Azure Portal 画面でテンプレートに引き渡される際に、Null 値になってしまいます。

ヒラメキ💡：インラインパラメータで渡す

Resources セクションに記載して解決する方法は、以下の公開情報を読んでいた際に思いつきました。
公開情報の説明はテンプレートを入れ子で処理するやり方で本件とは直接関係が無いのですが、赤枠の部分をよく見ると、パラメータファイルではなくインラインパラメータで KeyVaultからシークレットを渡しています。コレならイケるのかもとヒラメキが起こりました！

インラインパラメータで引き渡すための記述方法

ポイント１（Parameters セクションに追加）

Parameters セクションでは、以下のように "mykeyvault" という自分用の変数項目を新設して、その項目の DefaultValue に、KeyVault のリソース ID を示す文字列を記載しておきます。
"[resourceId('AVD-Environment','Microsoft.KeyVault/vaults','avd-deploy2')]"

        "myKeyvault": {
            "type": "string",
            "metadata": {
                "description": "管理者パスワード（キーボルトのシークレット）を登録した キーボルトのリソースID"
            },
            "defaultValue": "[resourceId('AVD-Environment','Microsoft.KeyVault/vaults','avd-deploy2')]"
        },

上記のように Parameters セクションに記載されていると、テンプレートのデプロイ画面では、以下のように表示されるようになります。

ポイント２（Resources セクションを編集）

Before
編集前のオリジナルのテンプレートの内容です。この箇所を見つけてください。
シンプルに、パラメーターで入力された値をそのまま引き渡しています。

        "parameters": {
            "vmAdministratorAccountUsername": {
                "value": "[parameters('vmAdministratorAccountUsername')]"
            },
            "vmAdministratorAccountPassword": {
                "value": "[parameters('vmAdministratorAccountPassword')]"
                }
            },
            "administratorAccountUsername": {
                "value": "[parameters('administratorAccountUsername')]"
            },
            "administratorAccountPassword": {
                "value": "[parameters('administratorAccountPassword')]"
            },
        }

After
以下の内容に修正してください。
ここでは、reference 句を使ってキーボルトを参照させています。その際にキーボルトのリソース ID を parameters('mykeyvault') を使って取得しています。
このとき、ポイント１で mykeyvault の変数に保存しておいた文字列が使用されます。

        "parameters": {
            "vmAdministratorAccountUsername": {
                "value": "[parameters('vmAdministratorAccountUsername')]"
            },
            "vmAdministratorAccountPassword": {
                "reference": {
                    "keyVault": {
                        "id": "[parameters('myKeyvault')]"
                    },
                    "secretName": "vmAdminPassword"
                }
            },
            "administratorAccountUsername": {
                "value": "[parameters('administratorAccountUsername')]"
            },
            "administratorAccountPassword": {
                "reference": {
                    "keyVault": {
                        "id": "[parameters('myKeyvault')]"
                    },
                    "secretName": "DomainPassword"
                }
            },
        }