🔥

Azure Bicep に bicepparamファイル爆誕

Junpei Tsuchida（07JP27）

2023/06/13に公開

Azure

Bicep

tech

TL;DR
Bicep 0.18.4から .bicepparamという拡張子のファイルでパラメーターファイルがサポートされました。
この記事はBicepのGitHubリポジトリのリリース情報を元に執筆しています。

はじめに - いままでの課題 -

Azure純正のInfrasturcture as Code(IaC)ツールであるBicepは、Azure Resource Manager(ARM)テンプレートをより簡潔に記述できるようにするために開発されました。
Bicepの登場により、JSON形式で記述する必要があったARMテンプレートの問題がいくつか解消されました。

Bicepの特徴

プログラミング言語ライクで、より人間にわかりやすい記述に
モジュールを使用したリソース再利用性の向上
コードにコメントが書ける！（ARMテンプレートはJSON形式なのでコメントが書けなかった）

しかし、BicepによりAzureのIaCは大きく進化しましたが、Bicepで定義したテンプレートに与える変数のパラメーターファイルの記述にはJSON形式を使用する必要がありました。

.bicepparamファイルの登場

この度、現地時間の2023年6月12日にリリースされたBicep 0.18.4から .bicepparamという拡張子のファイルでパラメーターファイルを作成できる機能が正式サポートされました！
これにより、Bicepで定義したテンプレートに与える変数のパラメーターファイルの記述にJSON形式を使用する必要がなくなりました。

.bicepparamファイルの特徴

簡潔な記述方式
コメントが書ける！
テンプレートファイルに対するコード補完(厳密にはVS CodeのBicep拡張機能の機能)

やってみる

準備

前述の通りBicepのバージョンが0.18.4以上である必要があります。古いバージョンの場合はaz bicep updateでアップデートしてください。真っさらな状態から新規インストールする方はこちらを参考にしてください。
Bicepファイルを記述するために、IDEとして、VS Code、さらにBicep拡張機能をインストールします。これはBicep開発のデファクトスタンダートとなっています。Bicep拡張機能もv0.18.4から.bicepparamファイルのサポートがされています。

適当にBicepファイルを作る

適当にこんな感じのストレージを１個デプロイするためのBicepファイルを作ります。

@minLength(3)
@maxLength(13)
@description('The storage name will be {this value}storage1128')
param storageNamePrefix string

param location string = resourceGroup().location

var storageName = '${storageNamePrefix}storage1128'

resource exampleStorage 'Microsoft.Storage/storageAccounts@2021-06-01' = {
    name: storageName
    location: location
    sku: {
        name: 'Standard_LRS'
    }
    kind: 'StorageV2'
}

(zennさんbicepのコードハイライト実装もお願いします・・・！)

.bicepparamファイルを作る

ここからが本題です。
param.bicepparamというファイルを作成します。（拡張子があってれば名前はなんでもOK）
.bicepparamファイルの先頭に、このパラメーターファイルがどのBicepファイルに対応しているかをusingで記述します。

ではパラメーターを記述していきます。具体的にはparamキーワードを使ってパラメーターを定義します。

特徴として前述した

簡潔な記述方式
テンプレートファイルに対するコード補完

が分かると思います。特に後者はusingによって使用するテンプレート(Bicep)ファイルを指定することにより、パラメーターファイルとテンプレートファイルを紐づけし、パラメータ名などを補完します。

ちなみに同じ内容のJSON形式と.bicepparam形式のパラメーターファイルを比較するとこんな感じです。文量が大幅に減り、可読性も向上しているのが分かると思います。

デプロイしてみる。

az cliからのデプロイは今までとほぼ変わりません。parametersの引数に.bicepparamファイルを指定するだけです。
az deployment group create -g BicepRG --template-file exercise1.bicep --parameters param.bicepparam

しばらくして、無事に設定した値とリージョンでストレージがデプロイされました。