Azure Resource Manager テンプレートスペック

[アーティクル]
03/20/2024

テンプレートスペックは、後でデプロイするために Azure に Azure Resource Manager テンプレート (ARM テンプレート) を格納するためのリソースの種類です。このリソースの種類を使用すると、ARM テンプレートを組織内の他のユーザーと共有できます。他の Azure リソースと同じように、Azure ロールベースのアクセス制御 (Azure RBAC) を使用してテンプレートスペックを共有できます。

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

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

Note

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

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

トレーニングリソース

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

ヒント

ARM テンプレートと同じ機能を備え、構文も使いやすいため、Bicep をお勧めします。詳細は、「Bicep での Azure Resource Manager テンプレートの関数」を参照してください。

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

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

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

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

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

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

必要なアクセス許可

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

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

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

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

{
  "$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": "2019-06-01",
      "name": "[concat('store', uniquestring(resourceGroup().id))]",
      "location": "[resourceGroup().location]",
      "kind": "StorageV2",
      "sku": {
        "name": "[parameters('storageAccountType')]"
      }
    }
  ]
}

テンプレートスペックを作成するときは、PowerShell コマンドまたは CLI コマンドにメインテンプレートファイルが渡されます。メインテンプレートがリンクされたテンプレートを参照している場合は、コマンドでそれらのテンプレートが検索されてパッケージ化され、テンプレートスペックが作成されます。詳細については、「リンクされたテンプレートを使用してテンプレートスペックを作成する」を参照してください。

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

PowerShell
CLI

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

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

また、ARM テンプレートを使用して、テンプレートスペックを作成することもできます。次のテンプレートによって、ストレージアカウントを配置するテンプレートスペックが作成されます。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "templateSpecName": {
      "type": "string",
      "defaultValue": "CreateStorageAccount"
    },
    "templateSpecVersionName": {
      "type": "string",
      "defaultValue": "0.1"
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]"
    }
  },
  "resources": [
    {
      "type": "Microsoft.Resources/templateSpecs",
      "apiVersion": "2021-05-01",
      "name": "[parameters('templateSpecName')]",
      "location": "[parameters('location')]",
      "properties": {
        "description": "A basic templateSpec - creates a storage account.",
        "displayName": "Storage account (Standard_LRS)"
      }
    },
    {
      "type": "Microsoft.Resources/templateSpecs/versions",
      "apiVersion": "2021-05-01",
      "name": "[format('{0}/{1}', parameters('templateSpecName'), parameters('templateSpecVersionName'))]",
      "location": "[parameters('location')]",
      "dependsOn": [
        "[resourceId('Microsoft.Resources/templateSpecs', parameters('templateSpecName'))]"
      ],
      "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": "2019-06-01",
              "name": "[concat('store', uniquestring(resourceGroup().id))]",
              "location": "[resourceGroup().location]",
              "kind": "StorageV2",
              "sku": {
                "name": "[parameters('storageAccountType')]"
              }
            }
          ]
        }
      }
    }
  ]
}

テンプレート仕様のサイズは、概算 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 のデプロイに関するページを参照してください。

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

テンプレートのパスまたは 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}

パラメーター

テンプレートスペックにパラメーターを渡すことは、ARM テンプレートにパラメーターを渡すこととまったく同じです。パラメーターの値は、インラインで、またはパラメーターファイルに追加します。

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

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'

ローカルパラメーターファイルを作成するには、以下を使用します。

{
  "$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.json `
  -Tag @{Dept="Finance";Environment="Production"}

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

PowerShell
CLI

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

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

テンプレートスペックを作成または変更するときに、version パラメーターは指定するが、tag/tags パラメーターは指定しない場合:

テンプレートスペックが存在し、タグはあるがバージョンが存在しない場合、新しいバージョンでは既存のテンプレートスペックと同じタグが継承されます。

テンプレートスペックを作成または変更するときに、tag/tags パラメーターと version パラメーターの両方を指定する場合:

テンプレートスペックとバージョンの両方が存在しない場合、新しいテンプレートスペックと新しいバージョンの両方にタグが追加されます。
テンプレートスペックは存在するが、バージョンが存在しない場合、タグは新しいバージョンにのみ追加されます。
テンプレートスペックとバージョンの両方が存在する場合、タグはバージョンにのみ適用されます。

テンプレートを変更するときに、tag/tags パラメーターは指定するが、version パラメーターは指定しない場合、タグはテンプレートスペックにのみ追加されます。

リンクされたテンプレートを使用してテンプレートスペックを作成する

テンプレートスペックのメインテンプレートがリンクされたテンプレートを参照している場合は、PowerShell コマンドと CLI コマンドで、リンクされたテンプレートをローカルドライブから自動的に検索してパッケージ化することができます。テンプレートスペックをホストするために、ストレージアカウントまたはリポジトリを手動で構成する必要はありません。テンプレートスペックリソースにすべて含まれています。

次の例は、メインテンプレートと、リンクされた 2 つのテンプレートで構成されています。この例は、テンプレートの抜粋にすぎません。 relativePath という名前のプロパティを使用して、他のテンプレートにリンクしていることに注目してください。デプロイリソースには、2020-06-01 以降の apiVersion を使用する必要があります。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  ...
  "resources": [
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2020-06-01",
      ...
      "properties": {
        "mode": "Incremental",
        "templateLink": {
          "relativePath": "artifacts/webapp.json"
        }
      }
    },
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2020-06-01",
      ...
      "properties": {
        "mode": "Incremental",
        "templateLink": {
          "relativePath": "artifacts/database.json"
        }
      }
    }
  ],
  "outputs": {}
}

