Get-AzResourceGroupDeploymentWhatIfResult
Возвращает результаты шаблона What-If для развертывания в области группы ресурсов.
Синтаксис
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterObject <Hashtable>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterObject <Hashtable>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterObject <Hashtable>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterObject <Hashtable>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterUri <String>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterUri <String>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterUri <String>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterUri <String>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzResourceGroupDeploymentWhatIfResult
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Описание
Командлет Get-AzResourceGroupDeploymentWhatIfResult получает результат ARM шаблона What-If для развертывания шаблона в указанной области группы ресурсов. Он возвращает список изменений, указывающих, какие ресурсы будут обновляться, если развертывание применяется без внесения изменений в реальные ресурсы. Чтобы указать формат возвращаемого результата, используйте параметр ResultFormat .
Примеры
Пример 1. Получение результата "Что если" в области группы ресурсов
Get-AzResourceGroupDeploymentWhatIfResult `
-DeploymentName "deploy-01" `
-ResourceGroupName "myRG1" `
-TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
-TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
-ResultFormat "FullResourcePayloads"
Эта команда получает результат What-If в указанной области группы ресурсов с помощью пользовательского файла шаблона и файла параметров на диске. Команда использует параметр ResourceGroupName для указания группы ресурсов, в которой будет развернут шаблон. Команда использует параметр TemplateFile для указания файла шаблона. Команда использует параметр TemplateParameterFile для указания файла параметров шаблона. Команда использует параметр ResultFormat для задания результата What-If для включения полных полезных данных ресурсов.
Пример 2. Получение результата "Что если" в области группы ресурсов с помощью ResourceIdOnly
Get-AzResourceGroupDeploymentWhatIfResult `
-DeploymentName "deploy-01" `
-ResourceGroupName "myRG1" `
-TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
-TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
-ResultFormat "ResourceIdOnly"
Эта команда получает результат What-If в указанной области группы ресурсов с помощью пользовательского файла шаблона и файла параметров на диске. Команда использует параметр ResourceGroupName для указания группы ресурсов, в которой будет развернут шаблон. Команда использует параметр TemplateFile для указания файла шаблона. Команда использует параметр TemplateParameterFile для указания файла параметров шаблона. Команда использует параметр ResultFormat , чтобы задать результат What-If только идентификаторами ресурсов.
Пример 3. Использование Bicepparam-файла для вычисления What-If
Get-AzResourceGroupDeploymentWhatIfResult -ResourceGroupName "myRG1" -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 |
-Mode
Режим развертывания.
Тип: | DeploymentMode |
Допустимые значения: | Incremental, Complete |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Name
Имя создаваемого развертывания. Если файл шаблона не указан, по умолчанию используется имя файла шаблона при указании файла шаблона; По умолчанию используется текущее время предоставления объекта шаблона, например "20131223140835".
Тип: | String |
Aliases: | DeploymentName |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Pre
При установке указывает, что командлет должен использовать предварительно выпущенные версии API при автоматическом определении используемой версии.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ResourceGroupName
Имя группы ресурсов.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | 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 |
Входные данные
Выходные данные
Azure PowerShell
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по