Test-AzDeployment

驗證部署。

Syntax

Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateFile <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterObject <Hashtable>
    -TemplateObject <Hashtable>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterObject <Hashtable>
    -TemplateFile <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterObject <Hashtable>
    -TemplateUri <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterObject <Hashtable>
    -TemplateSpecId <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterFile <String>
    -TemplateObject <Hashtable>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterFile <String>
    -TemplateFile <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterFile <String>
    -TemplateUri <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterFile <String>
    -TemplateSpecId <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterFile <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterUri <String>
    -TemplateObject <Hashtable>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterUri <String>
    -TemplateFile <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterUri <String>
    -TemplateUri <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateParameterUri <String>
    -TemplateSpecId <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateObject <Hashtable>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateUri <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]
Test-AzDeployment
    [-Name <String>]
    -Location <String>
    [-QueryString <String>]
    -TemplateSpecId <String>
    [-SkipTemplateParameterPrompt]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Test-AzDeployment Cmdlet 會判斷部署範本及其參數值是否有效。

範例

範例 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

驗證部署。 ( 自動產生 )

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 通訊的認證、帳戶、租用戶和訂用帳戶。

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

-Location

儲存部署數據的位置。

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

-Name

要測試的部署名稱。 如果未指定,則會在提供範本檔案時預設為範本檔名

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

-Pre

設定時,表示 Cmdlet 在自動判斷要使用的版本時,應該使用發行前版本 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

-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

要用於範本的參數檔案。

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 的資源識別碼。

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

輸入

Hashtable

String

輸出

PSResourceManagerError