テンプレート スペックを作成、発行する

"リンクされたテンプレート" を使用することもできます。これにより、デプロイの一部を別個のファイルに定義することができます。 作業対象のテンプレート スペックに、リンクされたテンプレートを埋め込んでメイン テンプレートから参照することができます。

テンプレート、特にそのパラメーターは、組織内のすべてのユーザーにとってわかりやすく、そして使いやすいものであることが大切です。 明確でわかりやすいパラメーター名を使用してください。 パラメーターの内容として想定される値についての情報は、パラメーターのプロパティとテンプレートのメタデータを使用して指定します。その例を次に示します。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "environmentType": {
      "type": "string",
      "allowedValues": [
        "Production",
        "NonProduction"
      ],
      "metadata": {
        "description": "The type of the environment to deploy. This will determine the SKUs and cost of the resources."
      }
    },
    "key": {
      "type": "secureString",
      "metadata": {
        "description": "The secret key to use."
      }
    },
    "location": {
      "type": "string",
      "metadata": {
        "description": "The Azure region into which the resources should be deployed."
      }
    },
    "sqlServerCount": {
      "type": "int",
      "maxValue": 5,
      "metadata": {
        "description": "The number of Azure SQL logical servers to create."
      }
    }
  },
  "resources": []
}

この例では、テンプレート パラメーターに allowedValues、maxValue、description の各プロパティが使用されていて、各パラメーターの目的と、その設定値の効果が明確に示されています。 また、テンプレートには secureString 型が含まれていて、key パラメーターにはシークレット データが格納されることがわかります。

テンプレート、特にそのパラメーターは、組織内のすべてのユーザーにとってわかりやすく、そして使いやすいものであることが大切です。 明確でわかりやすいパラメーター名を使用してください。 パラメーターの内容として想定される値についての情報は、パラメーターのデコレーターを使用して指定します。その例を次に示します。

@description('The type of the environment to deploy. This will determine the SKUs and cost of the resources.')
@allowed([
  'Production'
  'NonProduction'
])
param environmentType string

@secure()
@description('The secret key to use.')
param key string

@description('The Azure region into which the resources should be deployed.')
param location string

@description('The number of Azure SQL logical servers to create.')
@maxValue(5)
param sqlServerCount int

この例では、テンプレートのパラメーターに @allowed、@maxValue、@description の各デコレーターが使用されていて、各パラメーターの目的と、その設定値の効果が明確に示されています。 また、テンプレートには secure デコレーターが含まれていて、key パラメーターにはシークレット データが格納されることがわかります。

テンプレート スペックを作成するには、New-AzTemplateSpec コマンドレットを使用します。 次に示したのは、ストレージ アカウント テンプレート用のテンプレート スペックを作成する例です。

New-AzTemplateSpec `
  -Name StorageWithoutSAS `
  -Location westus `
  -DisplayName 'Storage account with SAS disabled' `
  -Description 'This template spec creates a storage account, which is preconfigured to disable SAS authentication.' `
  -Version '1.0' `
  -TemplateFile main.bicep

New-AzTemplateSpec `
  -Name StorageWithoutSAS `
  -Location westus `
  -DisplayName 'Storage account with SAS disabled' `
  -Description 'This template spec creates a storage account, which is preconfigured to disable SAS authentication.' `
  -Version '1.0' `
  -TemplateFile azuredeploy.json

各パラメーターを見てみましょう。

• -Name は、テンプレート スペックのリソース名です。スペースを含めることはできません。
• -Location は、テンプレート スペックのメタデータの作成先となる場所です。 ただしテンプレート スペックは、任意のリージョンにデプロイすることができます。
• -DisplayName は、人が判読できる名前です。スペースを含めることができます。
• -Description は、人が判読できる説明です。テンプレート スペックがどのような内容で、どのようなときに使用できるのかについて、詳細な情報を指定することができます。
• -Version はテンプレート スペックのバージョンです。バージョンについては、このモジュールの後半で説明します。
• -TemplateFile は、テンプレート スペックの目的である ARM テンプレートのパスです。

テンプレート スペックを作成するには、az ts create コマンドを使用します。 次に示したのは、ストレージ アカウント テンプレート用のテンプレート スペックを作成する例です。

az ts create \
  --name StorageWithoutSAS \
  --location westus \
  --display-name "Storage account with SAS disabled" \
  --description "This template spec creates a storage account, which is preconfigured to disable SAS authentication." \
  --version 1.0 \
  --template-file main.bicep

az ts create \
  --name StorageWithoutSAS \
  --location westus \
  --display-name "Storage account with SAS disabled" \
  --description "This template spec creates a storage account, which is preconfigured to disable SAS authentication." \
  --version 1.0 \
  --template-file azuredeploy.json

各引数を見てみましょう。

• --name は、テンプレート スペックのリソース名です。スペースを含めることはできません。
• --location は、テンプレート スペックのメタデータの作成先となる場所です。 ただしテンプレート スペックは、任意のリージョンにデプロイすることができます。
• --display-name は、人が判読できる名前です。スペースを含めることができます。
• --description は、人が判読できる説明です。テンプレート スペックがどのような内容で、どのようなときに使用できるのかについて、詳細な情報を指定することができます。
• --version はテンプレート スペックのバージョンです。バージョンについては、このモジュールの後半で説明します。
• --template-file は、テンプレート スペックの目的である ARM テンプレートのパスです。