Deployments - What If

Odwołanie

Usługa:: Resource Management

Wersja interfejsu API:: 2021-04-01

Zwraca zmiany, które zostaną wprowadzone przez wdrożenie, jeśli zostanie wykonane w zakresie grupy zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._]+$	Nazwa wdrożenia.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nazwa grupy zasobów, w ramach których zostanie wdrożony szablon. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Microsoft Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties	True	DeploymentWhatIfProperties	Właściwości wdrożenia.
location		string	Lokalizacja do przechowywania danych wdrożenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WhatIfOperationResult	OK — zwraca stan operacji What-If
202 Accepted		Zaakceptowane — zwraca adres URL w nagłówku Location, aby wysłać zapytanie o stan długotrwałej operacji. Nagłówki Location: string Retry-After: string
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

WhatIfOperationResult

OK — zwraca stan operacji What-If

202 Accepted

Zaakceptowane — zwraca adres URL w nagłówku Location, aby wysłać zapytanie o stan długotrwałej operacji.

Nagłówki

Location: string
Retry-After: string

Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Predict template changes at resource group scope

Przykładowe żądanie

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment/whatIf?api-version=2021-04-01

{
  "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/PostDeploymentWhatIfOnResourceGroup.json
func ExampleDeploymentsClient_BeginWhatIf() {
	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().BeginWhatIf(ctx, "my-resource-group", "my-deployment", armresources.DeploymentWhatIf{
		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": "myExistingIdentity",
	// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
	// 					"apiVersion": "2018-11-30",
	// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
	// 					"location": "westus2",
	// 					"tags":map[string]any{
	// 						"myNewTag": "my tag value",
	// 					},
	// 				},
	// 				Before: map[string]any{
	// 					"name": "myExistingIdentity",
	// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
	// 					"apiVersion": "2018-11-30",
	// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
	// 					"location": "westus2",
	// 				},
	// 				ChangeType: to.Ptr(armresources.ChangeTypeModify),
	// 				Delta: []*armresources.WhatIfPropertyChange{
	// 					{
	// 						Path: to.Ptr("tags.myNewTag"),
	// 						After: "my tag value",
	// 						PropertyChangeType: to.Ptr(armresources.PropertyChangeTypeCreate),
	// 				}},
	// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity"),
	// 			},
	// 			{
	// 				After: map[string]any{
	// 					"name": "myNewIdentity",
	// 					"type": "Microsoft.ManagedIdentity/userAssignedIdentities",
	// 					"apiVersion": "2018-11-30",
	// 					"id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
	// 					"location": "eastus",
	// 					"tags":map[string]any{
	// 						"myOtherNewTag": "another new tag value",
	// 					},
	// 				},
	// 				ChangeType: to.Ptr(armresources.ChangeTypeCreate),
	// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity"),
	// 		}},
	// 	},
	// 	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 resource group.
 *
 * @summary Returns changes that will be made by the deployment if executed at the scope of the resource group.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PostDeploymentWhatIfOnResourceGroup.json
 */
async function predictTemplateChangesAtResourceGroupScope() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000001";
  const resourceGroupName = process.env["RESOURCES_RESOURCE_GROUP"] || "my-resource-group";
  const deploymentName = "my-deployment";
  const parameters = {
    properties: { mode: "Incremental", parameters: {}, templateLink: {} },
  };
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.deployments.beginWhatIfAndWait(
    resourceGroupName,
    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/PostDeploymentWhatIfOnResourceGroup.json
// this example is just showing the usage of "Deployments_WhatIf" 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 subscriptionId = "00000000-0000-0000-0000-000000000001";
string resourceGroupName = "my-resource-group";
string scope = $"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}";
string deploymentName = "my-deployment";
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>()
    {
    }),
});
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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "status": "Succeeded",
  "properties": {
    "changes": [
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
        "changeType": "Modify",
        "before": {
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "name": "myExistingIdentity",
          "location": "westus2"
        },
        "after": {
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "name": "myExistingIdentity",
          "location": "westus2",
          "tags": {
            "myNewTag": "my tag value"
          }
        },
        "delta": [
          {
            "path": "tags.myNewTag",
            "propertyChangeType": "Create",
            "after": "my tag value"
          }
        ]
      },
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
        "changeType": "Create",
        "after": {
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "name": "myNewIdentity",
          "location": "eastus",
          "tags": {
            "myOtherNewTag": "another new tag value"
          }
        }
      }
    ]
  }
}

Kod stanu:: 202

Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Definicje

