Deployments - What If At Tenant Scope

Referência

Service:: Resource Management

API Version:: 2021-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=2021-04-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description

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

deploymentName

path

True

string

O nome da implantação.

Regex pattern: ^[-\w\._]+$

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 status de operação de What-If
202 Accepted		Aceito – retorna a URL no cabeçalho Local para consultar a operação de execução prolongada status. Headers 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 status de operação de What-If

202 Accepted

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

Headers

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 do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Predict template changes at management group scope

Sample Request

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

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

package armresources_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/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-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 := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginWhatIfAtTenantScope(ctx, "exampleDeploymentName", armresources.ScopedDeploymentWhatIf{
		Location: to.Ptr("eastus"),
		Properties: &armresources.DeploymentWhatIfProperties{
			Mode:         to.Ptr(armresources.DeploymentModeIncremental),
			Parameters:   map[string]any{},
			TemplateLink: &armresources.TemplateLink{},
		},
	}, 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 = armresources.WhatIfOperationResult{
	// 	Properties: &armresources.WhatIfOperationProperties{
	// 		Changes: []*armresources.WhatIfChange{
	// 			{
	// 				After: map[string]any{
	// 					"name": "myManagementGroup",
	// 					"type": "Microsoft.Management/managementGroups",
	// 					"apiVersion": "2019-11-01",
	// 					"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
	// 				},
	// 				ChangeType: to.Ptr(armresources.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 { ResourceManagementClient } = require("@azure/arm-resources");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * 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/stable/2021-04-01/examples/PostDeploymentWhatIfOnTenant.json
 */
async function predictTemplateChangesAtManagementGroupScope() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const deploymentName = "exampleDeploymentName";
  const parameters = {
    location: "eastus",
    properties: { mode: "Incremental", parameters: {}, templateLink: {} },
  };
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  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

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnTenant.json
// this example is just showing the usage of "Deployments_WhatIfAtTenantScope" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ArmDeploymentResource created on azure
// for more information of creating ArmDeploymentResource, please refer to the document of ArmDeploymentResource
string scope = $"/";
string deploymentName = "exampleDeploymentName";
ResourceIdentifier armDeploymentResourceId = ArmDeploymentResource.CreateResourceIdentifier(scope, deploymentName);
ArmDeploymentResource armDeployment = client.GetArmDeploymentResource(armDeploymentResourceId);

// invoke the operation
ArmDeploymentWhatIfContent content = new ArmDeploymentWhatIfContent(new ArmDeploymentWhatIfProperties(ArmDeploymentMode.Incremental)
{
    TemplateLink = null,
    Parameters = BinaryData.FromObjectAsJson(new Dictionary<string, object>()
    {
    }),
})
{
    Location = new AzureLocation("eastus"),
};
ArmOperation<WhatIfOperationResult> lro = await armDeployment.WhatIfAsync(WaitUntil.Completed, content);
WhatIfOperationResult result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

Sample Response

Status code:: 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"
        }
      }
    ]
  }
}

Status code:: 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.
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 os 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 involuntariamente os recursos.
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.
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 para o modelo.
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

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

Nome	Tipo	Description
Create	string	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	string	O recurso existe no estado atual e está ausente do estado desejado. O recurso será excluído quando a implantação for executada.
Deploy	string	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.
Ignore	string	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.
Modify	string	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.
NoChange	string	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.
Unsupported	string	O recurso não tem suporte no What-If.

CloudError

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 para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.)

DebugSetting

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 é none. Ao definir esse valor, considere cuidadosamente o tipo de informação que você está passando durante a implantação. Ao registrar em log as informações sobre a solicitação ou resposta, você pode potencialmente expor dados confidenciais que são recuperados por meio de operações de implantaçã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 os 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 involuntariamente os recursos.

Nome	Tipo	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

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á externo.
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 os 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 involuntariamente os recursos.
onErrorDeployment	OnErrorDeployment	A implantação no comportamento de erro.
parameters	object	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. Você usa esse elemento quando deseja passar a sintaxe de modelo diretamente na solicitação em vez de vincular a um modelo existente. Pode ser uma cadeia de caracteres JSON JObject ou bem formada. Use a propriedade templateLink ou a propriedade template, mas não ambos.
templateLink	TemplateLink	O URI do modelo. Use a propriedade templateLink ou a propriedade template, mas não ambos.
whatIfSettings	DeploymentWhatIfSettings	Configurações opcionais de operação de What-If.

DeploymentWhatIfSettings

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

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

ErrorAdditionalInfo

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

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

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

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

Nome	Tipo	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

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

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

Nome	Tipo	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

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

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

PropertyChangeType

O tipo de alteração de propriedade.

Nome	Tipo	Description
Array	string	A propriedade é uma matriz e contém alterações aninhadas.
Create	string	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	string	A propriedade existe no estado atual e está ausente do estado desejado. Ele será excluído quando a implantação for executada.
Modify	string	A propriedade existe no estado atual e desejado e é diferente. O valor da propriedade será alterado quando a implantação for executada.
NoEffect	string	A propriedade não será definida ou atualizada.

ScopedDeploymentWhatIf

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

Entidade que representa a referência para o modelo.

Nome	Tipo	Description
contentVersion	string	Se incluído, deve 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 tiver sido vinculado a um TemplateSpec, isso fará referência a um artefato no TemplateSpec. Se o pai tiver sido vinculado a um URI, a implantação filho será uma combinação dos URIs pai e relativePath
uri	string	O URI do modelo a ser implantado. Use a propriedade uri ou id, mas não ambos.

WhatIfChange

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.
resourceId	string	ID de Recurso
unsupportedReason	string	A explicação sobre por que o recurso não tem suporte pelo What-If.

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.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro Erro quando What-If operação falha.
properties.changes	WhatIfChange[]	Lista de alterações de recursos previstas por What-If operação.
status	string	Status da operação de What-If.

WhatIfPropertyChange

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

Nome	Tipo	Description
after	object	O valor da propriedade após a implantação ser executada.
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

O formato dos resultados do What-If

Nome	Tipo	Description
FullResourcePayloads	string
ResourceIdOnly	string

Compartilhar via

Deployments - What If At Tenant Scope

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

Predict template changes at management group scope

Sample Request

Sample Response

Definições

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Recursos adicionais