Поделиться через

Get-AzTenantDeploymentWhatIfResult

Модуль:
Az.Resources Module

Возвращает результат What-If шаблона для развертывания в области клиента.

Синтаксис

ByTemplateFileWithNoParameters (По умолчанию) 

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

ByTemplateObjectAndParameterObject 

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

ByTemplateFileAndParameterObject 

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

ByTemplateUriAndParameterObject 

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

ByTemplateSpecResourceIdAndParamsObject 

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

ByTemplateObjectAndParameterFile 

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

ByTemplateFileAndParameterFile 

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

ByTemplateUriAndParameterFile 

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

ByTemplateSpecResourceIdAndParams 

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

ByParameterFileWithNoTemplate 

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

ByTemplateObjectAndParameterUri 

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

ByTemplateFileAndParameterUri 

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

ByTemplateUriAndParameterUri 

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

ByTemplateSpecResourceIdAndParamsUri 

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

ByTemplateObjectWithNoParameters 

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

ByTemplateUriWithNoParameters 

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

ByTemplateSpecResourceId 

Get-AzTenantDeploymentWhatIfResult
    -Location <String>
    -TemplateSpecId <String>
    [-Name <String>]
    [-ResultFormat <WhatIfResultFormat>]
    [-ExcludeChangeType <String[]>]
    [-ValidationLevel <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
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ExcludeChangeType

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

Свойства параметров

Тип:

String[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Location

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

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Name

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

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:ИмяРазвертывания

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Pre

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

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ResultFormat

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

Свойства параметров

Тип:WhatIfResultFormat
Default value:None
Допустимые значения:ResourceIdOnly, FullResourcePayloads
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SkipTemplateParameterPrompt

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

Свойства параметров

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-TemplateFile

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

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByTemplateFileWithNoParameters
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateFileAndParameterObject
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateFileAndParameterFile
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateFileAndParameterUri
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-TemplateObject

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

Свойства параметров

Тип:Hashtable
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByTemplateObjectAndParameterObject
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateObjectAndParameterFile
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateObjectAndParameterUri
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateObjectWithNoParameters
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-TemplateParameterFile

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

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByTemplateObjectAndParameterFile
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateFileAndParameterFile
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateUriAndParameterFile
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateSpecResourceIdAndParams
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByParameterFileWithNoTemplate
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-TemplateParameterObject

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

Свойства параметров

Тип:Hashtable
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByTemplateObjectAndParameterObject
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateFileAndParameterObject
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateUriAndParameterObject
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateSpecResourceIdAndParamsObject
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-TemplateParameterUri

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

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByTemplateObjectAndParameterUri
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateFileAndParameterUri
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateUriAndParameterUri
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateSpecResourceIdAndParamsUri
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-TemplateSpecId

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

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByTemplateSpecResourceIdAndParamsObject
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateSpecResourceIdAndParams
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateSpecResourceIdAndParamsUri
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateSpecResourceId
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-TemplateUri

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

Свойства параметров

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ByTemplateUriAndParameterObject
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateUriAndParameterFile
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateUriAndParameterUri
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False
ByTemplateUriWithNoParameters
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:True
Значение из оставшихся аргументов:False

-ValidationLevel

Задает уровень проверки для проверки или того, что если. ValidationLevel может быть template(Skips provider validation), Provider(Выполняет полную проверку) или ProviderNoRbac(Выполняет полную проверку с помощью проверок чтения RBAC вместо проверок записи RBAC для проверки поставщика).

Свойства параметров

Тип:String
Default value:None(Provider)
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

String

Hashtable

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

PSWhatIfOperationResult