Nazwa	Opis
ChangeType	Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia.
CloudError	Odpowiedź na błąd żądania zarządzania zasobami.
DebugSetting	Ustawienie debugowania.
DeploymentMode	Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby.
DeploymentWhatIf	Parametry operacji analizy warunkowej wdrożenia.
DeploymentWhatIfProperties	Wdrażanie właściwości warunkowych.
DeploymentWhatIfSettings	Ustawienia operacji What-If wdrażania.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorResponse	Odpowiedź na błąd
ExpressionEvaluationOptions	Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego.
ExpressionEvaluationOptionsScopeType	Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.
OnErrorDeployment	Wdrażanie przy zachowaniu błędu.
OnErrorDeploymentType	Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.
ParametersLink	Jednostka reprezentująca odwołanie do parametrów wdrożenia.
PropertyChangeType	Typ właściwości zmienia się.
TemplateLink	Jednostka reprezentująca odwołanie do szablonu.
WhatIfChange	Informacje o pojedynczej zmianie zasobu przewidywanej przez operację What-If.
WhatIfOperationResult	Wynik operacji What-If. Zawiera listę przewidywanych zmian i link adresu URL, aby przejść do następnego zestawu wyników.
WhatIfPropertyChange	Przewidywana zmiana właściwości zasobu.
WhatIfResultFormat	Format wyników What-If

ChangeType

Wyliczanie

Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia.

Wartość	Opis
Create	Zasób nie istnieje w bieżącym stanie, ale jest obecny w żądanym stanie. Zasób zostanie utworzony po wykonaniu wdrożenia.
Delete	Zasób istnieje w bieżącym stanie i brakuje go w żądanym stanie. Zasób zostanie usunięty po wykonaniu wdrożenia.
Deploy	Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie ponownie wdrożony po wykonaniu wdrożenia. Właściwości zasobu mogą lub nie mogą ulec zmianie.
Ignore	Zasób istnieje w bieżącym stanie i brakuje go w żądanym stanie. Zasób nie zostanie wdrożony ani zmodyfikowany podczas wykonywania wdrożenia.
Modify	Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie ponownie wdrożony po wykonaniu wdrożenia. Właściwości zasobu zostaną zmienione.
NoChange	Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie ponownie wdrożony po wykonaniu wdrożenia. Właściwości zasobu nie zostaną zmienione.
Unsupported	Zasób nie jest obsługiwany przez analizy warunkowe.

CloudError

Objekt

Odpowiedź na błąd żądania zarządzania zasobami.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

DebugSetting

Objekt

Ustawienie debugowania.

Nazwa	Typ	Opis
detailLevel	string	Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to none, requestContent, responseContent lub requestContent i responseContent oddzielone przecinkami. Wartość domyślna to brak. Podczas ustawiania tej wartości należy dokładnie rozważyć typ informacji przekazywanych podczas wdrażania. Rejestrując informacje o żądaniu lub odpowiedzi, możesz potencjalnie uwidocznić poufne dane pobierane za pośrednictwem operacji wdrażania.

DeploymentMode

Wyliczanie

Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby.

Wartość	Opis
Complete
Incremental

DeploymentWhatIf

Objekt

Parametry operacji analizy warunkowej wdrożenia.

Nazwa	Typ	Opis
location	string	Lokalizacja do przechowywania danych wdrożenia.
properties	DeploymentWhatIfProperties	Właściwości wdrożenia.

DeploymentWhatIfProperties

Objekt

Wdrażanie właściwości warunkowych.

Nazwa	Typ	Opis
debugSetting	DebugSetting	Ustawienie debugowania wdrożenia.
expressionEvaluationOptions	ExpressionEvaluationOptions	Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego. Dotyczy tylko szablonów zagnieżdżonych. Jeśli nie zostanie określony, wartość domyślna jest zewnętrzna.
mode	DeploymentMode	Tryb używany do wdrażania zasobów. Ta wartość może być przyrostowa lub ukończona. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie kompletnym zasoby są wdrażane, a istniejące zasoby w grupie zasobów, które nie są uwzględnione w szablonie, są usuwane. Należy zachować ostrożność podczas korzystania z trybu ukończenia, ponieważ możesz przypadkowo usunąć zasoby.
onErrorDeployment	OnErrorDeployment	Wdrożenie w przypadku zachowania błędu.
parameters	object	Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Ten element jest używany, gdy chcesz podać wartości parametrów bezpośrednio w żądaniu, a nie połączyć się z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON.
parametersLink	ParametersLink	Identyfikator URI pliku parametrów. Ten element służy do łączenia z istniejącym plikiem parametrów. Użyj właściwości parametersLink lub właściwości parameters, ale nie obu.
template	object	Zawartość szablonu. Ten element jest używany, gdy chcesz przekazać składnię szablonu bezpośrednio w żądaniu, a nie połączyć się z istniejącym szablonem. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu.
templateLink	TemplateLink	Identyfikator URI szablonu. Użyj właściwości templateLink lub właściwości szablonu, ale nie obu.
whatIfSettings	DeploymentWhatIfSettings	Opcjonalne ustawienia operacji What-If.

