次の方法で共有

Test-AzResourceGroupDeployment

モジュール:
Az.Resources Module

リソース グループのデプロイを検証します。

構文

ByTemplateFileWithNoParameters (既定) 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateFile <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateObjectAndParameterObject 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterObject <Hashtable>
    -TemplateObject <Hashtable>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateFileAndParameterObject 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterObject <Hashtable>
    -TemplateFile <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateUriAndParameterObject 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterObject <Hashtable>
    -TemplateUri <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateSpecResourceIdAndParamsObject 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterObject <Hashtable>
    -TemplateSpecId <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateObjectAndParameterFile 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterFile <String>
    -TemplateObject <Hashtable>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateFileAndParameterFile 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterFile <String>
    -TemplateFile <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateUriAndParameterFile 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterFile <String>
    -TemplateUri <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateSpecResourceIdAndParams 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterFile <String>
    -TemplateSpecId <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByParameterFileWithNoTemplate 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterFile <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateObjectAndParameterUri 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterUri <String>
    -TemplateObject <Hashtable>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateFileAndParameterUri 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterUri <String>
    -TemplateFile <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateUriAndParameterUri 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterUri <String>
    -TemplateUri <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateSpecResourceIdAndParamsUri 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateParameterUri <String>
    -TemplateSpecId <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateObjectWithNoParameters 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateObject <Hashtable>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateUriWithNoParameters 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateUri <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByTemplateSpecResourceId 

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    -TemplateSpecId <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    [-ValidationLevel <String>]
    [-SuppressDiagnostics]
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

説明

Test-AzResourceGroupDeployment コマンドレットは、Azure リソース グループデプロイ テンプレートとそのパラメーター値が有効かどうかを判断します。

例

例 1: カスタム テンプレート オブジェクトとパラメーター ファイルを使用してデプロイをテストする

$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\EngineeringSite.json")
$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable
Test-AzResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json"

このコマンドは、指定されたテンプレート ファイルとパラメーター ファイルから作成されたメモリ内ハッシュテーブルを使用して、特定のリソース グループ内のデプロイをテストします。

例 2: テンプレート ファイルとパラメーター ファイルを使用してデプロイをテストする

Test-AzResourceGroupDeployment -ResourceGroupName testRG01 -TemplateFile "D:\Azure\Templates\sampleDeploymentTemplate.json" -TemplateParameterFile "D:\Azure\Templates\sampleDeploymentTemplateParams.json"

このコマンドは、指定されたテンプレート ファイルとパラメーター ファイルを使用して、指定されたリソース グループとリソース内のデプロイをテストします。

例 3: .bicepparam ファイルを使用してデプロイを検証する

Test-AzResourceGroupDeployment -ResourceGroupName "myRG1" -TemplateParameterFile "./parameters.bicepparam"

このコマンドは、ディスク上の .bicepparam ファイルを使用して、リソース グループ スコープでのデプロイを検証します。 このコマンドでは、 TemplateParameterFile パラメーターを使用して .bicepparam ファイルを指定します。

パラメーター

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

パラメーターのプロパティ

型:IAzureContextContainer
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Mode

展開モードを指定します。 このパラメーターに使用できる値は次のとおりです。

  • インクリメンタル
  • 完成

パラメーターのプロパティ

型:DeploymentMode
規定値:None
指定可能な値:Incremental, Complete
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Pre

このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-QueryString

TemplateUri パラメーターで使用するクエリ文字列 (SAS トークンなど)。 リンクされたテンプレートの場合に使用されます

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ResourceGroupName

テストするリソース グループの名前を指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-RollBackDeploymentName

リソース グループ内の指定された名前を使用して正常なデプロイにロールバックする場合は、-RollbackToLastDeployment を使用しないでください。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-RollbackToLastDeployment

-RollBackDeploymentName が使用されている場合は、リソース グループ内の最後に成功したデプロイにロールバックしないでください。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SkipTemplateParameterPrompt

指定されたテンプレート パラメーターに、テンプレートで使用される必要なすべてのパラメーターが含まれているかどうかを確認する PowerShell 動的パラメーター処理をスキップします。 このチェックでは、不足しているパラメーターの値を指定するようにユーザーに求められますが、-SkipTemplateParameterPrompt を指定すると、このプロンプトは無視され、パラメーターがテンプレートにバインドされていないことが見つかった場合は直ちにエラーが表示されます。 非対話型スクリプトの場合は、すべての必須パラメーターが満たされていない場合に、より適切なエラー メッセージを提供する -SkipTemplateParameterPrompt を提供できます。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SuppressDiagnostics

設定すると、有効なデプロイの検証診断は表示されません。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(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

テンプレート パラメーターの名前と値を含む JSON ファイルの完全なパスを指定します。

パラメーターのプロパティ

型: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(Skips provider validation)、Provider(Performs full validation)、ProviderNoRbac(Performs full validation using RBAC read checks instead of RBAC write checks for provider validation) を指定できます。

パラメーターのプロパティ

型: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を参照してください。

入力

String

Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode

Hashtable

出力

PSResourceManagerError