Bicep での Azure Resource Manager テンプレートスペック (プレビュー)

[アーティクル]
12/06/2024

テンプレートスペックは、後でデプロイするために Azure Resource Manager テンプレート (ARM テンプレート) を格納するためのリソースの種類です。このリソースの種類を使用すると、ARM テンプレートを組織内の他のユーザーと共有できます。他の Azure リソースとまったく同様に、Azure ロールベースのアクセス制御 (Azure RBAC) を使用してテンプレートスペックを共有できます。Bicep ファイルを提供することで、Azure CLI または Azure PowerShell を使用してテンプレートスペックを作成できます。 Bicep ファイルは、格納される前に ARM JSON テンプレートに変換されます。現在のところ、Azure portal から Bicep ファイルをインポートしてテンプレートスペックリソースを作成することはできません。

Microsoft.Resources/templateSpecs は、テンプレートスペックのリソースの種類です。これは、メインテンプレートと、リンクされた任意の数のテンプレートで構成されます。 Azure によって、テンプレートスペックはリソースグループに安全に格納されます。メインテンプレートとリンクされたテンプレートのどちらも JSON である必要があります。 Template Specs では、バージョン管理がサポートされています。

テンプレートスペックをデプロイするには、PowerShell、Azure CLI、Azure portal、REST およびその他のサポートされている SDK およびクライアントなど、標準の Azure ツールを使用します。テンプレートまたは Bicep ファイルの場合と同じコマンドを使用します。

Note

Bicep のテンプレートスペックを Azure PowerShell で使用するには、バージョン 6.3.0 以降をインストールする必要があります。 Azure CLI でこれを使用するには、バージョン 2.27.0 以降を使用します。

デプロイを計画するときは常に、リソースのライフサイクルを考慮し、ライフサイクルが同じようなリソースを 1 つのテンプレートスペックにグループ化します。たとえば、デプロイに複数の Azure Cosmos DB インスタンスが含まれ、各インスタンスにそれ自体のデータベースとコンテナーが含まれています。データベースとコンテナーにほとんど変化がないときは、Cosmo DB とその基礎となるデータベースとコンテナーを含めるテンプレート仕様を 1 つ作成します。次に、それらのリソースのインスタンスを複数作成するコピーループと共に、条件付きステートメントを Bicep の中で使用できます。

ヒント

モジュールレジストリとテンプレートスペックの選択は、ほとんど好みの問題です。 2 つから選択するときに考慮すべき点がいくつかあります。

モジュールレジストリは、Bicep でのみサポートされています。 Bicep をまだ使用していない場合は、テンプレートスペックを使用します。
Bicep モジュールレジストリの内容は、別の Bicep ファイルからのみデプロイできます。テンプレートスペックは、API、Azure PowerShell、Azure CLI、および Azure portal から直接デプロイできます。 UiFormDefinition を使用して、ポータルのデプロイエクスペリエンスをカスタマイズすることさえできます。
Bicep には、loadTextContent および loadFileAsBase64 関数を使用して他のプロジェクト成果物 (非 Bicep ファイルや非 ARM テンプレートファイルなど。たとえば、PowerShell スクリプト、CLI スクリプト、その他のバイナリ) を埋め込むための機能がいくつかあります。テンプレートスペックでは、これらのアーティファクトをパッケージ化することはできません。

トレーニングリソース

テンプレートスペックの詳細とハンズオンガイダンスについては、「再利用可能なインフラストラクチャコードのライブラリをテンプレートスペックを使用して発行する」を参照してください。

必要なアクセス許可

テンプレートスペック用に次の 2 つの Azure 組み込みロールが定義されています。

さらに、Bicep ファイルをデプロイするためのアクセス許可も必要です。 CLI のデプロイに関するページまたは PowerShell のデプロイに関するページを参照してください。

テンプレートスペックを使用する理由は何ですか。

テンプレートスペックには、次のような利点があります。

テンプレートスペック用に標準 ARM テンプレートまたは Bicep ファイルを使用する。
SAS トークンではなく、Azure RBAC を使用してアクセスを管理する。
ユーザーは、Bicep ファイルへの書き込みアクセス権がなくてもテンプレートスペックをデプロイできる。
テンプレートスペックは、PowerShell スクリプトや DevOps パイプラインなどの既存のデプロイプロセスに統合できる。