DeploymentWhatIfSettings

Objekt

Ustawienia operacji What-If wdrażania.

Nazwa	Typ	Opis
resultFormat	WhatIfResultFormat	Format wyników What-If

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ExpressionEvaluationOptions

Objekt

Określa, czy wyrażenia szablonu są oceniane w zakresie szablonu nadrzędnego lub szablonu zagnieżdżonego.

Nazwa	Typ	Opis
scope	ExpressionEvaluationOptionsScopeType	Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

ExpressionEvaluationOptionsScopeType

Wyliczanie

Zakres używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

Wartość	Opis
Inner
NotSpecified
Outer

OnErrorDeployment

Objekt

Wdrażanie przy zachowaniu błędu.

Nazwa	Typ	Opis
deploymentName	string	Wdrożenie, które ma być używane w przypadku błędu.
type	OnErrorDeploymentType	Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

OnErrorDeploymentType

Wyliczanie

Wdrożenie typu zachowania błędu. Możliwe wartości to LastSuccessful i SpecificDeployment.

Wartość	Opis
LastSuccessful
SpecificDeployment

ParametersLink

Objekt

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

Nazwa	Typ	Opis
contentVersion	string	W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie.
uri	string	Identyfikator URI pliku parametrów.

PropertyChangeType

Wyliczanie

Typ właściwości zmienia się.

Wartość	Opis
Array	Właściwość jest tablicą i zawiera zagnieżdżone zmiany.
Create	Właściwość nie istnieje w bieżącym stanie, ale jest obecna w żądanym stanie. Właściwość zostanie utworzona podczas wykonywania wdrożenia.
Delete	Właściwość istnieje w bieżącym stanie i brakuje jej w żądanym stanie. Zostanie on usunięty po wykonaniu wdrożenia.
Modify	Właściwość istnieje zarówno w bieżącym, jak i żądanym stanie i jest inna. Wartość właściwości zmieni się po wykonaniu wdrożenia.
NoEffect	Właściwość nie zostanie ustawiona ani zaktualizowana.

TemplateLink

Objekt

Jednostka reprezentująca odwołanie do szablonu.

Nazwa	Typ	Opis
contentVersion	string	W przypadku dołączenia element musi być zgodny z elementem ContentVersion w szablonie.
id	string	Identyfikator zasobu specyfikacji szablonu. Użyj właściwości identyfikatora lub identyfikatora URI, ale nie obu tych elementów.
queryString	string	Ciąg zapytania (na przykład token SAS) do użycia z identyfikatorem URI szablonuLink.
relativePath	string	Właściwość relativePath może służyć do wdrażania połączonego szablonu w lokalizacji względem elementu nadrzędnego. Jeśli szablon nadrzędny został połączony z szablonem TemplateSpec, będzie on odwoływać się do artefaktu w elemencie TemplateSpec. Jeśli element nadrzędny został połączony z identyfikatorem URI, wdrożenie podrzędne będzie kombinacją identyfikatorów URI nadrzędnych i względnychPath
uri	string	Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu.

WhatIfChange

Objekt

Informacje o pojedynczej zmianie zasobu przewidywanej przez operację What-If.

Nazwa	Typ	Opis
after	object	Przewidywana migawka zasobu po wykonaniu wdrożenia.
before	object	Migawka zasobu przed wykonaniem wdrożenia.
changeType	ChangeType	Typ zmiany, która zostanie wprowadzona do zasobu po wykonaniu wdrożenia.
delta	WhatIfPropertyChange[]	Przewidywane zmiany właściwości zasobu.
resourceId	string	Identyfikator zasobu
unsupportedReason	string	Wyjaśnienie, dlaczego zasób jest nieobsługiwany przez what-If.

WhatIfOperationResult

Objekt

Wynik operacji What-If. Zawiera listę przewidywanych zmian i link adresu URL, aby przejść do następnego zestawu wyników.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Błąd, gdy operacja What-If kończy się niepowodzeniem.
properties.changes	WhatIfChange[]	Lista zmian zasobów przewidywanych przez operację What-If.
status	string	Stan operacji What-If.

WhatIfPropertyChange

Objekt

Przewidywana zmiana właściwości zasobu.

Nazwa	Typ	Opis
after	object	Wartość właściwości po wykonaniu wdrożenia.
before	object	Wartość właściwości przed wykonaniem wdrożenia.
children	WhatIfPropertyChange[]	Zmiany właściwości zagnieżdżonych.
path	string	Ścieżka właściwości.
propertyChangeType	PropertyChangeType	Typ właściwości zmienia się.

WhatIfResultFormat

Wyliczanie

Format wyników What-If

Wartość	Opis
FullResourcePayloads
ResourceIdOnly

Udostępnij za pośrednictwem

Deployments - What If

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Predict template changes at resource group scope

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIf

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Dodatkowe zasoby