Deployments - What If At Tenant Scope

Referencia

Servicio:: Resource Management

Versión de la API:: 2021-04-01

Devuelve los cambios que realizará la implementación si se ejecuta en el ámbito del grupo de inquilinos.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description

Nombre	En	Requerido	Tipo	Description
deploymentName	path	True	string	Nombre de la implementación. Patrón de Regex: `^[-\w\._\(\)]+$`
api-version	query	True	string	Versión de API que se usará para la operación.

deploymentName

path

True

string

Nombre de la implementación.

Patrón de Regex: ^[-\w\._]+$

api-version

query

True

string

Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación para almacenar los datos de implementación.
properties	True	DeploymentWhatIfProperties	Propiedades de implementación.

Respuestas

Nombre	Tipo	Description
200 OK	WhatIfOperationResult	Aceptar: devuelve What-If estado de la operación.
202 Accepted		Aceptado: devuelve la dirección URL en el encabezado Location para consultar el estado de la operación de ejecución prolongada. Encabezados Location: string Retry-After: string
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Nombre

Tipo

Description

200 OK

WhatIfOperationResult

Aceptar: devuelve What-If estado de la operación.

202 Accepted

Aceptado: devuelve la dirección URL en el encabezado Location para consultar el estado de la operación de ejecución prolongada.

Encabezados

Location: string
Retry-After: string

Other Status Codes

CloudError

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Predict template changes at management group scope

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
ChangeType	Tipo de cambio que se realizará en el recurso cuando se ejecute la implementación.
CloudError	Respuesta de error para una solicitud de administración de recursos.
DebugSetting	Configuración de depuración.
DeploymentMode	Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.
DeploymentWhatIfProperties	Propiedades what-if de implementación.
DeploymentWhatIfSettings	Configuración de la operación de What-If de implementación.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
ExpressionEvaluationOptions	Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada.
ExpressionEvaluationOptionsScopeType	Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.
OnErrorDeployment	Implementación en el comportamiento de error.
OnErrorDeploymentType	La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.
ParametersLink	Entidad que representa la referencia a los parámetros de implementación.
PropertyChangeType	Tipo de cambio de propiedad.
ScopedDeploymentWhatIf	Parámetros de operación hipotética de implementación.
TemplateLink	Entidad que representa la referencia a la plantilla.
WhatIfChange	Información sobre un único cambio de recursos previsto por What-If operación.
WhatIfOperationResult	Resultado de la operación de What-If. Contiene una lista de cambios previstos y un vínculo de dirección URL para obtener el siguiente conjunto de resultados.
WhatIfPropertyChange	Cambio previsto en la propiedad de recurso.
WhatIfResultFormat	El formato de los resultados de la What-If

ChangeType

Tipo de cambio que se realizará en el recurso cuando se ejecute la implementación.

Nombre	Tipo	Description
Create	string	El recurso no existe en el estado actual, pero está presente en el estado deseado. El recurso se creará cuando se ejecute la implementación.
Delete	string	El recurso existe en el estado actual y falta en el estado deseado. El recurso se eliminará cuando se ejecute la implementación.
Deploy	string	El recurso existe en el estado actual y el estado deseado y se volverá a implementar cuando se ejecute la implementación. Es posible que las propiedades del recurso cambien o no.
Ignore	string	El recurso existe en el estado actual y falta en el estado deseado. El recurso no se implementará ni modificará cuando se ejecute la implementación.
Modify	string	El recurso existe en el estado actual y el estado deseado y se volverá a implementar cuando se ejecute la implementación. Las propiedades del recurso cambiarán.
NoChange	string	El recurso existe en el estado actual y el estado deseado y se volverá a implementar cuando se ejecute la implementación. Las propiedades del recurso no cambiarán.
Unsupported	string	El recurso no es compatible con What-If.

CloudError

Respuesta de error para una solicitud de administración de recursos.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

DebugSetting

Configuración de depuración.

Nombre	Tipo	Description
detailLevel	string	Especifica el tipo de información que se va a registrar para la depuración. Los valores permitidos son none, requestContent, responseContent o requestContent y responseContent separados por una coma. El valor predeterminado es none. Al establecer este valor, tenga en cuenta cuidadosamente el tipo de información que está pasando durante la implementación. Al registrar información sobre la solicitud o la respuesta, se podrían exponer datos confidenciales que se recuperan en las operaciones de implementación.

DeploymentMode

Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.

Nombre	Tipo	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

Propiedades what-if de implementación.

Nombre	Tipo	Description
debugSetting	DebugSetting	Configuración de depuración de la implementación.
expressionEvaluationOptions	ExpressionEvaluationOptions	Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada. Solo se aplica a las plantillas anidadas. Si no se especifica, el valor predeterminado es externo.
mode	DeploymentMode	Modo que se usa para implementar recursos. Este valor puede ser Incremental o Complete. En el modo Incremental, los recursos se implementan sin eliminar los recursos existentes que no están incluidos en la plantilla. En el modo Completo, los recursos se implementan y se eliminan los recursos existentes del grupo de recursos que no están incluidos en la plantilla. Tenga cuidado al usar el modo Completo, ya que puede eliminar accidentalmente los recursos.
onErrorDeployment	OnErrorDeployment	Implementación en el comportamiento de error.
parameters	object	Pares de nombre y valor que definen los parámetros de implementación de la plantilla. Use este elemento cuando desee proporcionar los valores de parámetro directamente en la solicitud en lugar de vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas. Puede ser un JObject o una cadena JSON bien formada.
parametersLink	ParametersLink	URI del archivo de parámetros. Este elemento se usa para vincular a un archivo de parámetros existente. Use la propiedad parametersLink o la propiedad parameters, pero no ambas.
template	object	El contenido de la plantilla. Este elemento se usa cuando se desea pasar la sintaxis de plantilla directamente en la solicitud en lugar de vincular a una plantilla existente. Puede ser un JObject o una cadena JSON bien formada. Use la propiedad templateLink o la propiedad template, pero no ambas.
templateLink	TemplateLink	URI de la plantilla. Use la propiedad templateLink o la propiedad template, pero no ambas.
whatIfSettings	DeploymentWhatIfSettings	Configuración opcional de la operación de What-If.

