Get-AzResourceGroupDeploymentWhatIfResult

Modul:

Az.Resources

Hämtar en mall What-If resultat för en distribution i resursgruppsomfånget.

Syntax

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzResourceGroupDeploymentWhatIfResult
   [-Name <String>]
   -ResourceGroupName <String>
   [-Mode <DeploymentMode>]
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Cmdleten Get-AzResourceGroupDeploymentWhatIfResult hämtar ARM-mallen What-If resultat för en malldistribution i det angivna resursgruppsomfå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: Hämta ett What-If resultat i resursgruppsomfånget

Get-AzResourceGroupDeploymentWhatIfResult `
    -DeploymentName "deploy-01" `
    -ResourceGroupName "myRG1" `
    -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
    -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
    -ResultFormat "FullResourcePayloads"

Det här kommandot hämtar ett What-If resultat i det angivna resursgruppsomfånget med hjälp av en anpassad mallfil och en parameterfil på disken. Kommandot använder parametern ResourceGroupName för att ange en resursgrupp där mallen ska distribueras. 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 What-If resultat som ska innehålla fullständiga resursnyttolaster.

Exempel 2: Hämta ett What-If resultat i resursgruppsomfånget med ResourceIdOnly

Get-AzResourceGroupDeploymentWhatIfResult `
    -DeploymentName "deploy-01" `
    -ResourceGroupName "myRG1" `
    -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
    -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
    -ResultFormat "ResourceIdOnly"

Det här kommandot hämtar ett What-If resultat i det angivna resursgruppsomfånget med hjälp av en anpassad mallfil och en parameterfil på disken. Kommandot använder parametern ResourceGroupName för att ange en resursgrupp där mallen ska distribueras. 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 What-If resultat endast ska innehålla resurs-ID:t.

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

Get-AzResourceGroupDeploymentWhatIfResult -ResourceGroupName "myRG1" -TemplateParameterFile "./parameters.bicepparam"

Det här kommandot hämtar ett What-If resultat i resursgruppens omfång 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änsade resursändringstyper som ska undantas från What-If resultat.

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

-Mode

Distributionsläget.

Typ:	DeploymentMode
Godkända värden:	Incremental, Complete
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
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:	True
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

-ResourceGroupName

Resursgruppens namn.

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

-ResultFormat

Det What-If resultatformatet.

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 omedelbart om en parameter inte har bundits 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

String

DeploymentMode

Hashtable

Utdata

PSWhatIfOperationResult