Dela via

Get-AzResourceGroupDeploymentWhatIfResult

Modul:
Az.Resources Module

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

Syntax

ByTemplateFileWithNoParameters (Standard) 

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

ByTemplateObjectAndParameterObject 

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

ByTemplateFileAndParameterObject 

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

ByTemplateUriAndParameterObject 

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

ByTemplateSpecResourceIdAndParamsObject 

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

ByTemplateObjectAndParameterFile 

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

ByTemplateFileAndParameterFile 

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

ByTemplateUriAndParameterFile 

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

ByTemplateSpecResourceIdAndParams 

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

ByParameterFileWithNoTemplate 

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

ByTemplateObjectAndParameterUri 

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

ByTemplateFileAndParameterUri 

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

ByTemplateUriAndParameterUri 

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

ByTemplateSpecResourceIdAndParamsUri 

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

ByTemplateObjectWithNoParameters 

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

ByTemplateUriWithNoParameters 

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

ByTemplateSpecResourceId 

Get-AzResourceGroupDeploymentWhatIfResult
    -ResourceGroupName <String>
    -TemplateSpecId <String>
    [-Name <String>]
    [-Mode <DeploymentMode>]
    [-ResultFormat <WhatIfResultFormat>]
    [-ExcludeChangeType <String[]>]
    [-ValidationLevel <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.

Parameteregenskaper

Typ:IAzureContextContainer
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ExcludeChangeType

Kommaavgränsade resursändringstyper som ska undantas från What-If resultat.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Mode

Distributionsläget.

Parameteregenskaper

Typ:DeploymentMode
Standardvärde:None
Godkända värden:Incremental, Complete
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument: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".

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Distribueringsnamn

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument: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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceGroupName

Resursgruppens namn.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-ResultFormat

Det What-If resultatformatet.

Parameteregenskaper

Typ:WhatIfResultFormat
Standardvärde:None
Godkända värden:ResourceIdOnly, FullResourcePayloads
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument: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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-TemplateFile

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByTemplateFileWithNoParameters
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateFileAndParameterObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateFileAndParameterFile
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateFileAndParameterUri
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-TemplateObject

En hash-tabell som representerar mallen.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByTemplateObjectAndParameterObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateObjectAndParameterFile
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateObjectAndParameterUri
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateObjectWithNoParameters
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-TemplateParameterFile

Parameterfil som ska användas för mallen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByTemplateObjectAndParameterFile
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateFileAndParameterFile
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateUriAndParameterFile
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateSpecResourceIdAndParams
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByParameterFileWithNoTemplate
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-TemplateParameterObject

En hash-tabell som representerar parametrarna.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByTemplateObjectAndParameterObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateFileAndParameterObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateUriAndParameterObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateSpecResourceIdAndParamsObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-TemplateParameterUri

Uri till mallparameterfilen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByTemplateObjectAndParameterUri
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateFileAndParameterUri
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateUriAndParameterUri
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateSpecResourceIdAndParamsUri
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-TemplateSpecId

Resurs-ID för mallenSpec som ska distribueras.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByTemplateSpecResourceIdAndParamsObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateSpecResourceIdAndParams
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateSpecResourceIdAndParamsUri
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateSpecResourceId
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-TemplateUri

Uri till mallfilen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByTemplateUriAndParameterObject
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateUriAndParameterFile
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateUriAndParameterUri
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False
ByTemplateUriWithNoParameters
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-ValidationLevel

Anger valideringsnivån för validering/konsekvens. ValidationLevel kan vara Template(Skips provider validation), Provider(Performs full validation) eller ProviderNoRbac(Utför fullständig validering med RBAC-läskontroller i stället för RBAC-skrivkontroller för providerverifiering).

Parameteregenskaper

Typ:String
Standardvärde:None(Provider)
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

String

Microsoft.Azure.Management.ResourceManager.Models.DeploymentMode

Hashtable

Utdata

PSWhatIfOperationResult