Get-AzManagementGroupDeploymentWhatIfResult

Moduł:

Az.Resources

Pobiera szablon What-If wynik wdrożenia w zakresie grupy zarządzania.

Składnia

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Opis

Polecenie cmdlet Get-AzManagementGroupDeploymentWhatIfResult pobiera What-If wyniku szablonu usługi ARM dla wdrożenia szablonu w określonym zakresie grupy zarządzania. Zwraca listę zmian wskazujących, jakie zasoby zostaną zaktualizowane, jeśli wdrożenie zostanie zastosowane bez wprowadzania żadnych zmian w rzeczywistych zasobach. Aby określić format zwracanego wyniku, użyj parametru ResultFormat.

Przykłady

Przykład 1. Uzyskiwanie wyniku What-If w zakresie grupy zarządzania

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

To polecenie pobiera What-If wynik w zakresie grupy zarządzania przy użyciu niestandardowego pliku szablonu i pliku parametrów na dysku. Polecenie używa parametru Location, aby określić miejsce przechowywania danych wdrożenia. Polecenie używa parametru ManagementGroupId, aby określić grupę zarządzania, w której zostanie wdrożony szablon. Polecenie używa parametru TemplateFile w celu określenia pliku szablonu. Polecenie używa parametru TemplateParameterFile w celu określenia pliku parametrów szablonu. Polecenie używa parametru ResultFormat, aby ustawić wynik What-If, aby uwzględnić pełne ładunki zasobów.

Przykład 2. Uzyskiwanie wyniku What-If w zakresie grupy zarządzania za pomocą identyfikatora ResourceIdOnly

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

To polecenie pobiera What-If wynik w zakresie grupy zarządzania przy użyciu niestandardowego pliku szablonu i pliku parametrów na dysku. Polecenie używa parametru Location, aby określić miejsce przechowywania danych wdrożenia. Polecenie używa parametru ManagementGroupId, aby określić grupę zarządzania, w której zostanie wdrożony szablon. Polecenie używa parametru TemplateFile w celu określenia pliku szablonu. Polecenie używa parametru TemplateParameterFile w celu określenia pliku parametrów szablonu. Polecenie używa parametru ResultFormat, aby ustawić wynik What-If na tylko identyfikatory zasobów.

Przykład 3: obliczenie What-If przy użyciu pliku bicepparam

Get-AzManagementGroupDeploymentWhatIfResult -ManagementGroupId "myManagementGroup" -Location "West US" -TemplateParameterFile "./parameters.bicepparam"

To polecenie pobiera What-If wynik w zakresie grupy zarządzania przy użyciu pliku bicepparam na dysku. Polecenie używa parametru TemplateParameterFile w celu określenia pliku .bicepparam.

Parametry

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:	IAzureContextContainer
Aliasy:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-ExcludeChangeType

Rozdzielona przecinkami lista typów zmian zasobów, które mają zostać wykluczone z What-If wyników.

Typ:	String[]
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Location

Lokalizacja do przechowywania danych wdrożenia.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-ManagementGroupId

Identyfikator grupy zarządzania.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Name

Nazwa wdrożenia, które zostanie utworzone. Jeśli nie zostanie określony, wartość domyślna to nazwa pliku szablonu, gdy zostanie podany plik szablonu; wartość domyślna bieżącej godziny, gdy zostanie podany obiekt szablonu, np. "20131223140835".

Typ:	String
Aliasy:	DeploymentName
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Pre

Po ustawieniu wskazuje, że polecenie cmdlet powinno używać wersji interfejsu API wersji wstępnej podczas automatycznego określania, która wersja ma być używana.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-ResultFormat

Format wyniku What-If.

Typ:	WhatIfResultFormat
Dopuszczalne wartości:	ResourceIdOnly, FullResourcePayloads
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-SkipTemplateParameterPrompt

Pomija dynamiczne przetwarzanie parametrów programu PowerShell, które sprawdza, czy podany parametr szablonu zawiera wszystkie niezbędne parametry używane przez szablon. To sprawdzenie spowoduje wyświetlenie monitu użytkownika o podanie wartości brakujących parametrów, ale podanie -SkipTemplateParameterPrompt spowoduje zignorowanie tego monitu i wyświetlenie komunikatu o błędzie natychmiast, jeśli nie znaleziono parametru, który nie zostanie powiązany w szablonie. W przypadku skryptów nieinterakcyjnych można podać -SkipTemplateParameterPrompt w celu zapewnienia lepszego komunikatu o błędzie w przypadku, gdy nie wszystkie wymagane parametry są spełnione.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-TemplateFile

Ścieżka lokalna do pliku szablonu. Obsługiwany typ pliku szablonu: json i bicep.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-TemplateObject

Tabela skrótów reprezentująca szablon.

Typ:	Hashtable
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-TemplateParameterFile

Plik parametrów do użycia dla szablonu.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-TemplateParameterObject

Tabela skrótów reprezentująca parametry.

Typ:	Hashtable
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-TemplateParameterUri

Identyfikator URI do pliku parametrów szablonu.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-TemplateSpecId

Identyfikator zasobu szablonuSpec do wdrożenia.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-TemplateUri

Identyfikator URI do pliku szablonu.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

String

Hashtable

Dane wyjściowe

PSWhatIfOperationResult