Test-AzDeployment
構文
ByTemplateFileWithNoParameters (既定)
Test-AzDeployment
-Location <String>
-TemplateFile <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateObjectAndParameterObject
Test-AzDeployment
-Location <String>
-TemplateParameterObject <Hashtable>
-TemplateObject <Hashtable>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateFileAndParameterObject
Test-AzDeployment
-Location <String>
-TemplateParameterObject <Hashtable>
-TemplateFile <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateUriAndParameterObject
Test-AzDeployment
-Location <String>
-TemplateParameterObject <Hashtable>
-TemplateUri <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateSpecResourceIdAndParamsObject
Test-AzDeployment
-Location <String>
-TemplateParameterObject <Hashtable>
-TemplateSpecId <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateObjectAndParameterFile
Test-AzDeployment
-Location <String>
-TemplateParameterFile <String>
-TemplateObject <Hashtable>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateFileAndParameterFile
Test-AzDeployment
-Location <String>
-TemplateParameterFile <String>
-TemplateFile <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateUriAndParameterFile
Test-AzDeployment
-Location <String>
-TemplateParameterFile <String>
-TemplateUri <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateSpecResourceIdAndParams
Test-AzDeployment
-Location <String>
-TemplateParameterFile <String>
-TemplateSpecId <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByParameterFileWithNoTemplate
Test-AzDeployment
-Location <String>
-TemplateParameterFile <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateObjectAndParameterUri
Test-AzDeployment
-Location <String>
-TemplateParameterUri <String>
-TemplateObject <Hashtable>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateFileAndParameterUri
Test-AzDeployment
-Location <String>
-TemplateParameterUri <String>
-TemplateFile <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateUriAndParameterUri
Test-AzDeployment
-Location <String>
-TemplateParameterUri <String>
-TemplateUri <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateSpecResourceIdAndParamsUri
Test-AzDeployment
-Location <String>
-TemplateParameterUri <String>
-TemplateSpecId <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateObjectWithNoParameters
Test-AzDeployment
-Location <String>
-TemplateObject <Hashtable>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateUriWithNoParameters
Test-AzDeployment
-Location <String>
-TemplateUri <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByTemplateSpecResourceId
Test-AzDeployment
-Location <String>
-TemplateSpecId <String>
[-Name <String>]
[-QueryString <String>]
[-ValidationLevel <String>]
[-SuppressDiagnostics]
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Test-AzDeployment コマンドレットは、デプロイ テンプレートとそのパラメーター値が有効かどうかを判断します。
例
例 1: カスタム テンプレートとパラメーター ファイルを使用してデプロイをテストする
Test-AzDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json"
このコマンドは、指定されたテンプレート ファイルとパラメーター ファイルを使用して、現在のサブスクリプション スコープでのデプロイをテストします。
例 2: カスタム テンプレート オブジェクトとパラメーター ファイルを使用してデプロイをテストする
$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\EngineeringSite.json")
$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable
Test-AzDeployment -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json"
このコマンドは、指定されたテンプレート ファイルとパラメーター ファイルから作成されたメモリ内ハッシュテーブルを使用して、現在のサブスクリプション スコープでのデプロイをテストします。
例 3
デプロイを検証します。 (autogenerated)
Test-AzDeployment -Location 'West US' -SkipTemplateParameterPrompt -TemplateFile 'D:\Azure\Templates\EngineeringSite.json' -TemplateParameterFile 'D:\Azure\Templates\EngSiteParams.json'
例 4: .bicepparam ファイルを使用してデプロイを検証する
Test-AzDeployment -Location "West US" -TemplateParameterFile "./parameters.bicepparam"
このコマンドは、ディスク上の .bicepparam ファイルを使用して、現在のサブスクリプション スコープでのデプロイを検証します。
このコマンドでは、 TemplateParameterFile パラメーターを使用して.bicepparam ファイルを指定します。
パラメーター
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Location
デプロイ データを格納する場所。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
テストするデプロイの名前。 指定しない場合、テンプレート ファイルが指定されたときに既定でテンプレート ファイル名が設定されます
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | デプロイメント名 |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Pre
設定すると、使用するバージョンを自動的に決定するときに、コマンドレットでプレリリース API バージョンを使用する必要があることを示します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-QueryString
TemplateUri パラメーターで使用するクエリ文字列 (SAS トークンなど)。 リンクされたテンプレートの場合に使用されます
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SkipTemplateParameterPrompt
指定されたテンプレート パラメーターに、テンプレートで使用される必要なすべてのパラメーターが含まれているかどうかを確認する PowerShell 動的パラメーター処理をスキップします。 このチェックでは、不足しているパラメーターの値を指定するようにユーザーに求められますが、-SkipTemplateParameterPrompt を指定すると、このプロンプトは無視され、パラメーターがテンプレートにバインドされていないことが見つかった場合は直ちにエラーが発生します。 非対話型スクリプトの場合、-SkipTemplateParameterPrompt を指定すると、すべての必須パラメーターが満たされていない場合に、より適切なエラー メッセージを表示できます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SuppressDiagnostics
設定すると、有効なデプロイの検証診断は表示されません。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TemplateFile
テンプレート ファイルへのローカル パス。 サポートされているテンプレート ファイルの種類: json と bicep。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByTemplateFileWithNoParameters
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateFileAndParameterObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateFileAndParameterFile
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateFileAndParameterUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-TemplateObject
テンプレートを表すハッシュ テーブル。
パラメーターのプロパティ
| 型: | Hashtable
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByTemplateObjectAndParameterObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateObjectAndParameterFile
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateObjectAndParameterUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateObjectWithNoParameters
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-TemplateParameterFile
テンプレートに使用するパラメーター ファイル。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByTemplateObjectAndParameterFile
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateFileAndParameterFile
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateUriAndParameterFile
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateSpecResourceIdAndParams
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByParameterFileWithNoTemplate
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-TemplateParameterObject
パラメーターを表すハッシュ テーブル。
パラメーターのプロパティ
| 型: | Hashtable
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByTemplateObjectAndParameterObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateFileAndParameterObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateUriAndParameterObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateSpecResourceIdAndParamsObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-TemplateParameterUri
テンプレート パラメーター ファイルへの URI。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByTemplateObjectAndParameterUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateFileAndParameterUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateUriAndParameterUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateSpecResourceIdAndParamsUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-TemplateSpecId
デプロイする templateSpec のリソース ID。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByTemplateSpecResourceIdAndParamsObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateSpecResourceIdAndParams
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateSpecResourceIdAndParamsUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateSpecResourceId
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-TemplateUri
テンプレート ファイルの URI。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByTemplateUriAndParameterObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateUriAndParameterFile
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateUriAndParameterUri
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
ByTemplateUriWithNoParameters
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-ValidationLevel
validate/what-if の検証レベルを設定します。 ValidationLevel には、Template(プロバイダーの検証をスキップする)、Provider(完全な検証を実行する)、または ProviderNoRbac(プロバイダー検証の RBAC 書き込みチェックの代わりに RBAC 読み取りチェックを使用して完全な検証を実行する) を指定できます。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None(Provider) |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
