Get-AzDeploymentWhatIfResult
Obtém um resultado hipotético de modelo para uma implantação no escopo da assinatura.
Syntax
Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterObject <Hashtable>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterObject <Hashtable>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterObject <Hashtable>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterObject <Hashtable>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterUri <String>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterUri <String>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterUri <String>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateParameterUri <String>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzDeploymentWhatIfResult
[-Name <String>]
-Location <String>
[-ResultFormat <WhatIfResultFormat>]
[-ExcludeChangeType <String[]>]
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
O cmdlet Get-AzDeploymentWhatIfResult obtém o resultado What-If do modelo ARM para uma implantação de modelo no escopo da assinatura atual. Ele retorna uma lista de alterações indicando quais recursos serão atualizados se a implantação for aplicada sem fazer alterações nos recursos reais. Para especificar o formato para o resultado que retorna, use o parâmetro ResultFormat .
Exemplos
Exemplo 1: Obter um resultado hipotético no escopo da assinatura
Get-AzDeploymentWhatIfResult `
-DeploymentName "deploy-01" `
-Location "West US" `
-TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
-TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
-ResultFormat "FullResourcePayloads"Este comando obtém um resultado hipotético no escopo da assinatura atual usando um arquivo de modelo personalizado e um arquivo de parâmetro no disco. O comando usa o parâmetro Location para especificar onde armazenar os dados de implantação. O comando usa o parâmetro TemplateFile para especificar um arquivo de modelo. O comando usa o parâmetro TemplateParameterFile para especificar um arquivo de parâmetro de modelo. O comando usa o parâmetro ResultFormat para definir o resultado de hipóteses para incluir cargas úteis completas de recursos.
Exemplo 2: Obter um resultado hipotético no escopo da assinatura com ResourceIdOnly
Get-AzDeploymentWhatIfResult `
-DeploymentName "deploy-01" `
-Location "West US" `
-TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
-TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
-ResultFormat "ResourceIdOnly"Este comando obtém um resultado hipotético no escopo da assinatura atual usando um arquivo de modelo personalizado e um arquivo de parâmetro no disco. O comando usa o parâmetro Location para especificar onde armazenar os dados de implantação. O comando usa o parâmetro TemplateFile para especificar um arquivo de modelo. O comando usa o parâmetro TemplateParameterFile para especificar um arquivo de parâmetro de modelo. O comando usa o parâmetro ResultFormat para definir o resultado de hipóteses para conter apenas IDs de recursos.
Exemplo 3: Usar um arquivo .bicepparam para calcular What-If
Get-AzDeploymentWhatIfResult -Location "West US" -TemplateParameterFile "./parameters.bicepparam"Este comando obtém um resultado hipotético no escopo da assinatura atual usando um arquivo .bicepparam no disco. O comando usa o parâmetro TemplateParameterFile para especificar um arquivo .bicepparam.
Parâmetros
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludeChangeType
Lista separada por vírgulas de tipos de alteração de recursos a serem excluídos dos resultados de hipóteses.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
O local para armazenar dados de implantação.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
O nome da implantação que ele vai criar. Se não for especificado, o padrão será o nome do arquivo de modelo quando um arquivo de modelo for fornecido; padrão para a hora atual em que um objeto de modelo é fornecido, por exemplo, "20131223140835".
| Type: | String |
| Aliases: | DeploymentName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Pre
Quando definido, indica que o cmdlet deve usar versões de API de pré-lançamento ao determinar automaticamente qual versão usar.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResultFormat
O formato de resultado de hipóteses.
| Type: | WhatIfResultFormat |
| Accepted values: | ResourceIdOnly, FullResourcePayloads |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipTemplateParameterPrompt
Ignora o processamento de parâmetros dinâmicos do PowerShell que verifica se o parâmetro de modelo fornecido contém todos os parâmetros necessários usados pelo modelo. Essa verificação solicitaria que o usuário fornecesse um valor para os parâmetros ausentes, mas fornecer o -SkipTemplateParameterPrompt ignorará esse prompt e enviará um erro imediatamente se um parâmetro não estiver vinculado no modelo. Para scripts não interativos, -SkipTemplateParameterPrompt pode ser fornecido para fornecer uma mensagem de erro melhor no caso em que nem todos os parâmetros necessários são satisfeitos.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TemplateFile
Caminho local para o arquivo de modelo. Tipo de arquivo de modelo suportado: json e bíceps.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateObject
Uma tabela de hash que representa o modelo.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateParameterFile
Arquivo de parâmetro a ser usado para o modelo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateParameterObject
Uma tabela de hash que representa os parâmetros.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateParameterUri
Uri para o arquivo de parâmetro de modelo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateSpecId
ID do recurso do templateSpec a ser implantado.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TemplateUri
Uri para o arquivo de modelo.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Entradas
Saídas
Azure PowerShell
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários