Deployments - What If At Tenant Scope

Référence

Service:: Resource Management

Version d'API:: 2021-04-01

Retourne les modifications qui seront apportées par le déploiement s’ils sont exécutés dans l’étendue du groupe de locataires.

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

Paramètres URI

Nom Dans Obligatoire Type Description

Nom	Dans	Obligatoire	Type	Description
deploymentName	path	True	string	Le nom du déploiement. Modèle d’expression régulière: `^[-\w\._\(\)]+$`
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

deploymentName

path

True

string

Le nom du déploiement.

Modèle d’expression régulière: ^[-\w\._]+$

api-version

query

True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
location	True	string	Emplacement où stocker les données de déploiement.
properties	True	DeploymentWhatIfProperties	Propriétés de déploiement.

Réponses

Nom	Type	Description
200 OK	WhatIfOperationResult	OK : retourne What-If status d’opération
202 Accepted		Accepté : retourne l’URL dans l’en-tête Location pour interroger les status d’opération de longue durée. En-têtes Location: string Retry-After: string
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Nom

Type

Description

200 OK

WhatIfOperationResult

OK : retourne What-If status d’opération

202 Accepted

Accepté : retourne l’URL dans l’en-tête Location pour interroger les status d’opération de longue durée.

En-têtes

Location: string
Retry-After: string

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Predict template changes at management group scope

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
        }
      }
    ]
  }
}

Code d’état:: 202

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

Définitions

Nom	Description
ChangeType	Type de modification qui sera apportée à la ressource lors de l’exécution du déploiement.
CloudError	Réponse d’erreur pour une demande de gestion des ressources.
DebugSetting	Paramètre de débogage.
DeploymentMode	Mode utilisé pour déployer des ressources. Cette valeur peut être Incrémentielle ou Terminée. En mode incrémentiel, les ressources sont déployées sans supprimer de ressources existantes non incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes du groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Soyez prudent lorsque vous utilisez le mode Complet, car vous pouvez supprimer involontairement des ressources.
DeploymentWhatIfProperties	Propriétés de scénario de déploiement.
DeploymentWhatIfSettings	Paramètres d’opération de déploiement What-If.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorResponse	Réponse d’erreur
ExpressionEvaluationOptions	Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué.
ExpressionEvaluationOptionsScopeType	Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué.
OnErrorDeployment	Déploiement en cas d’erreur.
OnErrorDeploymentType	Type de comportement de déploiement en cas d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.
ParametersLink	Entité représentant la référence aux paramètres de déploiement.
PropertyChangeType	Type de modification de propriété.
ScopedDeploymentWhatIf	Paramètres de l’opération de simulation de déploiement.
TemplateLink	Entité représentant la référence au modèle.
WhatIfChange	Informations sur un changement de ressource unique prédit par What-If opération.
WhatIfOperationResult	Résultat de l’opération What-If. Contient une liste des modifications prédites et un lien URL pour accéder au jeu de résultats suivant.
WhatIfPropertyChange	Modification prédite de la propriété de ressource.
WhatIfResultFormat	Format des résultats What-If

ChangeType

Type de modification qui sera apportée à la ressource lors de l’exécution du déploiement.

Nom	Type	Description
Create	string	La ressource n’existe pas dans l’état actuel, mais elle est présente dans l’état souhaité. La ressource est créée lors de l’exécution du déploiement.
Delete	string	La ressource existe dans l’état actuel et est absente de l’état souhaité. La ressource est supprimée lors de l’exécution du déploiement.
Deploy	string	La ressource existe dans l’état actuel et l’état souhaité, et sera redéployée lors de l’exécution du déploiement. Il est possible que les propriétés de la ressource changent.
Ignore	string	La ressource existe dans l’état actuel et est absente de l’état souhaité. La ressource ne sera pas déployée ou modifiée lors de l’exécution du déploiement.
Modify	string	La ressource existe dans l’état actuel et l’état souhaité, et sera redéployée lors de l’exécution du déploiement. Les propriétés de la ressource changeront.
NoChange	string	La ressource existe dans l’état actuel et l’état souhaité, et sera redéployée lors de l’exécution du déploiement. Les propriétés de la ressource ne changeront pas.
Unsupported	string	La ressource n’est pas prise en charge par what-if.

CloudError

Réponse d’erreur pour une demande de gestion des ressources.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.)

DebugSetting

Paramètre de débogage.

Nom	Type	Description
detailLevel	string	Spécifie le type d’informations à consigner pour le débogage. Les valeurs autorisées sont none, requestContent, responseContent ou requestContent et responseContent séparées par une virgule. La valeur par défaut est aucune gestion. Lorsque vous définissez cette valeur, tenez compte du type d’informations que vous transmettez pendant le déploiement. En enregistrant des informations sur la requête ou la réponse, vous risquez d’exposer des données sensibles récupérées au cours des opérations de déploiement.

DeploymentMode

Mode utilisé pour déployer des ressources. Cette valeur peut être Incrémentielle ou Terminée. En mode incrémentiel, les ressources sont déployées sans supprimer de ressources existantes non incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes du groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Soyez prudent lorsque vous utilisez le mode Complet, car vous pouvez supprimer involontairement des ressources.

Nom	Type	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

Propriétés de scénario de déploiement.

