パラメーター ファイルを使用して値を指定する

前のユニットでは、デプロイの作成時にコマンドラインでパラメーター値を指定しました。 この方法は、Bicep ファイルを作成してテストする場合に適していますが、多数のパラメーターがある場合やデプロイを自動化する必要がある場合にはうまく機能しません。 このユニットでは、パラメーター値を指定するさまざまな方法について説明します。

パラメーター ファイルを作成する

パラメーター ファイル を使用すると、パラメーター値をセットとして簡単に指定できます。 パラメーター ファイル内で、Bicep ファイル内のパラメーターの値を指定します。 パラメーター ファイルは、 .bicepparam ファイル拡張子を持つ Bicep パラメーター ファイルまたはパラメーター値を含む JSON パラメーター ファイルを使用して作成されます。 Bicep テンプレートをデプロイするときに、パラメーター ファイルを指定できます。 JSON パラメーター ファイルは次のようになります。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "appServicePlanInstanceCount": {
      "value": 3
    },
    "appServicePlanSku": {
      "value": {
        "name": "P1v3",
        "tier": "PremiumV3"
      }
    },
    "cosmosDBAccountLocations": {
      "value": [
        {
          "locationName": "australiaeast"
        },
        {
          "locationName": "southcentralus"
        },
        {
          "locationName": "westeurope"
        }
      ]
    }
  }
}

パラメーター ファイルの各部分について詳しく見てみましょう。

• $schema は、このファイルがパラメーター ファイルであることを Azure Resource Manager が理解するのに役立ちます。
• contentVersion は、必要に応じてパラメーター ファイルの大幅な変更を追跡するために使用できるプロパティです。 通常は、既定値の 1.0.0.0 に設定されます。
• parameters セクションには、各パラメーターと使用する値が記載されています。 パラメーター値は、オブジェクトとして指定する必要があります。 オブジェクトには、使用する実際のパラメーター値を定義するという value プロパティがあります。

一般に、環境ごとにパラメーター ファイルを作成します。 パラメーター ファイルの名前に環境名を含めるのが良い方法です。 たとえば、開発環境に main.parameters.dev.json という名前のパラメーター ファイルと、運用環境に 対してmain.parameters.production.json という名前のパラメーター ファイルがあるとします。

デプロイ時にパラメーター ファイルを使用する

az deployment group create \
  --name main \
  --template-file main.bicep \
  --parameters main.parameters.json

New-AzResourceGroupDeployment `
  -Name main `
  -TemplateFile main.bicep `
  -TemplateParameterFile main.parameters.json

パラメーター値をオーバーライドする

ここでは、パラメーター値を指定する 3 つの方法 (既定値、コマンド ライン、パラメーター ファイル) について学習しました。 同じパラメーターでも、異なる値を指定するには、異なる方法を用いるのが一般的です。 あなたは既定値を扱ったときにこの方法を見たことがあります。 パラメーターの既定値を作成した後、コマンドラインを使用して別の値を指定すると、コマンドラインの値が優先されます。 パラメーター ファイルがこの優先順位にどのように適合するかを見てみましょう。

パラメーター ファイルが既定値をオーバーライドし、コマンド ライン パラメーター値がパラメーター ファイルをオーバーライドしていることがわかります。

この方法がどのように機能するか見てみましょう。 次に示すのは、3 つのパラメーターを定義する Bicep ファイルの例です。それぞれに既定値が設定されています。

param ___location string = resourceGroup().___location
param appServicePlanInstanceCount int = 1
param appServicePlanSku object = {
  name: 'F1'
  tier: 'Free'
}

2 つのパラメーターの値をオーバーライドするが、 ___location パラメーターの値を指定しないパラメーター ファイルを見てみましょう。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "appServicePlanInstanceCount": {
      "value": 3
    },
    "appServicePlanSku": {
      "value": {
        "name": "P1v3",
        "tier": "PremiumV3"
      }
    }
  }
}

az deployment group create \
  --name main \
  --template-file main.bicep \
  --parameters main.parameters.json \
               appServicePlanInstanceCount=5

New-AzResourceGroupDeployment `
  -Name main `
  -TemplateFile main.bicep `
  -TemplateParameterFile main.parameters.json `
  -appServicePlanInstanceCount 5

どのような値になるのか見てみましょう。

これらの方法を組み合わせてパラメーター値を指定することで、多くの場所でパラメーター値を重複して指定する必要がなくなりますが、必要な場所では柔軟にオーバーライドできるようになります。