テンプレートスペックを使用すると、正規のテンプレートを作成し、それらを組織内のチームと共有できます。テンプレートスペックは、デプロイのために Azure Resource Manager で使用できますが、正しいアクセス許可がないユーザーはアクセスできないため、安全です。ユーザーがテンプレートをデプロイするのに必要なのは、そのテンプレートスペックへの読み取りアクセス権のみです。そのため、他のユーザーに変更を許可することなくテンプレートを共有できます。

現在、GitHub リポジトリまたはストレージアカウントにテンプレートがある場合に、テンプレートを共有して使用しようとすると、いくつかの問題が発生します。テンプレートをデプロイするには、テンプレートへのパブリックアクセスを許可するか、SAS トークンを使用してアクセスを管理する必要があります。この制限に対処するために、ユーザーはローカルコピーを作成する場合があります。これは、最終的に元のテンプレートとは異なったものになります。テンプレートスペックにより、テンプレートの共有が簡単になります。

テンプレートスペックに含まれるテンプレートは、組織の要件とガイダンスに従うように組織の管理者が検証する必要があります。

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

次の例は、Azure でストレージアカウントを作成するための簡単な Bicep ファイルを示しています。

@allowed([
  'Standard_LRS'
  'Standard_GRS'
  'Standard_ZRS'
  'Premium_LRS'
])
param storageAccountType string = 'Standard_LRS'

resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name:  'store${uniqueString(resourceGroup().id)}'
  location: resourceGroup().location
  sku: {
    name: storageAccountType
  }
  kind:'StorageV2'
}

テンプレートスペックを作成するには、次のコマンドを使用します。

PowerShell
CLI

New-AzTemplateSpec -Name storageSpec -Version 1.0a -ResourceGroupName templateSpecsRg -Location westus2 -TemplateFile ./mainTemplate.bicep

az ts create \
  --name storageSpec \
  --version "1.0a" \
  --resource-group templateSpecRG \
  --location "westus2" \
  --template-file "./mainTemplate.bicep"

また、Bicep ファイルを使用して、テンプレートスペックを作成することもできます。ただし、mainTemplate の内容は JSON である必要があります。次のテンプレートによって、ストレージアカウントを配置するテンプレートスペックが作成されます。

param templateSpecName string = 'CreateStorageAccount'
param templateSpecVersionName string = '0.1'
param location string = resourceGroup().location

resource createTemplateSpec 'Microsoft.Resources/templateSpecs@2022-02-01' = {
  name: templateSpecName
  location: location
  properties: {
    description: 'A basic templateSpec - creates a storage account.'
    displayName: 'Storage account (Standard_LRS)'
  }
}

resource createTemplateSpecVersion 'Microsoft.Resources/templateSpecs/versions@2022-02-01' = {
  parent: createTemplateSpec
  name: templateSpecVersionName
  location: location
  properties: {
    mainTemplate: {
      '$schema': 'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#'
      'contentVersion': '1.0.0.0'
      'parameters': {
        'storageAccountType': {
          'type': 'string'
          'defaultValue': 'Standard_LRS'
          'allowedValues': [
            'Standard_LRS'
            'Standard_GRS'
            'Standard_ZRS'
            'Premium_LRS'
          ]
        }
      }
      'resources': [
        {
          'type': 'Microsoft.Storage/storageAccounts'
          'apiVersion': '2023-04-01'
          'name': 'store$uniquestring(resourceGroup().id)'
          'location': resourceGroup().location
          'kind': 'StorageV2'
          'sku': {
            'name': '[parameters(\'storageAccountType\')]'
          }
        }
      ]
    }
  }
}

Bicep ファイルに埋め込まれた JSON テンプレートでは、次の変更を行う必要があります。

行の末尾にあるコンマを削除する。
二重引用符を単一引用符に置き換える。
式内の一重引用符をエスケープします。たとえば、'name': '[parameters(\'storageAccountType\')]' です。
Bicep ファイルで定義されているパラメーターと変数にアクセスするには、パラメーター名と変数名を直接使用できます。 mainTemplate で定義されているパラメーターと変数にアクセスするには、ARM JSON テンプレートの構文を引き続き使用する必要があります。たとえば、'name': '[parameters(\'storageAccountType\')]' です。
Bicep 関数を呼び出す場合は、Bicep 構文を使用します。たとえば、'location': resourceGroup().location などです。

テンプレートスペックのサイズは、およそ 2 MB に制限されています。テンプレートスペックのサイズが制限を超えると、TemplateSpecTooLarge エラーコードを受け取ります。次のような内容のエラーメッセージです。

The size of the template spec content exceeds the maximum limit. For large template specs with many artifacts, the recommended course of action is to split it into multiple template specs and reference them modularly via TemplateLinks.

サブスクリプション内のすべてのテンプレートスペックを表示するには、次のコマンドを使用します。

PowerShell
CLI

Get-AzTemplateSpec

az ts list

テンプレートスペックの詳細 (そのバージョンを含む) を表示するには、次のコマンドを使用します。

PowerShell
CLI

Get-AzTemplateSpec -ResourceGroupName templateSpecsRG -Name storageSpec

az ts show \
    --name storageSpec \
    --resource-group templateSpecRG \
    --version "1.0a"

テンプレートスペックをデプロイする

テンプレートスペックを作成した後、テンプレートスペック閲覧者ロールを持つユーザーは、そのテンプレートスペックをデプロイできます。さらに、ARM テンプレートをデプロイするためのアクセス許可も必要です。 CLI のデプロイに関するページまたは PowerShell のデプロイに関するページを参照してください。

テンプレートスペックは、ポータル、PowerShell、Azure CLI を通じて、または大規模なテンプレートのデプロイ内の Bicep モジュールとしてデプロイできます。組織内のユーザーは、Azure 内の任意のスコープ (リソースグループ、サブスクリプション、管理グループ、またはテナント) にテンプレートスペックをデプロイできます。

Bicep ファイルのパスまたは URI を渡す代わりに、リソース ID を指定してテンプレートスペックをデプロイします。リソース ID の形式は次のとおりです。

/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Resources/templateSpecs/{template-spec-name}/versions/{template-spec-version}

リソース ID にテンプレートスペックのバージョン名が含まれていることに注目してください。

たとえば、次のコマンドを使用してテンプレートスペックをデプロイします。

PowerShell
CLI

$id = "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/templateSpecsRG/providers/Microsoft.Resources/templateSpecs/storageSpec/versions/1.0a"

New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName demoRG

id = "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/templateSpecsRG/providers/Microsoft.Resources/templateSpecs/storageSpec/versions/1.0a"

az deployment group create \
  --resource-group demoRG \
  --template-spec $id

実際には、通常は Get-AzTemplateSpec または az ts show を実行して、デプロイするテンプレートスペックの ID を取得します。

PowerShell
CLI

$id = (Get-AzTemplateSpec -Name storageSpec -ResourceGroupName templateSpecsRg -Version 1.0a).Versions.Id

New-AzResourceGroupDeployment `
  -ResourceGroupName demoRG `
  -TemplateSpecId $id

id = $(az ts show --name storageSpec --resource-group templateSpecRG --version "1.0a" --query "id")

az deployment group create \
  --resource-group demoRG \
  --template-spec $id

また、次の形式で URL を開いて、テンプレート仕様をデプロイすることもできます。

https://portal.azure.com/#create/Microsoft.Template/templateSpecVersionId/%2fsubscriptions%2f{subscription-id}%2fresourceGroups%2f{resource-group-name}%2fproviders%2fMicrosoft.Resources%2ftemplateSpecs%2f{template-spec-name}%2fversions%2f{template-spec-version}

パラメーター

テンプレートスペックにパラメーターを渡すことは、Bicep ファイルにパラメーターを渡すことと似ています。パラメーターの値は、インラインで、またはパラメーターファイルに追加します。

インラインパラメーター

パラメーターをインラインで渡すには、以下を使用します。

PowerShell
CLI

New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName demoRG `
  -StorageAccountType Standard_GRS

az deployment group create \
  --resource-group demoRG \
  --template-spec $id \
  --parameters storageAccountType='Standard_GRS'

パラメータファイル

Bicep パラメーターファイルを使う

Bicep パラメーターファイルを作成するには、using ステートメントを指定する必要があります。次に例を示します。
```
using 'using 'ts:<subscription-id>/<resource-group-name>/<template-spec-name>:<tag>'

param StorageAccountType = 'Standard_GRS'
```
詳細については、「Bicep パラメーターファイル」を参照してください。

パラメーターファイルを渡すには:
- PowerShell
- CLI
現在、Azure PowerShell を使って .bicepparam ファイルでテンプレートスペックをデプロイすることはできません。
```
az deployment group create \
  --resource-group demoRG \
  --parameters "./mainTemplate.bicepparam"
