Deployments - What If At Management Group Scope

Riferimento

Servizio:: Resource Management

Versione API:: 2021-04-01

Restituisce le modifiche apportate dalla distribuzione se eseguite nell'ambito del gruppo di gestione.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione

Nome	In	Necessario	Tipo	Descrizione
deploymentName	path	True	string	Nome della distribuzione. Criterio di espressione regolare: `^[-\w\._\(\)]+$`
groupId	path	True	string	ID gruppo di gestione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

deploymentName

path

True

string

Nome della distribuzione.

Criterio di espressione regolare: ^[-\w\._]+$

groupId

path

True

string

ID gruppo di gestione.

api-version

query

True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
location	True	string	Percorso per archiviare i dati di distribuzione.
properties	True	DeploymentWhatIfProperties	Proprietà di distribuzione.

Risposte

Nome	Tipo	Descrizione
200 OK	WhatIfOperationResult	OK - Restituisce lo stato dell'operazione What-If
202 Accepted		Accettato: restituisce l'URL nell'intestazione Percorso per eseguire query per lo stato dell'operazione a esecuzione prolungata. Intestazioni Location: string Retry-After: string
Other Status Codes	CloudError	Risposta di errore che descrive perché l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

WhatIfOperationResult

OK - Restituisce lo stato dell'operazione What-If

202 Accepted

Accettato: restituisce l'URL nell'intestazione Percorso per eseguire query per lo stato dell'operazione a esecuzione prolungata.

Intestazioni

Location: string
Retry-After: string

Other Status Codes

CloudError

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Predict template changes at management group scope

