Get-AzDeploymentWhatIfResult

Module:

Az.Resources

Hiermee haalt u een what-if-sjabloonresultaat op voor een implementatie binnen het abonnementsbereik.

Syntaxis

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

De cmdlet Get-AzDeploymentWhatIfResult haalt de ARM-sjabloon What-If-resultaat op voor een sjabloonimplementatie binnen het huidige abonnementsbereik. Het retourneert een lijst met wijzigingen die aangeven welke resources worden bijgewerkt als de implementatie wordt toegepast zonder wijzigingen aan te brengen in echte resources. Als u de notatie voor het geretourneerde resultaat wilt opgeven, gebruikt u de parameter ResultFormat .

Voorbeelden

Voorbeeld 1: Een What-If-resultaat ophalen bij het abonnementsbereik

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

Met deze opdracht krijgt u een What-If-resultaat voor het huidige abonnementsbereik met behulp van een aangepast sjabloonbestand en een parameterbestand op schijf. De opdracht gebruikt de parameter Locatie om op te geven waar de implementatiegegevens moeten worden opgeslagen. De opdracht maakt gebruik van de parameter TemplateFile om een sjabloonbestand op te geven. De opdracht maakt gebruik van de parameter TemplateParameterFile om een sjabloonparameterbestand op te geven. De opdracht gebruikt de parameter ResultFormat om het What-If-resultaat in te stellen om volledige nettoladingen van resources op te nemen.

Voorbeeld 2: Een What-If-resultaat ophalen bij het abonnementsbereik met ResourceIdOnly

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

Met deze opdracht krijgt u een What-If-resultaat voor het huidige abonnementsbereik met behulp van een aangepast sjabloonbestand en een parameterbestand op schijf. De opdracht gebruikt de parameter Locatie om op te geven waar de implementatiegegevens moeten worden opgeslagen. De opdracht maakt gebruik van de parameter TemplateFile om een sjabloonbestand op te geven. De opdracht maakt gebruik van de parameter TemplateParameterFile om een sjabloonparameterbestand op te geven. De opdracht gebruikt de parameter ResultFormat om het What-If-resultaat in te stellen op alleen resource-id's.

Voorbeeld 3: Een BICEPPARAM-bestand gebruiken om What-If te berekenen

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

Met deze opdracht krijgt u een What-If-resultaat voor het huidige abonnementsbereik met behulp van een BICEPPARAM-bestand op schijf. De opdracht maakt gebruik van de parameter TemplateParameterFile om een BICEPPARAM-bestand op te geven.

Parameters

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

Type:	IAzureContextContainer
Aliassen:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ExcludeChangeType

Door komma's gescheiden lijst met resourcewijzigingstypen die moeten worden uitgesloten van What-If-resultaten.

Type:	String[]
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Location

De locatie voor het opslaan van implementatiegegevens.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Name

De naam van de implementatie die wordt gemaakt. Als dit niet is opgegeven, wordt standaard de naam van het sjabloonbestand opgegeven wanneer een sjabloonbestand wordt opgegeven; is standaard ingesteld op het huidige tijdstip waarop een sjabloonobject wordt opgegeven, bijvoorbeeld '20131223140835'.

Type:	String
Aliassen:	DeploymentName
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Pre

Wanneer deze is ingesteld, geeft u aan dat de cmdlet api-versies van de voorlopige versie moet gebruiken wanneer automatisch wordt bepaald welke versie moet worden gebruikt.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ResultFormat

De what-if-resultaatindeling.

Type:	WhatIfResultFormat
Geaccepteerde waarden:	ResourceIdOnly, FullResourcePayloads
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-SkipTemplateParameterPrompt

Slaat de dynamische PowerShell-parameterverwerking over die controleert of de opgegeven sjabloonparameter alle benodigde parameters bevat die door de sjabloon worden gebruikt. Met deze controle wordt de gebruiker gevraagd een waarde op te geven voor de ontbrekende parameters, maar als u de parameter -SkipTemplateParameterPrompt opgeeft, wordt deze prompt genegeerd en wordt deze fout onmiddellijk genegeerd als er geen parameter in de sjabloon is gebonden. Voor niet-interactieve scripts kan -SkipTemplateParameterPrompt worden opgegeven om een beter foutbericht te geven in het geval dat niet aan alle vereiste parameters wordt voldaan.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-TemplateFile

Lokaal pad naar het sjabloonbestand. Ondersteund sjabloonbestandstype: json en bicep.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-TemplateObject

Een hash-tabel die de sjabloon vertegenwoordigt.

Type:	Hashtable
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-TemplateParameterFile

Parameterbestand dat moet worden gebruikt voor de sjabloon.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-TemplateParameterObject

Een hash-tabel die de parameters vertegenwoordigt.

Type:	Hashtable
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-TemplateParameterUri

Uri naar het sjabloonparameterbestand.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-TemplateSpecId

Resource-id van de templateSpec die moet worden geïmplementeerd.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-TemplateUri

Uri naar het sjabloonbestand.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

Invoerwaarden

Hashtable

String

Uitvoerwaarden

PSWhatIfOperationResult