Freigeben über


Test-AzDeployment

Überprüft eine Bereitstellung.

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>]

Beschreibung

Das Cmdlet Test-AzDeployment bestimmt, ob eine Bereitstellungsvorlage und deren Parameterwerte gültig sind.

Beispiele

Beispiel 1: Testen der Bereitstellung mit einer benutzerdefinierten Vorlagen- und Parameterdatei

Test-AzDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json"

Dieser Befehl testet eine Bereitstellung im aktuellen Abonnementbereich mithilfe der angegebenen Vorlagendatei und parameterdatei.

Beispiel 2: Testen der Bereitstellung mit einem benutzerdefinierten Vorlagenobjekt und einer Parameterdatei

$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"

Dieser Befehl testet eine Bereitstellung im aktuellen Abonnementbereich mithilfe der in der angegebenen Vorlagendatei und einer Parameterdatei erstellten In-Memory-Hashtable.

Beispiel 3

Überprüft eine Bereitstellung. (automatisch generiert)

Test-AzDeployment -Location 'West US' -SkipTemplateParameterPrompt -TemplateFile 'D:\Azure\Templates\EngineeringSite.json' -TemplateParameterFile 'D:\Azure\Templates\EngSiteParams.json'

Beispiel 4: Verwenden einer Bicepparam-Datei zum Überprüfen einer Bereitstellung

Test-AzDeployment -Location "West US" -TemplateParameterFile "./parameters.bicepparam"

Mit diesem Befehl wird die Bereitstellung auf dem aktuellen Abonnementbereich mithilfe einer Bicepparam-Datei auf dem Datenträger überprüft. Der Befehl verwendet den Parameter TemplateParameterFile , um eine Bicepparam-Datei anzugeben.

Parameter

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Typ:IAzureContextContainer
Aliase:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Location

Der Speicherort zum Speichern von Bereitstellungsdaten.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Name

Der Name der Bereitstellung, die getestet werden soll. Wenn nicht angegeben, wird standardmäßig der Vorlagendateiname angegeben, wenn eine Vorlagendatei bereitgestellt wird.

Typ:String
Aliase:DeploymentName
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Pre

Wenn festgelegt, gibt an, dass das Cmdlet Vorabversionen von API-Versionen verwenden soll, wenn automatisch bestimmt wird, welche Version verwendet werden soll.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-QueryString

Die Abfragezeichenfolge (z. B. ein SAS-Token), die mit dem TemplateUri-Parameter verwendet werden soll. Würde bei verknüpften Vorlagen verwendet werden

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-SkipTemplateParameterPrompt

Überspringt die dynamische PowerShell-Parameterverarbeitung, die überprüft, ob der bereitgestellte Vorlagenparameter alle erforderlichen Parameter enthält, die von der Vorlage verwendet werden. Diese Überprüfung fordert den Benutzer auf, einen Wert für die fehlenden Parameter bereitzustellen, aber durch Bereitstellen des "-SkipTemplateParameterPrompt" wird diese Eingabeaufforderung ignoriert und sofort ein Fehler ausgegeben, wenn ein Parameter nicht in der Vorlage gebunden wurde. Für nicht interaktive Skripts kann -SkipTemplateParameterPrompt bereitgestellt werden, um eine bessere Fehlermeldung bereitzustellen, wenn nicht alle erforderlichen Parameter erfüllt sind.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-TemplateFile

Lokaler Pfad zur Vorlagendatei. Unterstützter Vorlagendateityp: json und bicep.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-TemplateObject

Eine Hashtabelle, die die Vorlage darstellt.

Typ:Hashtable
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-TemplateParameterFile

Parameterdatei, die für die Vorlage verwendet werden soll.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-TemplateParameterObject

Eine Hashtabelle, die die Parameter darstellt.

Typ:Hashtable
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-TemplateParameterUri

URI für die Vorlagenparameterdatei.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-TemplateSpecId

Ressourcen-ID der zu bereitstellenden TemplateSpec.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-TemplateUri

URI für die Vorlagendatei.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

Eingaben

Hashtable

String

Ausgaben

PSResourceManagerError