Deployments - What If At Management Group Scope

Dienst:

Resource Management

API-Version:

2021-04-01

Gibt Änderungen zurück, die von der Bereitstellung vorgenommen werden, wenn sie im Bereich der Verwaltungsgruppe ausgeführt werden.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deploymentName	path	True	string	Der Name der Bereitstellung RegEx-Muster: ^[-\w\._\(\)]+$
groupId	path	True	string	Die Verwaltungsgruppen-ID.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
location	True	string	Der Speicherort für die Bereitstellungsdaten.
properties	True	DeploymentWhatIfProperties	Die Bereitstellungseigenschaften.

Antworten

Name	Typ	Beschreibung
200 OK	WhatIfOperationResult	OK: Gibt What-If Vorgang status zurück.
202 Accepted		Akzeptiert: Gibt die URL im Location-Header zurück, um status lang andauernde Vorgänge abzufragen. Header Location: string Retry-After: string
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Predict template changes at management group scope

Beispielanforderung

HTTP

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"
  }
}

Go

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

JavaScript

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

dotnet

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

Beispiel für eine Antwort

Statuscode:

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"
          }
        }
      }
    ]
  }
}

Statuscode:

202

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

Definitionen

Name	Beschreibung
ChangeType	Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird.
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
DebugSetting	Die Debugeinstellung.
DeploymentMode	Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie ressourcen unbeabsichtigt löschen können.
DeploymentWhatIfProperties	Was-wäre-wenn-Eigenschaften der Bereitstellung.
DeploymentWhatIfSettings	Bereitstellung What-If Vorgangseinstellungen.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorResponse	Fehlerantwort
ExpressionEvaluationOptions	Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten Vorlage oder der geschachtelten Vorlage ausgewertet werden.
ExpressionEvaluationOptionsScopeType	Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.
OnErrorDeployment	Bereitstellung bei Fehlerverhalten.
OnErrorDeploymentType	Der Bereitstellungstyp für fehlerverhalten. Mögliche Werte sind LastSuccessful und SpecificDeployment.
ParametersLink	Entität, die den Verweis auf die Bereitstellungsparameter darstellt.
PropertyChangeType	Der Typ der Eigenschaft ändert sich.
ScopedDeploymentWhatIf	Was-wäre-wenn-Vorgangsparameter für die Bereitstellung.
TemplateLink	Entität, die den Verweis auf die Vorlage darstellt.
WhatIfChange	Informationen zu einer einzelnen Ressourcenänderung, die von What-If Vorgang vorhergesagt wird.
WhatIfOperationResult	Ergebnis des What-If Vorgangs. Enthält eine Liste der vorhergesagten Änderungen und einen URL-Link, um zum nächsten Satz von Ergebnissen zu gelangen.
WhatIfPropertyChange	Die vorhergesagte Änderung an der Ressourceneigenschaft.
WhatIfResultFormat	Das Format der What-If Ergebnisse

ChangeType

Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird.

Name	Typ	Beschreibung
Create	string	Die Ressource ist nicht im aktuellen Zustand vorhanden, sondern im gewünschten Zustand vorhanden. Die Ressource wird erstellt, wenn die Bereitstellung ausgeführt wird.
Delete	string	Die Ressource befindet sich im aktuellen Zustand und fehlt im gewünschten Zustand. Die Ressource wird gelöscht, wenn die Bereitstellung ausgeführt wird.
Deploy	string	Die Ressource ist im aktuellen Zustand und im gewünschten Zustand vorhanden und wird bei Ausführung der Bereitstellung erneut bereitgestellt. Die Eigenschaften der Ressource können sich ändern oder auch nicht.
Ignore	string	Die Ressource befindet sich im aktuellen Zustand und fehlt im gewünschten Zustand. Die Ressource wird nicht bereitgestellt oder geändert, wenn die Bereitstellung ausgeführt wird.
Modify	string	Die Ressource befindet sich im aktuellen Zustand und im gewünschten Zustand und wird erneut bereitgestellt, wenn die Bereitstellung ausgeführt wird. Die Eigenschaften der Ressource ändern sich.
NoChange	string	Die Ressource ist im aktuellen Zustand und im gewünschten Zustand vorhanden und wird bei Ausführung der Bereitstellung erneut bereitgestellt. Die Eigenschaften der Ressource werden nicht geändert.
Unsupported	string	Die Ressource wird von Was-wäre-wenn nicht unterstützt.

