Get-AzManagementGroupDeploymentWhatIfResult

模組:

Az.Resources

取得管理群組範圍部署的範本 What-If 結果。

語法

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>]

Description

Get-AzManagementGroupDeploymentWhatIfResult Cmdlet 會取得指定管理群組範圍之範本部署的 ARM 範本 What-If 結果。 它會傳回變更清單，指出如果套用部署而不對實際資源進行任何變更，將會更新哪些資源。 若要指定傳回結果的格式，請使用 ResultFormat 參數。

範例

範例 1：在管理群組範圍取得 What-If 結果

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

此命令會使用自定義範本檔案和磁碟上的參數檔案，在管理群組範圍取得 What-If 結果。 命令會 使用Location 參數來指定儲存部署資料的位置。 此命令會 使用ManagementGroupId 參數來指定將部署範本的管理群組。 命令會 使用TemplateFile 參數來指定範本檔案。 此命令會 使用TemplateParameterFile 參數來指定範本參數檔案。 此命令會 使用 ResultFormat 參數來設定 What-If 結果以包含完整的資源承載。

範例 2：使用 ResourceIdOnly 在管理群組範圍取得 What-If 結果

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

此命令會使用自定義範本檔案和磁碟上的參數檔案，在管理群組範圍取得 What-If 結果。 命令會 使用Location 參數來指定儲存部署資料的位置。 此命令會 使用ManagementGroupId 參數來指定將部署範本的管理群組。 命令會 使用TemplateFile 參數來指定範本檔案。 此命令會 使用TemplateParameterFile 參數來指定範本參數檔案。 命令會 使用 ResultFormat 參數將 What-If 結果設定為只包含資源識別碼。

範例 3：使用 .bicepparam 檔案來計算 What-If

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

此命令會使用磁碟上的 .bicepparam 檔案，在管理群組範圍取得 What-If 結果。 此命令會使用 TemplateParameterFile 參數來指定 .bicepparam 檔案。

參數

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:	IAzureContextContainer
別名:	AzContext, AzureRmContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ExcludeChangeType

要從 What-If 結果中排除的資源變更類型逗號分隔清單。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Location

儲存部署數據的位置。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-ManagementGroupId

管理群組標識碼。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-Name

要建立的部署名稱。 如果未指定，則會在提供範本檔案時預設為範本檔名;默認為提供樣板物件的目前時間，例如 「20131223140835」。。

類型:	String
別名:	DeploymentName
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Pre

設定時，表示 Cmdlet 在自動判斷要使用的版本時，應該使用發行前版本 API 版本。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ResultFormat

What-If 結果格式。

類型:	WhatIfResultFormat
接受的值:	ResourceIdOnly, FullResourcePayloads
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-SkipTemplateParameterPrompt

略過 PowerShell 動態參數處理，檢查提供的範本參數是否包含範本所使用的所有必要參數。 這項檢查會提示使用者提供遺漏參數的值，但提供 -SkipTemplateParameterPrompt 會忽略此提示，並在找不到參數時立即在範本中系結時發生錯誤。 針對非互動式腳本，您可以提供 -SkipTemplateParameterPrompt，以在不符合所有必要參數的情況下提供更好的錯誤訊息。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-TemplateFile

範本檔案的本機路徑。 支援的範本檔類型：json 和 bicep。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-TemplateObject

表示範本的哈希表。

類型:	Hashtable
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-TemplateParameterFile

要用於範本的參數檔案。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-TemplateParameterObject

表示參數的哈希表。

類型:	Hashtable
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-TemplateParameterUri

範本參數檔案的 URI。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-TemplateSpecId

要部署之 templateSpec 的資源識別碼。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-TemplateUri

範本檔案的 URI。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

輸入

String

Hashtable

輸出

PSWhatIfOperationResult