前の例で、テンプレートスペックを作成する PowerShell コマンドまたは CLI コマンドを実行すると、メインテンプレート、Web アプリテンプレート (webapp.json)、およびデータベーステンプレート (database.json) の 3 つのファイルが検索され、テンプレートスペックにパッケージ化されます。

詳細については、リンクされたテンプレートを使用してテンプレートスペックを作成する」を参照してください。

テンプレートスペックをリンクされたテンプレートとしてデプロイする

テンプレートスペックを作成すると、ARM テンプレートや別のテンプレートスペックから簡単に再利用できます。テンプレートにリソース ID を追加して、テンプレートスペックにリンクします。リンクされたテンプレートスペックは、メインテンプレートのデプロイ時に自動的にデプロイされます。この動作により、モジュールテンプレートスペックを開発し、必要に応じて再利用することができます。

たとえば、ネットワークリソースをデプロイするテンプレートスペックと、ストレージリソースをデプロイする別のテンプレートスペックを作成することができます。 ARM テンプレートでは、ネットワークリソースまたはストレージリソースを構成する必要があるときはいつでも、これらの 2 つのテンプレートスペックにリンクします。

次の例は、前の例と似ていますが、ローカルテンプレートにリンクする relativePath プロパティではなく、テンプレートスペックにリンクする id プロパティを使用します。デプロイリソースの API バージョンには 2020-06-01 を使用します。この例では、テンプレートスペックは templateSpecsRG という名前のリソースグループにあります。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  ...
  "resources": [
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2020-06-01",
      "name": "networkingDeployment",
      ...
      "properties": {
        "mode": "Incremental",
        "templateLink": {
          "id": "[resourceId('templateSpecsRG', 'Microsoft.Resources/templateSpecs/versions', 'networkingSpec', '1.0a')]"
        }
      }
    },
    {
      "type": "Microsoft.Resources/deployments",
      "apiVersion": "2020-06-01",
      "name": "storageDeployment",
      ...
      "properties": {
        "mode": "Incremental",
        "templateLink": {
          "id": "[resourceId('templateSpecsRG', 'Microsoft.Resources/templateSpecs/versions', 'storageSpec', '1.0a')]"
        }
      }
    }
  ],
  "outputs": {}
}

テンプレートスペックのリンクの詳細については、「チュートリアル: テンプレートスペックをリンクされたテンプレートとしてデプロイする」を参照してください。

次のステップ

テンプレートスペックを作成してデプロイするには、「クイックスタート: テンプレートスペックの作成とデプロイ」を参照してください。
テンプレートスペックでテンプレートをリンクする方法の詳細については、「チュートリアル: リンクされたテンプレートを使用してテンプレートスペックを作成する」を参照してください。
テンプレートスペックをリンクされたテンプレートとしてデプロイする方法の詳細については、「チュートリアル: テンプレートスペックをリンクされたテンプレートとしてデプロイする」を参照してください。

次の方法で共有

Azure Resource Manager テンプレートスペック

トレーニングリソース

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

必要なアクセス許可

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

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

パラメーター

バージョン管理

タグを使用する

リンクされたテンプレートを使用してテンプレートスペックを作成する

テンプレートスペックをリンクされたテンプレートとしてデプロイする

次のステップ

フィードバック

その他のリソース

次の方法で共有

Azure Resource Manager テンプレート スペック

トレーニング リソース

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

必要なアクセス許可

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

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

パラメーター

バージョン管理

タグを使用する

リンクされたテンプレートを使用してテンプレート スペックを作成する

テンプレート スペックをリンクされたテンプレートとしてデプロイする

次のステップ

フィードバック

その他のリソース

Azure Resource Manager テンプレートスペック

トレーニングリソース

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

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

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

リンクされたテンプレートを使用してテンプレートスペックを作成する

テンプレートスペックをリンクされたテンプレートとしてデプロイする