CloudError

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

DebugSetting

Die Debugeinstellung.

Name	Typ	Beschreibung
detailLevel	string	Gibt den Typ der Informationen an, die für das Debuggen protokolliert werden sollen. Die zulässigen Werte sind none, requestContent, responseContent oder requestContent und responseContent getrennt durch ein Komma. Der Standardwert ist „none“. Berücksichtigen Sie beim Festlegen dieses Werts sorgfältig den Typ der Informationen, die Sie während der Bereitstellung übergeben. Indem Sie Informationen über die Anforderung oder die Antwort protokollieren, machen Sie möglicherweise vertrauliche Daten verfügbar, die durch die Bereitstellungsvorgänge abgerufen werden.

DeploymentMode

Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie ressourcen unbeabsichtigt löschen können.

Name	Typ	Beschreibung
Complete	string
Incremental	string

DeploymentWhatIfProperties

Was-wäre-wenn-Eigenschaften der Bereitstellung.

Name	Typ	Beschreibung
debugSetting	DebugSetting	Die Debugeinstellung der Bereitstellung.
expressionEvaluationOptions	ExpressionEvaluationOptions	Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten Vorlage oder der geschachtelten Vorlage ausgewertet werden. Gilt nur für geschachtelte Vorlagen. Wenn nicht angegeben, ist der Standardwert äußerer Wert.
mode	DeploymentMode	Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie ressourcen unbeabsichtigt löschen können.
onErrorDeployment	OnErrorDeployment	Die Bereitstellung bei Fehlerverhalten.
parameters	object	Name- und Wertpaare, die die Bereitstellungsparameter für die Vorlage definieren. Sie verwenden dieses Element, wenn Sie die Parameterwerte direkt in der Anforderung bereitstellen möchten, anstatt mit einer vorhandenen Parameterdatei zu verknüpfen. Verwenden Sie entweder die parametersLink-Eigenschaft oder die parameters-Eigenschaft, aber nicht beides. Es kann sich um ein JObject-Objekt oder eine wohlgeformte JSON-Zeichenfolge handeln.
parametersLink	ParametersLink	Der URI der Parameterdatei. Sie verwenden dieses Element, um eine Verknüpfung mit einer vorhandenen Parameterdatei zu erstellen. Verwenden Sie entweder die parametersLink-Eigenschaft oder die parameters-Eigenschaft, aber nicht beides.
template	object	Der Vorlageninhalt. Sie verwenden dieses Element, wenn Sie die Vorlagensyntax direkt in der Anforderung übergeben möchten, anstatt mit einer vorhandenen Vorlage zu verknüpfen. Es kann sich um eine JObject-Zeichenfolge oder eine wohlgeformte JSON-Zeichenfolge handeln. Verwenden Sie entweder die templateLink-Eigenschaft oder die template-Eigenschaft, aber nicht beides.
templateLink	TemplateLink	Der URI der Vorlage. Verwenden Sie entweder die templateLink-Eigenschaft oder die template-Eigenschaft, aber nicht beides.
whatIfSettings	DeploymentWhatIfSettings	Optionale What-If Vorgangseinstellungen.

DeploymentWhatIfSettings

Bereitstellung What-If Vorgangseinstellungen.

Name	Typ	Beschreibung
resultFormat	WhatIfResultFormat	Das Format der What-If Ergebnisse

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ExpressionEvaluationOptions

Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten Vorlage oder der geschachtelten Vorlage ausgewertet werden.

Name	Typ	Beschreibung
scope	ExpressionEvaluationOptionsScopeType	Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.

ExpressionEvaluationOptionsScopeType

Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.

Name	Typ	Beschreibung
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Bereitstellung bei Fehlerverhalten.

Name	Typ	Beschreibung
deploymentName	string	Die Bereitstellung, die für den Fehlerfall verwendet werden soll.
type	OnErrorDeploymentType	Der Bereitstellungstyp für fehlerverhalten. Mögliche Werte sind LastSuccessful und SpecificDeployment.

OnErrorDeploymentType

Der Bereitstellungstyp für fehlerverhalten. Mögliche Werte sind LastSuccessful und SpecificDeployment.

Name	Typ	Beschreibung
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entität, die den Verweis auf die Bereitstellungsparameter darstellt.

