Get-AzDeploymentWhatIfResult

Modul:

Az.Resources

Hämtar ett what-if-resultat för en mall för en distribution i prenumerationsomfånget.

Syntax

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Cmdleten Get-AzDeploymentWhatIfResult hämtar ARM-mallens Konsekvensresultat för en malldistribution i det aktuella prenumerationsomfånget. Den returnerar en lista med ändringar som anger vilka resurser som ska uppdateras om distributionen tillämpas utan att göra några ändringar i verkliga resurser. Om du vill ange formatet för det returnerade resultatet använder du parametern ResultFormat .

Exempel

Exempel 1: Få ett konsekvensresultat i prenumerationsomfånget

Get-AzDeploymentWhatIfResult `
    -DeploymentName "deploy-01" `
    -Location "West US" `
    -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
    -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
    -ResultFormat "FullResourcePayloads"

Det här kommandot hämtar ett konsekvensresultat i det aktuella prenumerationsomfånget med hjälp av en anpassad mallfil och en parameterfil på disken. Kommandot använder parametern Plats för att ange var distributionsdata ska lagras. Kommandot använder parametern TemplateFile för att ange en mallfil. Kommandot använder parametern TemplateParameterFile för att ange en mallparameterfil. Kommandot använder parametern ResultFormat för att ange resultatet What-If för att inkludera fullständiga resursnyttolaster.

Exempel 2: Få ett konsekvensresultat i prenumerationsomfånget med ResourceIdOnly

Get-AzDeploymentWhatIfResult `
    -DeploymentName "deploy-01" `
    -Location "West US" `
    -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
    -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
    -ResultFormat "ResourceIdOnly"

Det här kommandot hämtar ett konsekvensresultat i det aktuella prenumerationsomfånget med hjälp av en anpassad mallfil och en parameterfil på disken. Kommandot använder parametern Plats för att ange var distributionsdata ska lagras. Kommandot använder parametern TemplateFile för att ange en mallfil. Kommandot använder parametern TemplateParameterFile för att ange en mallparameterfil. Kommandot använder parametern ResultFormat för att ange att resultatet What-If endast ska innehålla resurs-ID:t.

Exempel 3: Använd en .bicepparam-fil för att beräkna konsekvens

Get-AzDeploymentWhatIfResult -Location "West US" -TemplateParameterFile "./parameters.bicepparam"

Det här kommandot hämtar ett konsekvensresultat i det aktuella prenumerationsomfånget med hjälp av en .bicepparam-fil på disken. Kommandot använder parametern TemplateParameterFile för att ange en .bicepparam-fil.

Parametrar

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-ExcludeChangeType

Kommaavgränsad lista över resursändringstyper som ska undantas från konsekvensresultat.

Typ:	String[]
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Location

Platsen där distributionsdata ska lagras.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Name

Namnet på distributionen som ska skapas. Om det inte anges används standardnamnet för mallfilen när en mallfil tillhandahålls. standardvärdet för den aktuella tiden när ett mallobjekt tillhandahålls, t.ex. "20131223140835".

Typ:	String
Alias:	DeploymentName
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Pre

När den anges anger att cmdleten ska använda förhandsversioner av API-versioner när du automatiskt avgör vilken version som ska användas.

Typ:	SwitchParameter
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-ResultFormat

Resultatformatet What-If.

Typ:	WhatIfResultFormat
Godkända värden:	ResourceIdOnly, FullResourcePayloads
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-SkipTemplateParameterPrompt

Hoppar över bearbetningen av dynamiska PowerShell-parametrar som kontrollerar om den angivna mallparametern innehåller alla nödvändiga parametrar som används av mallen. Den här kontrollen uppmanar användaren att ange ett värde för de parametrar som saknas, men om du anger -SkipTemplateParameterPrompt ignoreras den här uppmaningen och felet ut omedelbart om en parameter inte är bunden i mallen. För icke-interaktiva skript kan -SkipTemplateParameterPrompt tillhandahållas för att ge ett bättre felmeddelande om inte alla obligatoriska parametrar är uppfyllda.

Typ:	SwitchParameter
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-TemplateFile

Lokal sökväg till mallfilen. Mallfiltyp som stöds: json och bicep.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-TemplateObject

En hash-tabell som representerar mallen.

Typ:	Hashtable
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-TemplateParameterFile

Parameterfil som ska användas för mallen.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-TemplateParameterObject

En hash-tabell som representerar parametrarna.

Typ:	Hashtable
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-TemplateParameterUri

Uri till mallparameterfilen.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-TemplateSpecId

Resurs-ID för mallenSpec som ska distribueras.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-TemplateUri

Uri till mallfilen.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

Indata

Hashtable

String

Utdata

PSWhatIfOperationResult