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 получает шаблон 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. Получение результата What-If в области клиента с помощью ResourceIdOnly

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 только идентификаторов ресурсов.

Пример 3. Используйте файл Bicepparam для вычисления What-If

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

Эта команда получает результат What-If в текущей области клиента с помощью файла Bicepparam на диске. Команда использует параметр TemplateParameterFile для указания файла Bicepparam.

Параметры

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

Тип:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ExcludeChangeType

Разделенный запятыми список типов изменений ресурсов, которые следует исключить из What-If результатов.

Тип:	String[]
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Location

Расположение для хранения данных развертывания.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Name

Имя создаваемого развертывания. Если файл шаблона не указан, по умолчанию используется имя файла шаблона при указании файла шаблона; По умолчанию используется текущее время предоставления объекта шаблона, например "20131223140835".

Тип:	String
Aliases:	DeploymentName
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-Pre

При установке указывает, что командлет должен использовать предварительно выпущенные версии API при автоматическом определении используемой версии.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ResultFormat

Формат результатов What-If.

Тип:	WhatIfResultFormat
Допустимые значения:	ResourceIdOnly, FullResourcePayloads
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-SkipTemplateParameterPrompt

Пропускает динамическую обработку параметров PowerShell, которая проверяет, содержит ли указанный параметр шаблона все необходимые параметры, используемые шаблоном. Эта проверка предложит пользователю указать значение отсутствующих параметров, но при условии, что -SkipTemplateParameterPrompt будет игнорировать эту строку и сразу же ошибиться, если параметр не был привязан к шаблону. Для неинтерактивных скриптов -SkipTemplateParameterPrompt можно предоставить лучшее сообщение об ошибке в случае, если не все необходимые параметры удовлетворены.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-TemplateFile

Локальный путь к файлу шаблона. Поддерживаемый тип файла шаблона: json и bicep.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TemplateObject

Хэш-таблица, представляющая шаблон.

Тип:	Hashtable
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TemplateParameterFile

Файл параметров, используемый для шаблона.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TemplateParameterObject

Хэш-таблица, представляющая параметры.

Тип:	Hashtable
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TemplateParameterUri

Универсальный код ресурса (URI) в файл параметров шаблона.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TemplateSpecId

Идентификатор ресурса развернутого шаблонаSpec.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TemplateUri

Универсальный код ресурса (URI) в файл шаблона.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

Входные данные

String

Hashtable

Выходные данные

PSWhatIfOperationResult