Deployments - What If At Tenant Scope

Serviço:: Resource Management

Versão da API:: 2025-04-01

Retorna alterações que serão feitas pela implantação se executadas no escopo do grupo de locatários.

POST https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf?api-version=2025-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._]+$	O nome da implementação.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	O local para armazenar os dados de implantação.
properties	True	DeploymentWhatIfProperties	As propriedades de implantação.

Respostas

Nome	Tipo	Description
200 OK	WhatIfOperationResult	OK – Retorna o status da operação What-If
202 Accepted		Aceito – Retorna URL no cabeçalho Local para consultar o status da operação de execução prolongada. Cabeçalhos Location: string Retry-After: string
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

WhatIfOperationResult

OK – Retorna o status da operação What-If

202 Accepted

Aceito – Retorna URL no cabeçalho Local para consultar o status da operação de execução prolongada.

Cabeçalhos

Location: string
Retry-After: string

Other Status Codes

CloudError

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Predict template changes at management group scope

Solicitação de exemplo

POST https://management.azure.com/providers/Microsoft.Resources/deployments/exampleDeploymentName/whatIf?api-version=2025-04-01

{
  "location": "eastus",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}


import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentWhatIfProperties;
import com.azure.resourcemanager.resources.models.ScopedDeploymentWhatIf;
import com.azure.resourcemanager.resources.models.TemplateLink;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments WhatIfAtTenantScope.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PostDeploymentWhatIfOnTenant.json
     */
    /**
     * Sample code: Predict template changes at management group scope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        predictTemplateChangesAtManagementGroupScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().deploymentClient().getDeployments().whatIfAtTenantScope(
            "exampleDeploymentName",
            new ScopedDeploymentWhatIf().withLocation("eastus")
                .withProperties(new DeploymentWhatIfProperties()
                    .withTemplateLink(new TemplateLink().withUri("https://example.com/exampleTemplate.json"))
                    .withParameters(mapOf()).withMode(DeploymentMode.INCREMENTAL)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python post_deployment_what_if_on_tenant.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.deployments.begin_what_if_at_tenant_scope(
        deployment_name="exampleDeploymentName",
        parameters={
            "location": "eastus",
            "properties": {
                "mode": "Incremental",
                "parameters": {},
                "templateLink": {"uri": "https://example.com/exampleTemplate.json"},
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnTenant.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdeployments_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armdeployments"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/05809299e74fc16df7badbab3fb29e25da59f7d2/specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnTenant.json
func ExampleDeploymentsClient_BeginWhatIfAtTenantScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginWhatIfAtTenantScope(ctx, "exampleDeploymentName", armdeployments.ScopedDeploymentWhatIf{
		Location: to.Ptr("eastus"),
		Properties: &armdeployments.DeploymentWhatIfProperties{
			Mode:       to.Ptr(armdeployments.DeploymentModeIncremental),
			Parameters: map[string]*armdeployments.DeploymentParameter{},
			TemplateLink: &armdeployments.TemplateLink{
				URI: to.Ptr("https://example.com/exampleTemplate.json"),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.WhatIfOperationResult = armdeployments.WhatIfOperationResult{
	// 	Properties: &armdeployments.WhatIfOperationProperties{
	// 		Changes: []*armdeployments.WhatIfChange{
	// 			{
	// 				After: map[string]any{
	// 					"name": "myManagementGroup",
	// 					"type": "Microsoft.Management/managementGroups",
	// 					"apiVersion": "2019-11-01",
	// 					"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
	// 				},
	// 				ChangeType: to.Ptr(armdeployments.ChangeTypeCreate),
	// 				ResourceID: to.Ptr("/providers/Microsoft.Management/managementGroups/myManagementGroup"),
	// 		}},
	// 	},
	// 	Status: to.Ptr("Succeeded"),
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Returns changes that will be made by the deployment if executed at the scope of the tenant group.
 *
 * @summary Returns changes that will be made by the deployment if executed at the scope of the tenant group.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnTenant.json
 */