Name	Typ	Beschreibung
contentVersion	string	Falls enthalten, muss mit der ContentVersion in der Vorlage übereinstimmen.
uri	string	Der URI der Parameterdatei.

PropertyChangeType

Der Typ der Eigenschaft ändert sich.

Name	Typ	Beschreibung
Array	string	Die -Eigenschaft ist ein Array und enthält geschachtelte Änderungen.
Create	string	Die -Eigenschaft ist nicht im aktuellen Zustand vorhanden, sondern im gewünschten Zustand vorhanden. Die -Eigenschaft wird erstellt, wenn die Bereitstellung ausgeführt wird.
Delete	string	Die -Eigenschaft befindet sich im aktuellen Zustand und fehlt im gewünschten Zustand. Sie wird gelöscht, wenn die Bereitstellung ausgeführt wird.
Modify	string	Die -Eigenschaft ist sowohl im aktuellen als auch im gewünschten Zustand vorhanden und unterscheidet sich. Der Wert der -Eigenschaft ändert sich, wenn die Bereitstellung ausgeführt wird.
NoEffect	string	Die -Eigenschaft wird nicht festgelegt oder aktualisiert.

ScopedDeploymentWhatIf

Was-wäre-wenn-Vorgangsparameter für die Bereitstellung.

Name	Typ	Beschreibung
location	string	Der Speicherort für die Bereitstellungsdaten.
properties	DeploymentWhatIfProperties	Die Bereitstellungseigenschaften.

TemplateLink

Entität, die den Verweis auf die Vorlage darstellt.

Name	Typ	Beschreibung
contentVersion	string	Falls enthalten, muss mit der ContentVersion in der Vorlage übereinstimmen.
id	string	Die Ressourcen-ID einer Vorlagenspezifikation. Verwenden Sie entweder die ID- oder URI-Eigenschaft, aber nicht beides.
queryString	string	Die Abfragezeichenfolge (z. B. ein SAS-Token), die mit dem templateLink-URI verwendet werden soll.
relativePath	string	Die relativePath-Eigenschaft kann verwendet werden, um eine verknüpfte Vorlage relativ zum übergeordneten Standort bereitzustellen. Wenn die übergeordnete Vorlage mit einer TemplateSpec verknüpft wurde, verweist dies auf ein Artefakt im TemplateSpec. Wenn das übergeordnete Element mit einem URI verknüpft wurde, ist die untergeordnete Bereitstellung eine Kombination aus den übergeordneten und relativePath-URIs.
uri	string	Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder id-Eigenschaft, aber nicht beides.

WhatIfChange

Informationen zu einer einzelnen Ressourcenänderung, die von What-If Vorgang vorhergesagt wird.

Name	Typ	Beschreibung
after	object	Der vorhergesagte Momentaufnahme der Ressource, nachdem die Bereitstellung ausgeführt wurde.
before	object	Der Momentaufnahme der Ressource, bevor die Bereitstellung ausgeführt wird.
changeType	ChangeType	Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird.
delta	WhatIfPropertyChange[]	Die vorhergesagten Änderungen an den Ressourceneigenschaften.
resourceId	string	Ressourcen-ID
unsupportedReason	string	Die Erklärung, warum die Ressource von What-If nicht unterstützt wird.

WhatIfOperationResult

Ergebnis des What-If Vorgangs. Enthält eine Liste der vorhergesagten Änderungen und einen URL-Link, um zum nächsten Satz von Ergebnissen zu gelangen.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Fehler, wenn What-If Vorgang fehlschlägt.
properties.changes	WhatIfChange[]	Liste der von What-If Vorgang vorhergesagten Ressourcenänderungen.
status	string	Status des What-If Vorgangs.

WhatIfPropertyChange

Die vorhergesagte Änderung an der Ressourceneigenschaft.

Name	Typ	Beschreibung
after	object	Der Wert der -Eigenschaft, nachdem die Bereitstellung ausgeführt wurde.
before	object	Der Wert der -Eigenschaft, bevor die Bereitstellung ausgeführt wird.
children	WhatIfPropertyChange[]	Geschachtelte Eigenschaftenänderungen.
path	string	Der Pfad der Eigenschaft.
propertyChangeType	PropertyChangeType	Der Typ der Eigenschaft ändert sich.

WhatIfResultFormat

Das Format der What-If Ergebnisse

Name	Typ	Beschreibung
FullResourcePayloads	string
ResourceIdOnly	string