```
原因は、bicepparam ファイル内の using ステートメントです。 --template-spec パラメーターを指定する必要はありません。

JSON パラメーターファイルを使う

次の JSON は、JSON パラメーターファイルのサンプルです。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "StorageAccountType": {
      "value": "Standard_GRS"
    }
  }
}

また、そのパラメーターファイルを以下を使用して渡します:

PowerShell
CLI

New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName demoRG `
  -TemplateParameterFile ./mainTemplate.parameters.json

az deployment group create \
  --resource-group demoRG \
  --template-spec $id \
  --parameters "./mainTemplate.parameters.json"

バージョン管理

テンプレートスペックを作成するときは、そのバージョン名を指定します。テンプレートコードを反復処理するときは、既存のバージョンを更新する (修正プログラムの場合) か、または新しいバージョンを発行することができます。バージョンはテキスト文字列です。セマンティックバージョン管理など、任意のバージョン管理システムに従うことを選択できます。テンプレートスペックのユーザーは、デプロイ時に使用するバージョン名を指定できます。制限のない数のバージョンを持つことができます。

タグを使用する

タグは、リソースを論理的に整理するために役立ちます。 Azure PowerShell と Azure CLI を使用して、テンプレートスペックにタグを追加できます。次の例は、テンプレートスペックを作成するときにタグを指定する方法を示しています。

PowerShell
CLI

New-AzTemplateSpec `
  -Name storageSpec `
  -Version 1.0a `
  -ResourceGroupName templateSpecsRg `
  -Location westus2 `
  -TemplateFile ./mainTemplate.bicep `
  -Tag @{Dept="Finance";Environment="Production"}

az ts create \
  --name storageSpec \
  --version "1.0a" \
  --resource-group templateSpecRG \
  --location "westus2" \
  --template-file "./mainTemplate.bicep" \
  --tags Dept=Finance Environment=Production

次の例では、既存のテンプレートスペックを更新するときにタグを適用する方法を示します。

PowerShell
CLI

Set-AzTemplateSpec `
  -Name storageSpec `
  -Version 1.0a `
  -ResourceGroupName templateSpecsRg `
  -Location westus2 `
  -TemplateFile ./mainTemplate.bicep `
  -Tag @{Dept="Finance";Environment="Production"}

az ts update \
  --name storageSpec \
  --version "1.0a" \
  --resource-group templateSpecRG \
  --location "westus2" \
  --template-file "./mainTemplate.bicep" \
  --tags Dept=Finance Environment=Production

テンプレートとそのバージョンの両方にタグを付けることができます。タグは、指定したパラメーターに応じて適用または継承されます。

テンプレートスペック	Version	バージョンパラメーター	タグパラメーター	タグ値
Exists	該当なし	指定なし	指定済み	テンプレートスペックに適用される
Exists	新規	指定済み	指定なし	テンプレートスペックからバージョンに継承される
新規	新規	指定済み	指定済み	テンプレートスペックとバージョンの両方に適用される
Exists	新規	指定済み	指定済み	バージョンに適用される
Exists	Exists	指定済み	指定済み	バージョンに適用される

テンプレートスペックへのリンク

テンプレートスペックを作成した後、Bicep モジュール内のそのテンプレートスペックにリンクできます。テンプレートスペックは、そのモジュールを含む Bicep ファイルをデプロイするときにデプロイされます。詳細については、テンプレートスペック内のファイルに関するページをご覧ください。

モジュールのリンクを目的としたテンプレートスペックの別名を作成するには、「モジュールの別名」を参照してください。

次の方法で共有

Bicep での Azure Resource Manager テンプレートスペック (プレビュー)

トレーニングリソース

必要なアクセス許可

テンプレートスペックを使用する理由は何ですか。

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

テンプレートスペックをデプロイする

パラメーター

インラインパラメーター

パラメータファイル

バージョン管理

タグを使用する

テンプレートスペックへのリンク

次のステップ

フィードバック

その他のリソース

次の方法で共有

Bicep での Azure Resource Manager テンプレート スペック (プレビュー)

トレーニング リソース

必要なアクセス許可

テンプレート スペックを使用する理由は何ですか。

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

テンプレート スペックをデプロイする

パラメーター

インライン パラメーター

パラメータ ファイル

バージョン管理

タグを使用する

テンプレート スペックへのリンク

次のステップ

フィードバック

その他のリソース

Bicep での Azure Resource Manager テンプレートスペック (プレビュー)

トレーニングリソース

テンプレートスペックを使用する理由は何ですか。

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

テンプレートスペックをデプロイする

インラインパラメーター

パラメータファイル

テンプレートスペックへのリンク