Nom	Type	Description
debugSetting	DebugSetting	Paramètre de débogage du déploiement.
expressionEvaluationOptions	ExpressionEvaluationOptions	Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. Applicable uniquement aux modèles imbriqués. Si elle n’est pas spécifiée, la valeur par défaut est externe.
mode	DeploymentMode	Mode utilisé pour déployer des ressources. Cette valeur peut être Incrémentielle ou Terminée. En mode incrémentiel, les ressources sont déployées sans supprimer de ressources existantes non incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes du groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Soyez prudent lorsque vous utilisez le mode Complet, car vous pouvez supprimer involontairement des ressources.
onErrorDeployment	OnErrorDeployment	Comportement du déploiement en cas d’erreur.
parameters	object	Paires nom-valeur qui définissent les paramètres de déploiement pour le modèle. Vous utilisez cet élément lorsque vous souhaitez fournir les valeurs de paramètre directement dans la demande au lieu de créer un lien vers un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. Il peut s’agir d’un JObject ou d’une chaîne JSON bien formée.
parametersLink	ParametersLink	URI du fichier de paramètres. Vous utilisez cet élément pour lier à un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux.
template	object	Contenu du modèle. Vous utilisez cet élément lorsque vous souhaitez passer la syntaxe du modèle directement dans la requête au lieu d’un lien vers un modèle existant. Il peut s’agir d’une chaîne JObject ou JSON bien formée. Utilisez la propriété templateLink ou la propriété template, mais pas les deux.
templateLink	TemplateLink	URI du modèle. Utilisez la propriété templateLink ou la propriété template, mais pas les deux.
whatIfSettings	DeploymentWhatIfSettings	Paramètres d’opération de What-If facultatifs.

DeploymentWhatIfSettings

Paramètres d’opération de déploiement What-If.

Nom	Type	Description
resultFormat	WhatIfResultFormat	Format des résultats What-If

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorResponse[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ExpressionEvaluationOptions

Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué.

Nom	Type	Description
scope	ExpressionEvaluationOptionsScopeType	Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué.

ExpressionEvaluationOptionsScopeType

Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué.

Nom	Type	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Déploiement en cas d’erreur.

Nom	Type	Description
deploymentName	string	Déploiement à utiliser en cas d’erreur.
type	OnErrorDeploymentType	Type de comportement de déploiement en cas d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.

OnErrorDeploymentType

Type de comportement de déploiement en cas d’erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.

Nom	Type	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entité représentant la référence aux paramètres de déploiement.

Nom	Type	Description
contentVersion	string	S’il est inclus, doit correspondre à ContentVersion dans le modèle.
uri	string	URI du fichier de paramètres.

PropertyChangeType

Type de modification de propriété.

Nom	Type	Description
Array	string	La propriété est un tableau et contient les modifications imbriquées.
Create	string	La propriété n’existe pas dans l’état actuel, mais est présente dans l’état souhaité. La propriété est créée lors de l’exécution du déploiement.
Delete	string	La propriété existe dans l’état actuel et est absente de l’état souhaité. Il sera supprimé lors de l’exécution du déploiement.
Modify	string	La propriété existe à la fois dans l’état actuel et souhaité et est différente. La valeur de la propriété change lorsque le déploiement est exécuté.
NoEffect	string	La propriété ne sera pas définie ou mise à jour.

ScopedDeploymentWhatIf

Paramètres de l’opération de simulation de déploiement.

Nom	Type	Description
location	string	Emplacement où stocker les données de déploiement.
properties	DeploymentWhatIfProperties	Propriétés de déploiement.

TemplateLink

Entité représentant la référence au modèle.

Nom	Type	Description
contentVersion	string	S’il est inclus, doit correspondre à ContentVersion dans le modèle.
id	string	ID de ressource d’une spécification de modèle. Utilisez la propriété id ou uri, mais pas les deux.
queryString	string	Chaîne de requête (par exemple, un jeton SAS) à utiliser avec l’URI templateLink.
relativePath	string	La propriété relativePath peut être utilisée pour déployer un modèle lié à un emplacement relatif au parent. Si le modèle parent a été lié à un TemplateSpec, cela fait référence à un artefact dans templateSpec. Si le parent a été lié avec un URI, le déploiement enfant est une combinaison des URI parent et relativePath
uri	string	URI du modèle à déployer. Utilisez la propriété URI ou id, mais pas les deux.

WhatIfChange

Informations sur un changement de ressource unique prédit par What-If opération.

Nom	Type	Description
after	object	La instantané prédite de la ressource après l’exécution du déploiement.
before	object	Le instantané de la ressource avant l’exécution du déploiement.
changeType	ChangeType	Type de modification qui sera apportée à la ressource lors de l’exécution du déploiement.
delta	WhatIfPropertyChange[]	Modifications prédites des propriétés de ressource.
resourceId	string	ID de ressource
unsupportedReason	string	Explication de la raison pour laquelle la ressource n’est pas prise en charge par what-if.

WhatIfOperationResult

Résultat de l’opération What-If. Contient une liste des modifications prédites et un lien URL pour accéder au jeu de résultats suivant.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur Erreur lorsque What-If opération échoue.
properties.changes	WhatIfChange[]	Liste des modifications de ressources prédites par What-If opération.
status	string	État de l’opération What-If.

WhatIfPropertyChange

Modification prédite de la propriété de ressource.

Nom	Type	Description
after	object	Valeur de la propriété après l’exécution du déploiement.
before	object	Valeur de la propriété avant l’exécution du déploiement.
children	WhatIfPropertyChange[]	Modifications des propriétés imbriquées.
path	string	Chemin d'accès à la propriété.
propertyChangeType	PropertyChangeType	Type de modification de propriété.

WhatIfResultFormat

Format des résultats What-If

Nom	Type	Description
FullResourcePayloads	string
ResourceIdOnly	string

Partager via

Deployments - What If At Tenant Scope

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Predict template changes at management group scope

Exemple de requête

Exemple de réponse

Définitions

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Ressources supplémentaires