async function predictTemplateChangesAtManagementGroupScope() {
  const deploymentName = "exampleDeploymentName";
  const parameters = {
    location: "eastus",
    properties: {
      mode: "Incremental",
      parameters: {},
      templateLink: { uri: "https://example.com/exampleTemplate.json" },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential);
  const result = await client.deployments.beginWhatIfAtTenantScopeAndWait(
    deploymentName,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "status": "Succeeded",
  "properties": {
    "changes": [
      {
        "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
        "changeType": "Create",
        "after": {
          "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
          "apiVersion": "2019-11-01",
          "type": "Microsoft.Management/managementGroups",
          "name": "myManagementGroup"
        }
      }
    ]
  }
}

Código de status:: 202

Location: /subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Definições

Nome	Description
ChangeType	Tipo de alteração que será feita no recurso quando a implantação for executada.
CloudError	Uma resposta de erro para uma solicitação de gerenciamento de recursos.
DebugSetting	A configuração de depuração.
DeploymentDiagnosticsDefinition
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput	Entrada externa de implantação para parametrização.
DeploymentExternalInputDefinition	Definição de entrada externa de implantação para parametrização.
DeploymentMode	O modo usado para implantar recursos. Esse valor pode ser Incremental ou Concluído. No modo incremental, os recursos são implantados sem excluir recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer.
DeploymentParameter	Parâmetro de implantação para o modelo.
DeploymentWhatIfProperties	Propriedades what-if de implantação.
DeploymentWhatIfSettings	Configurações de operação de What-If de implantação.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse	Resposta de erro
ExpressionEvaluationOptions	Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado.
ExpressionEvaluationOptionsScopeType	O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.
ExtensionConfigPropertyType
KeyVaultParameterReference	Referência de parâmetro do Azure Key Vault.
KeyVaultReference	Referência do Azure Key Vault.
Level	Indica o nível de resposta adicional.
OnErrorDeployment	Implantação no comportamento de erro.
OnErrorDeploymentType	A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.
ParametersLink	Entidade que representa a referência aos parâmetros de implantação.
PropertyChangeType	O tipo de alteração de propriedade.
ScopedDeploymentWhatIf	Parâmetros de operação what-if de implantação.
TemplateLink	Entidade que representa a referência ao modelo.
ValidationLevel	O nível de validação executado na implantação.
WhatIfChange	Informações sobre uma única alteração de recurso prevista por What-If operação.
WhatIfOperationResult	Resultado da operação de What-If. Contém uma lista de alterações previstas e um link de URL para chegar ao próximo conjunto de resultados.
WhatIfPropertyChange	A alteração prevista para a propriedade do recurso.
WhatIfResultFormat	O formato dos resultados do What-If

ChangeType

Enumeração

Tipo de alteração que será feita no recurso quando a implantação for executada.

Valor	Description
Create	O recurso não existe no estado atual, mas está presente no estado desejado. O recurso será criado quando a implantação for executada.
Delete	O recurso existe no estado atual e está ausente do estado desejado. O recurso será excluído quando a implantação for executada.
Ignore	O recurso existe no estado atual e está ausente do estado desejado. O recurso não será implantado ou modificado quando a implantação for executada.
Deploy	O recurso existe no estado atual e no estado desejado e será reimplantado quando a implantação for executada. As propriedades do recurso podem ou não ser alteradas.
NoChange	O recurso existe no estado atual e no estado desejado e será reimplantado quando a implantação for executada. As propriedades do recurso não serão alteradas.
Modify	O recurso existe no estado atual e no estado desejado e será reimplantado quando a implantação for executada. As propriedades do recurso serão alteradas.
Unsupported	Não há suporte para o recurso no What-If.

CloudError

Objeto

Uma resposta de erro para uma solicitação de gerenciamento de recursos.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

DebugSetting

Objeto

A configuração de depuração.

Nome	Tipo	Description
detailLevel	string	Especifica o tipo de informação a ser registrada em log para depuração. Os valores permitidos são none, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. O padrão é nenhum. Ao definir esse valor, considere cuidadosamente o tipo de informação que você está passando durante a implantação. Ao registrar em log informações sobre a solicitação ou resposta, você pode potencialmente expor dados confidenciais recuperados por meio das operações de implantação.

DeploymentDiagnosticsDefinition

Objeto

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
level	Level	Indica o nível de resposta adicional.
message	string	A mensagem de erro.
target	string	O destino do erro.

DeploymentExtensionConfigItem

Objeto

Nome	Tipo	Description
keyVaultReference	KeyVaultParameterReference	A referência do Azure Key Vault usada para recuperar o valor secreto da propriedade de configuração de extensão.
type	ExtensionConfigPropertyType	O tipo de valor da propriedade de configuração de extensão.
value		O valor da propriedade de configuração de extensão.

DeploymentExtensionDefinition

Objeto

Nome	Tipo	Description
alias	string	O alias da extensão, conforme definido no modelo de implantação.
config	<string, DeploymentExtensionConfigItem>	A configuração da extensão.
configId	string	A ID de configuração da extensão. Ele identifica exclusivamente um plano de controle de implantação em uma extensão.
name	string	O nome da extensão.
version	string	A versão de extensão.

DeploymentExternalInput

Objeto

Entrada externa de implantação para parametrização.

Nome	Tipo	Description
value		Valor de entrada externo.

DeploymentExternalInputDefinition

Objeto

Definição de entrada externa de implantação para parametrização.

Nome	Tipo	Description
config		Configuração para a entrada externa.
kind	string	O tipo de entrada externa.

DeploymentMode

Enumeração

O modo usado para implantar recursos. Esse valor pode ser Incremental ou Concluído. No modo incremental, os recursos são implantados sem excluir recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer.

Valor	Description
Incremental
Complete

DeploymentParameter

Objeto

Parâmetro de implantação para o modelo.

Nome	Tipo	Description
expression	string	Expressão de entrada para o parâmetro.
reference	KeyVaultParameterReference	Referência de parâmetro do Azure Key Vault.
value		Insira o valor para o parâmetro .

DeploymentWhatIfProperties

Objeto

Propriedades what-if de implantação.

Nome	Tipo	Description
debugSetting	DebugSetting	A configuração de depuração da implantação.
expressionEvaluationOptions	ExpressionEvaluationOptions	Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado. Aplicável somente a modelos aninhados. Se não for especificado, o valor padrão será outer.
extensionConfigs	object	As configurações a serem usadas para extensões de implantação. As chaves desse objeto são aliases de extensão de implantação, conforme definido no modelo de implantação.
externalInputDefinitions	<string, DeploymentExternalInputDefinition>	Definições de entrada externa, usadas por ferramentas externas para definir valores de entrada externos esperados.
externalInputs	<string, DeploymentExternalInput>	Valores de entrada externos, usados por ferramentas externas para avaliação de parâmetros.
mode	DeploymentMode	O modo usado para implantar recursos. Esse valor pode ser Incremental ou Concluído. No modo incremental, os recursos são implantados sem excluir recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implantados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são excluídos. Tenha cuidado ao usar o modo Completo, pois você pode excluir recursos sem querer.
onErrorDeployment	OnErrorDeployment	A implantação no comportamento de erro.
parameters	<string, DeploymentParameter>	Pares de nome e valor que definem os parâmetros de implantação para o modelo. Use esse elemento quando quiser fornecer os valores de parâmetro diretamente na solicitação em vez de vincular a um arquivo de parâmetro existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia de caracteres JSON bem formada.
parametersLink	ParametersLink	O URI do arquivo de parâmetros. Use esse elemento para vincular a um arquivo de parâmetros existente. Use a propriedade parametersLink ou a propriedade parameters, mas não ambos.
template	object	O conteúdo do modelo. Use esse elemento quando quiser passar a sintaxe do modelo diretamente na solicitação em vez de vincular a um modelo existente. Pode ser uma cadeia de caracteres JObject ou JSON bem formada. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos.
templateLink	TemplateLink	O URI do modelo. Use a propriedade templateLink ou a propriedade de modelo, mas não ambos.
validationLevel	ValidationLevel	O nível de validação da implantação
whatIfSettings	DeploymentWhatIfSettings	Configurações opcionais de operação de What-If.

DeploymentWhatIfSettings

Objeto

Configurações de operação de What-If de implantação.

Nome	Tipo	Description
resultFormat	WhatIfResultFormat	O formato dos resultados do What-If

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ExpressionEvaluationOptions

Objeto

Especifica se as expressões de modelo são avaliadas dentro do escopo do modelo pai ou do modelo aninhado.

Nome	Tipo	Description
scope	ExpressionEvaluationOptionsScopeType	O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.

ExpressionEvaluationOptionsScopeType

Enumeração

O escopo a ser usado para avaliação de parâmetros, variáveis e funções em um modelo aninhado.

Valor	Description
NotSpecified
Outer
Inner

ExtensionConfigPropertyType

Enumeração

Valor	Description
String	Tipo de propriedade que representa um valor de cadeia de caracteres.
Int	Tipo de propriedade que representa um valor inteiro.
Bool	Tipo de propriedade que representa um valor booleano.
Array	Tipo de propriedade que representa um valor de matriz.
Object	Tipo de propriedade que representa um valor de objeto.
SecureString	Tipo de propriedade que representa um valor de cadeia de caracteres segura.
SecureObject	Tipo de propriedade que representa um valor de objeto seguro.

KeyVaultParameterReference

Objeto

Referência de parâmetro do Azure Key Vault.

Nome	Tipo	Description
keyVault	KeyVaultReference	Referência do Azure Key Vault.
secretName	string	Nome do segredo do Azure Key Vault.
secretVersion	string	Versão secreta do Azure Key Vault.

KeyVaultReference

Objeto

Referência do Azure Key Vault.

Nome	Tipo	Description
id	string	ID do recurso do Azure Key Vault.

Level

Enumeração

Indica o nível de resposta adicional.

Valor	Description
Warning
Info
Error

OnErrorDeployment

Objeto

Implantação no comportamento de erro.

Nome	Tipo	Description
deploymentName	string	A implantação a ser usada no caso de erro.
type	OnErrorDeploymentType	A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

OnErrorDeploymentType

Enumeração

A implantação no tipo de comportamento de erro. Os valores possíveis são LastSuccessful e SpecificDeployment.

Valor	Description
LastSuccessful
SpecificDeployment

ParametersLink

Objeto

Entidade que representa a referência aos parâmetros de implantação.

Nome	Tipo	Description
contentVersion	string	Se incluído, deverá corresponder ao ContentVersion no modelo.
uri	string	O URI do arquivo de parâmetros.

PropertyChangeType

Enumeração

O tipo de alteração de propriedade.

Valor	Description
Create	A propriedade não existe no estado atual, mas está presente no estado desejado. A propriedade será criada quando a implantação for executada.
Delete	A propriedade existe no estado atual e está ausente do estado desejado. Ele será excluído quando a implantação for executada.
Modify	A propriedade existe no estado atual e desejado e é diferente. O valor da propriedade será alterado quando a implantação for executada.
Array	A propriedade é uma matriz e contém alterações aninhadas.
NoEffect	A propriedade não será definida ou atualizada.

ScopedDeploymentWhatIf

Objeto

Parâmetros de operação what-if de implantação.

Nome	Tipo	Description
location	string	O local para armazenar os dados de implantação.
properties	DeploymentWhatIfProperties	As propriedades de implantação.

TemplateLink

Objeto

Entidade que representa a referência ao modelo.

Nome	Tipo	Description
contentVersion	string	Se incluído, deverá corresponder ao ContentVersion no modelo.
id	string	A ID de recurso de uma Especificação de Modelo. Use a propriedade id ou uri, mas não ambas.
queryString	string	A cadeia de caracteres de consulta (por exemplo, um token SAS) a ser usada com o URI templateLink.
relativePath	string	A propriedade relativePath pode ser usada para implantar um modelo vinculado em um local relativo ao pai. Se o modelo pai estiver vinculado a um TemplateSpec, isso fará referência a um artefato no TemplateSpec. Se o pai estiver vinculado a um URI, a implantação filho será uma combinação das URIs pai e relativePath
uri	string	O URI do modelo a ser implantado. Use a propriedade uri ou id, mas não ambos.

ValidationLevel

Enumeração

O nível de validação executado na implantação.

Valor	Description
Template	A análise estática do modelo é executada.
Provider	A análise estática do modelo é executada e as declarações de recursos são enviadas aos provedores de recursos para validação semântica. Valida se o chamador tem permissões de gravação RBAC em cada recurso.
ProviderNoRbac	A análise estática do modelo é executada e as declarações de recursos são enviadas aos provedores de recursos para validação semântica. Ignora a validação de que o chamador tem permissões de gravação RBAC em cada recurso.

WhatIfChange

Objeto

Informações sobre uma única alteração de recurso prevista por What-If operação.

Nome	Tipo	Description
after	object	O instantâneo previsto do recurso após a execução da implantação.
before	object	O instantâneo do recurso antes da implantação ser executada.
changeType	ChangeType	Tipo de alteração que será feita no recurso quando a implantação for executada.
delta	WhatIfPropertyChange[]	As alterações previstas nas propriedades do recurso.
deploymentId	string	A ID do recurso da implantação responsável por essa alteração.
extension	DeploymentExtensionDefinition	A extensão com a qual o recurso foi implantado.
identifiers	object	Um subconjunto de propriedades que identificam exclusivamente um recurso extensível do Bicep porque ele não tem uma ID de recurso como um recurso do Azure.
resourceId	string	ID de Recurso
symbolicName	string	O nome simbólico do recurso responsável por essa alteração.
unsupportedReason	string	A explicação sobre por que o recurso não tem suporte do What-If.

WhatIfOperationResult

Objeto

Resultado da operação de What-If. Contém uma lista de alterações previstas e um link de URL para chegar ao próximo conjunto de resultados.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Erro quando What-If operação falhar.
properties.changes	WhatIfChange[]	Lista de alterações de recursos previstas por What-If operação.
properties.diagnostics	DeploymentDiagnosticsDefinition[]	Lista de diagnósticos de recursos detectados por What-If operação.
properties.potentialChanges	WhatIfChange[]	Lista de alterações de recursos previstas por What-If operação.
status	string	Status da operação de What-If.

WhatIfPropertyChange

Objeto

A alteração prevista para a propriedade do recurso.

Nome	Tipo	Description
after	object	O valor da propriedade após a execução da implantação.
before	object	O valor da propriedade antes da implantação ser executada.
children	WhatIfPropertyChange[]	Alterações de propriedade aninhadas.
path	string	O caminho da propriedade.
propertyChangeType	PropertyChangeType	O tipo de alteração de propriedade.

WhatIfResultFormat

Enumeração

O formato dos resultados do What-If

Valor	Description
ResourceIdOnly
FullResourcePayloads

Compartilhar via

Deployments - What If At Tenant Scope

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Predict template changes at management group scope

Solicitação de exemplo

Resposta de exemplo

Definições

ChangeType

CloudError

DebugSetting

DeploymentDiagnosticsDefinition

DeploymentExtensionConfigItem

DeploymentExtensionDefinition

DeploymentExternalInput

DeploymentExternalInputDefinition

DeploymentMode

DeploymentParameter

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

ExtensionConfigPropertyType

KeyVaultParameterReference

KeyVaultReference

Level

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

ValidationLevel

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat