Deployments - What If At Tenant Scope

Referência

Service:: Resource Management

API Version:: 2021-04-01

Devolve as alterações que serão efetuadas pela implementação se forem executadas no âmbito do grupo de inquilinos.

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

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
deploymentName	path	True	string	O nome da implementação. Regex pattern: `^[-\w\._\(\)]+$`
api-version	query	True	string	A versão da API a utilizar para esta operação.

deploymentName

path

True

string

O nome da implementação.

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

api-version

query

True

string

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
location	True	string	A localização para armazenar os dados de implementação.
properties	True	DeploymentWhatIfProperties	As propriedades de implementação.

Respostas

Name	Tipo	Description
200 OK	WhatIfOperationResult	OK - Devolve What-If estado da operação
202 Accepted		Aceite - Devolve URL no cabeçalho Localização para consultar o estado da operação de execução prolongada. Headers Location: string Retry-After: string
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Name

Tipo

Description

200 OK

WhatIfOperationResult

OK - Devolve What-If estado da operação

202 Accepted

Aceite - Devolve URL no cabeçalho Localização para consultar o estado da operação de execução prolongada.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

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

Name	Description
ChangeType	Tipo de alteração que será efetuada ao recurso quando a implementação for executada.
CloudError	Uma resposta de erro para um pedido de gestão de recursos.
DebugSetting	A definição de depuração.
DeploymentMode	O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o Modo completo, uma vez que pode eliminar recursos involuntariamente.
DeploymentWhatIfProperties	Propriedades what-if da implementação.
DeploymentWhatIfSettings	Implementação What-If definições de operação.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	Resposta a Erros
ExpressionEvaluationOptions	Especifica se as expressões de modelo são avaliadas no âmbito do modelo principal ou do modelo aninhado.
ExpressionEvaluationOptionsScopeType	O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.
OnErrorDeployment	Implementação no comportamento do erro.
OnErrorDeploymentType	A implementaçã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 implementação.
PropertyChangeType	O tipo de propriedade é alterado.
ScopedDeploymentWhatIf	Parâmetros de operação What-if da Implementação.
TemplateLink	Entidade que representa a referência ao modelo.
WhatIfChange	Informações sobre uma única alteração de recurso prevista pela operação de What-If.
WhatIfOperationResult	Resultado da operação de What-If. Contém uma lista de alterações previstas e uma ligação de URL para aceder 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á efetuada ao recurso quando a implementação for executada.

Name	Tipo	Description
Create	string	O recurso não existe no estado atual, mas está presente no estado pretendido. O recurso será criado quando a implementação for executada.
Delete	string	O recurso existe no estado atual e está em falta no estado pretendido. O recurso será eliminado quando a implementação for executada.
Deploy	string	O recurso existe no estado atual e no estado pretendido e será reimplementado quando a implementação for executada. As propriedades do recurso podem ou não ser alteradas.
Ignore	string	O recurso existe no estado atual e está em falta no estado pretendido. O recurso não será implementado nem modificado quando a implementação for executada.
Modify	string	O recurso existe no estado atual e no estado pretendido e será reimplementado quando a implementação for executada. As propriedades do recurso serão alteradas.
NoChange	string	O recurso existe no estado atual e no estado pretendido e será reimplementado quando a implementação for executada. As propriedades do recurso não serão alteradas.
Unsupported	string	O recurso não é suportado pelo What-If.

CloudError

Uma resposta de erro para um pedido de gestão de recursos.

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Resposta de erro comum para todas as APIs Resource Manager do Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros OData.)

DebugSetting

A definição de depuração.

Name	Tipo	Description
detailLevel	string	Especifica o tipo de informações a registar para depuração. Os valores permitidos não são nenhum, requestContent, responseContent ou requestContent e responseContent separados por uma vírgula. A predefinição é Nenhum. Ao definir este valor, considere cuidadosamente o tipo de informação que está a transmitir durante a implementação. Ao registar informações sobre o pedido ou a resposta, pode potencialmente expor dados confidenciais obtidos através das operações de implementação.

DeploymentMode

O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o Modo completo, uma vez que pode eliminar recursos involuntariamente.

Name	Tipo	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

Propriedades what-if da implementação.

