Share via

Azure Stack Hub でのテンプレート検証ツールの使用

  • [アーティクル]

テンプレート検証ツールを使用して Azure Resource Manager のテンプレートをチェックします。 このツールは、テンプレートが Azure Stack Hub にデプロイできる状態になっているかどうかをチェックします。 この検証ツールは Azure Stack Hub ツールの GitHub リポジトリで入手できます。

Note

このツールは、Azure Resource Manager のテンプレートを Azure Stack でサポートされているリソースの種類と API バージョンについて検証します。 ただし、このツールでは、リソースの種類ごとにサポートされているプロパティは検証されません。

概要

テンプレートを検証するには、最初にクラウド機能ファイルを作成してから検証ツールを実行する必要があります。 Azure Stack Hub ツールから、次の PowerShell モジュールを使用します。

  • CloudCapabilities フォルダー内:Az.CloudCapabilities.psm1 を実行すると、Azure Stack Hub クラウド内のサービスとバージョンを表すクラウド機能 JSON ファイルが作成されます。
  • TemplateValidator フォルダー内:Az.TemplateValidator.psm1 を実行すると、クラウド機能 JSON ファイルを使用して、Azure Stack Hub へのデプロイ用テンプレートがテストされます。

クラウド機能ファイルをビルドする

テンプレート検証ツールを使用する前に、Az.CloudCapabilities PowerShell モジュールを実行して JSON ファイルを構築します。

Note

統合システムを更新する場合や、新しいサービスまたは仮想拡張機能を追加する場合は、このモジュールの再実行が必要になります。

  1. Azure Stack Hub への接続があることを確認してください。 これらの手順は Azure Stack Development Kit (ASDK) ホストから実行するか、または、VPN を使用してワークステーションから接続できます。

  2. Az.CloudCapabilities PowerShell モジュールをインポートします。

    Import-Module .\CloudCapabilities\Az.CloudCapabilities.psm1

  3. Get-CloudCapabilities コマンドレットを使用して、サービスのバージョンを取得し、クラウド機能 JSON ファイルを作成します。 -OutputPath を指定しない場合、ファイル AzureCloudCapabilities.json は現在のディレクトリに作成されます。 実際の Azure の場所を使用してください。

Get-AzCloudCapability -Location <your location> -Verbose

テンプレートの検証

次の手順を使用し、Az.TemplateValidator PowerShell モジュールを使用してテンプレートを検証します。 独自のテンプレートを使用するか、Azure Stack Hub クイック スタート テンプレートを使用できます。

  1. Az.TemplateValidator.psm1 PowerShell モジュールをインポートします。

    cd "c:\AzureStack-Tools-az\TemplateValidator"
Import-Module .\Az.TemplateValidator.psm1

  2. テンプレート検証ツールを実行します。

Test-AzTemplate -TemplatePath <path to template.json or template folder> `
-CapabilitiesPath <path to cloudcapabilities.json> `
-Verbose

この検証ツールでは、テンプレート検証の警告やエラーが、PowerShell コンソールに表示され、ソース ディレクトリ内の HTML ファイルに書き込まれます。 以下のスクリーンショットは、検証レポートの例です。

テンプレートの検証レポート

パラメーター

テンプレート検証コマンドレットでは、次のパラメーターがサポートされます。

パラメーター 説明 必須
TemplatePath Azure Resource Manager テンプレートを再帰的に検索するパスを指定します。 はい
TemplatePattern 照合するテンプレート ファイルの名前を指定します。 いいえ
CapabilitiesPath クラウド機能 JSON ファイルへのパスを指定します。 はい
IncludeComputeCapabilities VM サイズや VM 拡張機能などの IaaS リソースの評価が含まれます。 いいえ
IncludeStorageCapabilities SKU の種類などのストレージ リソースの評価が含まれます。 いいえ
Report 生成される HTML レポートの名前を指定します。 いいえ
Verbose エラーと警告をコンソールに記録します。 いいえ

例

この例では、ローカル ストレージにダウンロードした Azure Stack Hub クイック スタート テンプレートをすべて検証します。 また、この例では、仮想マシン (VM) のサイズと ASDK 機能に対する拡張機能も検証します。

test-AzTemplate -TemplatePath C:\AzureStack-Quickstart-Templates `
-CapabilitiesPath .\TemplateValidator\AzureStackCloudCapabilities_with_AddOns_20170627.json `
-TemplatePattern MyStandardTemplateName.json `
-IncludeComputeCapabilities `
-Report TemplateReport.html

次のステップ