DeploymentWhatIfSettings

Configuración de la operación de What-If de implementación.

Nombre	Tipo	Description
resultFormat	WhatIfResultFormat	El formato de los resultados de la What-If

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ExpressionEvaluationOptions

Especifica si las expresiones de plantilla se evalúan dentro del ámbito de la plantilla primaria o de la plantilla anidada.

Nombre	Tipo	Description
scope	ExpressionEvaluationOptionsScopeType	Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.

ExpressionEvaluationOptionsScopeType

Ámbito que se va a usar para la evaluación de parámetros, variables y funciones en una plantilla anidada.

Nombre	Tipo	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Implementación en el comportamiento de error.

Nombre	Tipo	Description
deploymentName	string	Implementación que se usará en caso de error.
type	OnErrorDeploymentType	La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.

OnErrorDeploymentType

La implementación en el tipo de comportamiento de error. Los valores posibles son LastSuccessful y SpecificDeployment.

Nombre	Tipo	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entidad que representa la referencia a los parámetros de implementación.

Nombre	Tipo	Description
contentVersion	string	Si se incluye, debe coincidir con contentVersion en la plantilla.
uri	string	URI del archivo de parámetros.

PropertyChangeType

Tipo de cambio de propiedad.

Nombre	Tipo	Description
Array	string	La propiedad es una matriz y contiene cambios anidados.
Create	string	La propiedad no existe en el estado actual, pero está presente en el estado deseado. La propiedad se creará cuando se ejecute la implementación.
Delete	string	La propiedad existe en el estado actual y falta en el estado deseado. Se eliminará cuando se ejecute la implementación.
Modify	string	La propiedad existe en el estado actual y deseado y es diferente. El valor de la propiedad cambiará cuando se ejecute la implementación.
NoEffect	string	La propiedad no se establecerá ni actualizará.

ScopedDeploymentWhatIf

Parámetros de operación hipotética de implementación.

Nombre	Tipo	Description
location	string	Ubicación donde se almacenarán los datos de implementación.
properties	DeploymentWhatIfProperties	Propiedades de implementación.

TemplateLink

Entidad que representa la referencia a la plantilla.

Nombre	Tipo	Description
contentVersion	string	Si se incluye, debe coincidir con contentVersion en la plantilla.
id	string	Identificador de recurso de una especificación de plantilla. Use la propiedad id o uri, pero no ambas.
queryString	string	Cadena de consulta (por ejemplo, un token de SAS) que se usará con el URI templateLink.
relativePath	string	La propiedad relativePath se puede usar para implementar una plantilla vinculada en una ubicación relativa al elemento primario. Si la plantilla primaria estaba vinculada a templateSpec, hará referencia a un artefacto en TemplateSpec. Si el elemento primario estaba vinculado a un URI, la implementación secundaria será una combinación de los URI primarios y relativePath.
uri	string	URI de la plantilla que se va a implementar. Use la propiedad URI o id, pero no ambas.

WhatIfChange

Información sobre un único cambio de recursos previsto por What-If operación.

Nombre	Tipo	Description
after	object	Instantánea prevista del recurso después de ejecutar la implementación.
before	object	Instantánea del recurso antes de ejecutar la implementación.
changeType	ChangeType	Tipo de cambio que se realizará en el recurso cuando se ejecute la implementación.
delta	WhatIfPropertyChange[]	Los cambios previstos en las propiedades de los recursos.
resourceId	string	Id. de recurso
unsupportedReason	string	La explicación sobre por qué el recurso no es compatible con What-If.

WhatIfOperationResult

Resultado de la operación de What-If. Contiene una lista de cambios previstos y un vínculo de dirección URL para obtener el siguiente conjunto de resultados.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Error cuando se produce un error en la operación de What-If.
properties.changes	WhatIfChange[]	Lista de cambios de recursos previstos por What-If operación.
status	string	Estado de la operación de What-If.

WhatIfPropertyChange

Cambio previsto en la propiedad de recurso.

Nombre	Tipo	Description
after	object	Valor de la propiedad después de ejecutar la implementación.
before	object	Valor de la propiedad antes de ejecutar la implementación.
children	WhatIfPropertyChange[]	Cambios en la propiedad anidada.
path	string	Ruta de acceso de la propiedad.
propertyChangeType	PropertyChangeType	Tipo de cambio de propiedad.

WhatIfResultFormat

El formato de los resultados de la What-If

Nombre	Tipo	Description
FullResourcePayloads	string
ResourceIdOnly	string

Compartir a través de

Deployments - What If At Tenant Scope

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Predict template changes at management group scope

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Recursos adicionales