Esempio di richiesta

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGruop/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/PostDeploymentWhatIfOnManagementGroup.json
func ExampleDeploymentsClient_BeginWhatIfAtManagementGroupScope() {
	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().BeginWhatIfAtManagementGroupScope(ctx, "myManagementGruop", "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{
	// 					"before":map[string]any{
	// 						"name": "myPolicyAssignment",
	// 						"type": "Microsoft.Authorization/policyAssignments",
	// 						"apiVersion": "2019-06-01",
	// 						"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
	// 						"location": "westus2",
	// 						"properties":map[string]any{
	// 							"enforcementMode": "DoNotEnforce",
	// 							"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
	// 							"scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
	// 						},
	// 					},
	// 					"changeType": "Modify",
	// 					"delta":[]any{
	// 						map[string]any{
	// 							"path": "properties.enforcementMode",
	// 							"after": "DoNotEnforce",
	// 							"before": "Default",
	// 							"propertyChangeType": "Modify",
	// 						},
	// 					},
	// 					"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
	// 				},
	// 				Before: map[string]any{
	// 					"name": "myPolicyAssignment",
	// 					"type": "Microsoft.Authorization/policyAssignments",
	// 					"apiVersion": "2019-06-01",
	// 					"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
	// 					"location": "westus2",
	// 					"properties":map[string]any{
	// 						"enforcementMode": "Default",
	// 						"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
	// 						"scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
	// 					},
	// 				},
	// 				ChangeType: to.Ptr(armresources.ChangeTypeModify),
	// 				ResourceID: to.Ptr("/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment"),
	// 			},
	// 			{
	// 				After: map[string]any{
	// 					"name": "myPolicyAssignment2",
	// 					"type": "Microsoft.Authorization/policyAssignments",
	// 					"apiVersion": "2019-06-01",
	// 					"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
	// 					"location": "westus2",
	// 					"properties":map[string]any{
	// 						"enforcementMode": "Default",
	// 						"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
	// 						"scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
	// 					},
	// 				},
	// 				ChangeType: to.Ptr(armresources.ChangeTypeCreate),
	// 				ResourceID: to.Ptr("/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2"),
	// 		}},
	// 	},
	// 	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 management group.
 *
 * @summary Returns changes that will be made by the deployment if executed at the scope of the management group.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnManagementGroup.json
 */
async function predictTemplateChangesAtManagementGroupScope() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const groupId = "myManagementGruop";
  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.beginWhatIfAtManagementGroupScopeAndWait(
    groupId,
    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/PostDeploymentWhatIfOnManagementGroup.json
// this example is just showing the usage of "Deployments_WhatIfAtManagementGroupScope" 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 groupId = "myManagementGruop";
string scope = $"/providers/Microsoft.Management/managementGroups/{groupId}";
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

Risposta di esempio

Codice di stato:: 200

{
  "status": "Succeeded",
  "properties": {
    "changes": [
      {
        "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
        "changeType": "Modify",
        "before": {
          "apiVersion": "2019-06-01",
          "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
          "type": "Microsoft.Authorization/policyAssignments",
          "name": "myPolicyAssignment",
          "location": "westus2",
          "properties": {
            "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
            "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
            "enforcementMode": "Default"
          }
        },
        "after": {
          "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
          "changeType": "Modify",
          "before": {
            "apiVersion": "2019-06-01",
            "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
            "type": "Microsoft.Authorization/policyAssignments",
            "name": "myPolicyAssignment",
            "location": "westus2",
            "properties": {
              "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
              "scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
              "enforcementMode": "DoNotEnforce"
            }
          },
          "delta": [
            {
              "path": "properties.enforcementMode",
              "propertyChangeType": "Modify",
              "before": "Default",
              "after": "DoNotEnforce"
            }
          ]
        }
      },
      {
        "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
        "changeType": "Create",
        "after": {
          "apiVersion": "2019-06-01",
          "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
          "type": "Microsoft.Authorization/policyAssignments",
          "name": "myPolicyAssignment2",
          "location": "westus2",
          "properties": {
            "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
            "scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
            "enforcementMode": "Default"
          }
        }
      }
    ]
  }
}

Codice di stato:: 202

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

Definizioni

Nome	Descrizione
ChangeType	Tipo di modifica che verrà apportata alla risorsa quando viene eseguita la distribuzione.
CloudError	Risposta di errore per una richiesta di gestione delle risorse.
DebugSetting	Impostazione di debug.
DeploymentMode	Modalità usata per distribuire le risorse. Questo valore può essere Incremental o Complete. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità Completa perché è possibile eliminare involontariamente le risorse.
DeploymentWhatIfProperties	Proprietà di simulazione della distribuzione.
DeploymentWhatIfSettings	Impostazioni dell'operazione di distribuzione What-If.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorResponse	Risposta di errore
ExpressionEvaluationOptions	Specifica se le espressioni modello vengono valutate nell'ambito del modello padre o del modello annidato.
ExpressionEvaluationOptionsScopeType	Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.
OnErrorDeployment	Distribuzione in caso di comportamento degli errori.
OnErrorDeploymentType	Distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.
ParametersLink	Entità che rappresenta il riferimento ai parametri di distribuzione.
PropertyChangeType	Tipo di modifica della proprietà.
ScopedDeploymentWhatIf	Parametri dell'operazione di simulazione della distribuzione.
TemplateLink	Entità che rappresenta il riferimento al modello.
WhatIfChange	Informazioni su una singola modifica della risorsa stimata dall'operazione di What-If.
WhatIfOperationResult	Risultato dell'operazione di What-If. Contiene un elenco di modifiche stimate e un collegamento URL per accedere al set di risultati successivo.
WhatIfPropertyChange	Modifica stimata alla proprietà della risorsa.
WhatIfResultFormat	Formato dei risultati What-If

ChangeType

Tipo di modifica che verrà apportata alla risorsa quando viene eseguita la distribuzione.

Nome	Tipo	Descrizione
Create	string	La risorsa non esiste nello stato corrente, ma è presente nello stato desiderato. La risorsa verrà creata quando viene eseguita la distribuzione.
Delete	string	La risorsa esiste nello stato corrente ed è mancante dallo stato desiderato. La risorsa verrà eliminata quando viene eseguita la distribuzione.
Deploy	string	La risorsa esiste nello stato corrente e nello stato desiderato e verrà ridistribuito quando viene eseguita la distribuzione. Le proprietà della risorsa possono essere modificate o meno.
Ignore	string	La risorsa esiste nello stato corrente ed è mancante dallo stato desiderato. La risorsa non verrà distribuita o modificata quando viene eseguita la distribuzione.
Modify	string	La risorsa esiste nello stato corrente e lo stato desiderato e verrà ridistribuito quando viene eseguita la distribuzione. Le proprietà della risorsa cambieranno.
NoChange	string	La risorsa esiste nello stato corrente e nello stato desiderato e verrà ridistribuito quando viene eseguita la distribuzione. Le proprietà della risorsa non verranno modificate.
Unsupported	string	La risorsa non è supportata da What-If.

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Risposta di errore comune per tutte le API Resource Manager di Azure per restituire i dettagli dell'errore per le operazioni non riuscite. Segue anche il formato di risposta di errore OData.

DebugSetting

Impostazione di debug.

Nome	Tipo	Descrizione
detailLevel	string	Specifica il tipo di informazioni da registrare per il debug. I valori consentiti sono none, requestContent, responseContent o requestContent e responseContent separati da una virgola. Il valore predefinito è none. Quando si imposta questo valore, considerare attentamente il tipo di informazioni passate durante la distribuzione. La registrazione di informazioni sulla richiesta o sulla risposta può esporre dati riservati, che vengono recuperati tramite le operazioni di distribuzione.

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere Incremental o Complete. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità Completa perché è possibile eliminare involontariamente le risorse.

Nome	Tipo	Descrizione
Complete	string
Incremental	string

DeploymentWhatIfProperties

Proprietà di simulazione della distribuzione.

Nome	Tipo	Descrizione
debugSetting	DebugSetting	Impostazione di debug della distribuzione.
expressionEvaluationOptions	ExpressionEvaluationOptions	Specifica se le espressioni modello vengono valutate nell'ambito del modello padre o del modello annidato. Applicabile solo ai modelli annidati. Se non specificato, il valore predefinito è esterno.
mode	DeploymentMode	Modalità usata per distribuire le risorse. Questo valore può essere Incremental o Complete. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità Completa perché è possibile eliminare involontariamente le risorse.
onErrorDeployment	OnErrorDeployment	Distribuzione in caso di comportamento degli errori.
parameters	object	Coppie nome e valore che definiscono i parametri di distribuzione per il modello. Questo elemento viene usato quando si desidera specificare i valori dei parametri direttamente nella richiesta anziché collegarsi a un file di parametri esistente. Usare la proprietà parametersLink o la proprietà parameters, ma non entrambe. Può essere un JObject o una stringa JSON ben formata.
parametersLink	ParametersLink	URI del file di parametri. Questo elemento viene usato per il collegamento a un file di parametri esistente. Usare la proprietà parametersLink o la proprietà parameters, ma non entrambe.
template	object	Contenuto del modello. Questo elemento viene usato quando si vuole passare la sintassi del modello direttamente nella richiesta anziché collegarsi a un modello esistente. Può essere una stringa JSON ben formata o JObject. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe.
templateLink	TemplateLink	URI del modello. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe.
whatIfSettings	DeploymentWhatIfSettings	Facoltative What-If impostazioni dell'operazione.

DeploymentWhatIfSettings

Impostazioni dell'operazione di distribuzione What-If.

Nome	Tipo	Descrizione
resultFormat	WhatIfResultFormat	Formato dei risultati What-If

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ExpressionEvaluationOptions

Specifica se le espressioni modello vengono valutate nell'ambito del modello padre o del modello annidato.

Nome	Tipo	Descrizione
scope	ExpressionEvaluationOptionsScopeType	Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.

ExpressionEvaluationOptionsScopeType

Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.

Nome	Tipo	Descrizione
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Distribuzione in caso di comportamento degli errori.

Nome	Tipo	Descrizione
deploymentName	string	Distribuzione da usare in caso di errore.
type	OnErrorDeploymentType	Distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

OnErrorDeploymentType

Distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

Nome	Tipo	Descrizione
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entità che rappresenta il riferimento ai parametri di distribuzione.

Nome	Tipo	Descrizione
contentVersion	string	Se incluso, deve corrispondere a ContentVersion nel modello.
uri	string	URI del file di parametri.

PropertyChangeType

Tipo di modifica della proprietà.

Nome	Tipo	Descrizione
Array	string	La proprietà è una matrice e contiene modifiche annidate.
Create	string	La proprietà non esiste nello stato corrente, ma è presente nello stato desiderato. La proprietà verrà creata al momento dell'esecuzione della distribuzione.
Delete	string	La proprietà esiste nello stato corrente ed è mancante dallo stato desiderato. Verrà eliminato quando viene eseguita la distribuzione.
Modify	string	La proprietà esiste sia nello stato corrente che in quello desiderato ed è diversa. Il valore della proprietà cambierà quando viene eseguita la distribuzione.
NoEffect	string	La proprietà non verrà impostata o aggiornata.

ScopedDeploymentWhatIf

Parametri dell'operazione di simulazione della distribuzione.

Nome	Tipo	Descrizione
location	string	Percorso in cui archiviare i dati di distribuzione.
properties	DeploymentWhatIfProperties	Proprietà di distribuzione.

TemplateLink

Entità che rappresenta il riferimento al modello.

Nome	Tipo	Descrizione
contentVersion	string	Se incluso, deve corrispondere a ContentVersion nel modello.
id	string	ID risorsa di una specifica di modello. Utilizzare la proprietà id o URI, ma non entrambi.
queryString	string	Stringa di query (ad esempio, un token di firma di accesso condiviso) da usare con l'URI templateLink.
relativePath	string	La proprietà relativePath può essere utilizzata per distribuire un modello collegato in una posizione relativa all'elemento padre. Se il modello padre è stato collegato a un oggetto TemplateSpec, questo farà riferimento a un artefatto in TemplateSpec. Se l'elemento padre è stato collegato a un URI, la distribuzione figlio sarà una combinazione degli URI padre e relativePath
uri	string	URI del modello da distribuire. Usare l'URI o la proprietà ID, ma non entrambi.

WhatIfChange

Informazioni su una singola modifica della risorsa stimata dall'operazione di What-If.

Nome	Tipo	Descrizione
after	object	Snapshot stimato della risorsa dopo l'esecuzione della distribuzione.
before	object	Snapshot della risorsa prima dell'esecuzione della distribuzione.
changeType	ChangeType	Tipo di modifica che verrà apportata alla risorsa quando viene eseguita la distribuzione.
delta	WhatIfPropertyChange[]	Le modifiche previste alle proprietà delle risorse.
resourceId	string	ID risorsa
unsupportedReason	string	Spiegazione del motivo per cui la risorsa non è supportata da What-If.

WhatIfOperationResult

Risultato dell'operazione di What-If. Contiene un elenco di modifiche stimate e un collegamento URL per accedere al set di risultati successivo.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Errore quando What-If'operazione ha esito negativo.
properties.changes	WhatIfChange[]	Elenco delle modifiche delle risorse stimate dall'operazione di What-If.
status	string	Stato dell'operazione di What-If.

WhatIfPropertyChange

Modifica stimata alla proprietà della risorsa.

Nome	Tipo	Descrizione
after	object	Valore della proprietà dopo l'esecuzione della distribuzione.
before	object	Valore della proprietà prima dell'esecuzione della distribuzione.
children	WhatIfPropertyChange[]	Cambia la proprietà annidata.
path	string	Percorso della proprietà.
propertyChangeType	PropertyChangeType	Tipo di modifica della proprietà.

WhatIfResultFormat

Formato dei risultati What-If

Nome	Tipo	Descrizione
FullResourcePayloads	string
ResourceIdOnly	string

Condividi tramite

Deployments - What If At Management Group Scope

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Predict template changes at management group scope

Esempio di richiesta

Risposta di esempio

Definizioni

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Risorse aggiuntive