你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Get-AzTenantDeploymentWhatIfResult

模块:

Az.Resources

获取租户范围内部署的模板 What-If 结果。

语法

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

说明

Get-AzTenantDeploymentWhatIfResult cmdlet 获取指定租户范围内模板部署的 ARM 模板 What-If 结果。 它返回一个更改列表，指示如果部署应用了哪些资源，而不对实际资源进行任何更改，则会更新哪些资源。 若要指定返回结果的格式，请使用 ResultFormat 参数。

示例

示例 1：在租户范围内获取 What-If 结果

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

此命令通过使用自定义模板文件和磁盘上的参数文件在租户范围内获取 What-If 结果。 该命令使用 Location 参数指定存储部署数据的位置。 该命令使用 TemplateFile 参数指定模板文件。 该命令使用 TemplateParameterFile 参数指定模板参数文件。 该命令使用 ResultFormat 参数设置 What-If 结果以包含完整的资源有效负载。

示例 2：使用 ResourceIdOnly 在租户范围内获取 What-If 结果

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

此命令通过使用自定义模板文件和磁盘上的参数文件在租户范围内获取 What-If 结果。 该命令使用 Location 参数指定存储部署数据的位置。 该命令使用 TemplateFile 参数指定模板文件。 该命令使用 TemplateParameterFile 参数指定模板参数文件。 该命令使用 ResultFormat 参数将 What-If 结果设置为仅包含资源 ID。

示例 3：使用 .bicepparam 文件计算 What-If

Get-AzTenantDeploymentWhatIfResult -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

-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 的资源 ID。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-TemplateUri

模板文件的 URI。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

输入

String

Hashtable

输出

PSWhatIfOperationResult