Name	Tipo	Description
debugSetting	DebugSetting	A definição de depuração da implementação.
expressionEvaluationOptions	ExpressionEvaluationOptions	Especifica se as expressões de modelo são avaliadas no âmbito do modelo principal ou do modelo aninhado. Aplicável apenas a modelos aninhados. Se não for especificado, o valor predefinido é externo.
mode	DeploymentMode	O modo utilizado para implementar recursos. Este valor pode ser Incremental ou Complete. No modo Incremental, os recursos são implementados sem eliminar recursos existentes que não estão incluídos no modelo. No modo Completo, os recursos são implementados e os recursos existentes no grupo de recursos que não estão incluídos no modelo são eliminados. Tenha cuidado ao utilizar o Modo completo, uma vez que pode eliminar recursos involuntariamente.
onErrorDeployment	OnErrorDeployment	A implementação no comportamento do erro.
parameters	object	Pares de nomes e valores que definem os parâmetros de implementação do modelo. Utilize este elemento quando pretender fornecer os valores de parâmetros diretamente no pedido em vez de ligar a um ficheiro de parâmetro existente. Utilize a propriedade parametersLink ou a propriedade parameters, mas não ambos. Pode ser um JObject ou uma cadeia JSON bem formada.
parametersLink	ParametersLink	O URI do ficheiro de parâmetros. Utilize este elemento para ligar a um ficheiro de parâmetros existente. Utilize a propriedade parametersLink ou a propriedade parameters, mas não ambos.
template	object	O conteúdo do modelo. Utilize este elemento quando pretender transmitir a sintaxe do modelo diretamente no pedido em vez de ligar a um modelo existente. Pode ser uma cadeia JObject ou JSON bem formada. Utilize a propriedade templateLink ou a propriedade do modelo, mas não ambas.
templateLink	TemplateLink	O URI do modelo. Utilize a propriedade templateLink ou a propriedade do modelo, mas não ambas.
whatIfSettings	DeploymentWhatIfSettings	Opcionais What-If definições de operação.

DeploymentWhatIfSettings

Implementação What-If definições de operação.

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

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorResponse

Resposta a Erros

Name	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 no âmbito do modelo principal ou do modelo aninhado.

Name	Tipo	Description
scope	ExpressionEvaluationOptionsScopeType	O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.

ExpressionEvaluationOptionsScopeType

O âmbito a utilizar para a avaliação de parâmetros, variáveis e funções num modelo aninhado.

Name	Tipo	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Implementação no comportamento do erro.

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

OnErrorDeploymentType

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

Name	Tipo	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

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

Name	Tipo	Description
contentVersion	string	Se estiver incluído, tem de corresponder ao ContentVersion no modelo.
uri	string	O URI do ficheiro de parâmetros.

PropertyChangeType

O tipo de propriedade é alterado.

Name	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 pretendido. A propriedade será criada quando a implementação for executada.
Delete	string	A propriedade existe no estado atual e está em falta no estado pretendido. Será eliminado quando a implementação for executada.
Modify	string	A propriedade existe no estado atual e pretendido e é diferente. O valor da propriedade será alterado quando a implementação for executada.
NoEffect	string	A propriedade não será definida nem atualizada.

ScopedDeploymentWhatIf

Parâmetros de operação What-if da Implementação.

Name	Tipo	Description
location	string	A localização para armazenar os dados de implementação.
properties	DeploymentWhatIfProperties	As propriedades de implementação.

TemplateLink

Entidade que representa a referência ao modelo.

Name	Tipo	Description
contentVersion	string	Se estiver incluído, tem de corresponder ao ContentVersion no modelo.
id	string	O ID de recurso de uma Especificação de Modelo. Utilize a propriedade ID ou URI, mas não ambas.
queryString	string	A cadeia de consulta (por exemplo, um token de SAS) a ser utilizada com o URI de templateLink.
relativePath	string	A propriedade relativePath pode ser utilizada para implementar um modelo ligado numa localização relativa ao principal. Se o modelo principal estiver ligado a um TemplateSpec, isto fará referência a um artefacto no TemplateSpec. Se o elemento principal tiver sido associado a um URI, a implementação subordinada será uma combinação dos URIs principal e relativePath
uri	string	O URI do modelo a implementar. Utilize a propriedade uri ou id, mas não ambas.

WhatIfChange

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

Name	Tipo	Description
after	object	O instantâneo previsto do recurso após a implementação ser executada.
before	object	O instantâneo do recurso antes da implementação ser executada.
changeType	ChangeType	Tipo de alteração que será efetuada ao recurso quando a implementação for executada.
delta	WhatIfPropertyChange[]	As alterações previstas às propriedades dos recursos.
resourceId	string	ID do Recurso
unsupportedReason	string	A explicação sobre o motivo pelo qual o recurso não é suportado pelo What-If.

WhatIfOperationResult

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

Name	Tipo	Description
error	ErrorResponse	Resposta a Erros Erro ao What-If operação falhar.
properties.changes	WhatIfChange[]	Lista de alterações de recursos previstas pela operação de What-If.
status	string	Estado da operação de What-If.

WhatIfPropertyChange

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

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

WhatIfResultFormat

O formato dos resultados do What-If

Name	Tipo	Description
FullResourcePayloads	string
ResourceIdOnly	string

Deployments - What If At Tenant Scope

Parâmetros do URI

Corpo do Pedido

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