Test-AzResourceGroupDeployment

モジュール:

Az.Resources

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

構文

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Test-AzResourceGroupDeployment
    -ResourceGroupName <String>
    [-Mode <DeploymentMode>]
    [-RollbackToLastDeployment]
    [-RollBackDeploymentName <String>]
    [-QueryString <String>]
    -TemplateSpecId <String>
    [-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 との通信に使用される資格情報、アカウント、テナント、サブスクリプション

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Mode

展開モードを指定します。 このパラメーターの有効値は、次のとおりです。

• 増分
• 完了

Type:	DeploymentMode
Accepted values:	Incremental, Complete
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Pre

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-QueryString

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-RollBackDeploymentName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-RollbackToLastDeployment

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkipTemplateParameterPrompt

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TemplateFile

テンプレート ファイルの完全パスを指定します。 サポートされているテンプレート ファイルの種類: json と bicep。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TemplateObject

テンプレートを表すハッシュ テーブル。

Type:	Hashtable
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TemplateParameterFile

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TemplateParameterObject

テンプレート パラメーターの名前と値のハッシュ テーブルを指定します。

Type:	Hashtable
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TemplateParameterUri

テンプレート パラメーター ファイルの URI を指定します。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TemplateSpecId

デプロイする templateSpec のリソース ID。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-TemplateUri

テンプレート ファイルの URI を指定します。

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

入力

String

DeploymentMode

Hashtable

出力

PSResourceManagerError

関連リンク

• Get AzResourceGroupDeployment
• New-AzResourceGroupDeployment
• Remove-AzResourceGroupDeployment
• Stop-AzResourceGroupDeployment