Get-AzDeploymentWhatIfResult
Získá výsledek citlivostní analýza šablony pro nasazení v oboru předplatného.
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
Rutina Get-AzDeploymentWhatIfResult získá výsledek šablony ARM What-If pro nasazení šablony v aktuálním oboru předplatného. Vrátí seznam změn, které udávají, které prostředky budou aktualizovány, pokud se nasazení použije bez provedení jakýchkoli změn skutečných prostředků. Chcete-li zadat formát pro vrácený výsledek, použijte parametr ResultFormat .
Příklady
Příklad 1: Získání výsledku citlivosti v oboru předplatného
Get-AzDeploymentWhatIfResult `
-DeploymentName "deploy-01" `
-Location "West US" `
-TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
-TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
-ResultFormat "FullResourcePayloads"Tento příkaz získá výsledek citlivostní analýzy v aktuálním oboru předplatného pomocí vlastního souboru šablony a souboru parametrů na disku. Příkaz pomocí parametru Location určuje, kam se mají ukládat data nasazení. Příkaz používá k zadání souboru šablony parametr TemplateFile . Příkaz používá parametr TemplateParameterFile k určení souboru parametrů šablony. Příkaz pomocí parametru ResultFormat nastaví výsledek What-If tak, aby zahrnoval úplné datové části prostředků.
Příklad 2: Získání výsledku citlivosti v oboru předplatného pomocí ResourceIdOnly
Get-AzDeploymentWhatIfResult `
-DeploymentName "deploy-01" `
-Location "West US" `
-TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
-TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
-ResultFormat "ResourceIdOnly"Tento příkaz získá výsledek citlivostní analýzy v aktuálním oboru předplatného pomocí vlastního souboru šablony a souboru parametrů na disku. Příkaz pomocí parametru Location určuje, kam se mají ukládat data nasazení. Příkaz používá k zadání souboru šablony parametr TemplateFile . Příkaz používá parametr TemplateParameterFile k určení souboru parametrů šablony. Příkaz použije parametr ResultFormat k nastavení výsledku What-If tak, aby obsahoval pouze ID prostředků.
Příklad 3: Výpočet citlivostní analýza pomocí souboru .bicepparam
Get-AzDeploymentWhatIfResult -Location "West US" -TemplateParameterFile "./parameters.bicepparam"Tento příkaz získá výsledek what-if v aktuálním oboru předplatného pomocí souboru .bicepparam na disku. Příkaz používá parametr TemplateParameterFile k určení souboru .bicepparam.
Parametry
-DefaultProfile
Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludeChangeType
Čárkami oddělený seznam typů změn prostředků, které mají být vyloučeny z výsledků citlivostní dokumentace.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
Umístění pro ukládání dat nasazení.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Název nasazení, které se má vytvořit. Pokud není zadáno, použije se při zadání souboru šablony výchozí název souboru šablony; výchozí hodnota aktuálního času, kdy je zadaný objekt šablony, například "20131223140835".
| Type: | String |
| Aliases: | DeploymentName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Pre
Při nastavení označuje, že rutina by měla při automatickém určování verze, kterou verzi použít, používat předběžné verze rozhraní API.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResultFormat
Formát výsledku citlivostní citlivosti.
| Type: | WhatIfResultFormat |
| Accepted values: | ResourceIdOnly, FullResourcePayloads |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipTemplateParameterPrompt
Přeskočí zpracování dynamického parametru PowerShellu, které kontroluje, jestli zadaný parametr šablony obsahuje všechny nezbytné parametry, které šablona používá. Tato kontrola by uživateli zobrazila výzvu k zadání hodnoty chybějících parametrů, ale poskytnutí parametru -SkipTemplateParameterPrompt bude tuto výzvu ignorovat a okamžitě se zobrazí chyba, pokud v šabloně nebyl nalezen parametr vázán. V případě neinteraktivních skriptů je možné zadat parametr -SkipTemplateParameterPrompt, který poskytuje lepší chybovou zprávu v případě, že nejsou splněny všechny požadované parametry.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TemplateFile
Místní cesta k souboru šablony. Podporovaný typ souboru šablony: json a bicep.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateObject
Tabulka hash, která představuje šablonu.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateParameterFile
Soubor parametrů, který se má použít pro šablonu.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateParameterObject
Tabulka hash, která představuje parametry.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateParameterUri
Identifikátor URI souboru parametrů šablony.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateSpecId
ID prostředku šablonySpec, který se má nasadit.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateUri
Identifikátor URI souboru šablony.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |