Deployments - What If At Tenant Scope

Referens

Tjänst:: Resource Management

API-version:: 2021-04-01

Returnerar ändringar som kommer att göras av distributionen om de körs i klientgruppens omfång.

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

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
deploymentName	path	True	string	Namnet på distributionen. Reguljärt uttrycksmönster: `^[-\w\._\(\)]+$`
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

deploymentName

path

True

string

Namnet på distributionen.

Reguljärt uttrycksmönster: ^[-\w\._]+$

api-version

query

True

string

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Platsen där distributionsdata ska lagras.
properties	True	DeploymentWhatIfProperties	Distributionsegenskaperna.

Svar

Name	Typ	Description
200 OK	WhatIfOperationResult	OK – Returnerar What-If åtgärdsstatus
202 Accepted		Accepted – returnerar URL:en i platsrubriken för att fråga efter långvarig åtgärdsstatus. Sidhuvuden Location: string Retry-After: string
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

WhatIfOperationResult

OK – Returnerar What-If åtgärdsstatus

202 Accepted

Accepted – returnerar URL:en i platsrubriken för att fråga efter långvarig åtgärdsstatus.

Sidhuvuden

Location: string
Retry-After: string

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Predict template changes at management group scope

Exempelbegäran

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

Exempelsvar

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

Statuskod:: 202

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

Definitioner

Name	Description
ChangeType	Typ av ändring som görs i resursen när distributionen körs.
CloudError	Ett felsvar för en resurshanteringsbegäran.
DebugSetting	Felsökningsinställningen.
DeploymentMode	Det läge som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder fullständigt läge eftersom du oavsiktligt kan ta bort resurser.
DeploymentWhatIfProperties	Distribution Konsekvensegenskaper.
DeploymentWhatIfSettings	Inställningar för distribution What-If åtgärder.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorResponse	Felsvar
ExpressionEvaluationOptions	Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen.
ExpressionEvaluationOptionsScopeType	Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.
OnErrorDeployment	Distribution av felbeteende.
OnErrorDeploymentType	Distributionen av felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.
ParametersLink	Entitet som representerar referensen till distributionsparametrarna.
PropertyChangeType	Typ av egenskapsändring.
ScopedDeploymentWhatIf	Distribution Konsekvensparametrar.
TemplateLink	Entitet som representerar referensen till mallen.
WhatIfChange	Information om en enskild resursändring som förutsägs av What-If åtgärd.
WhatIfOperationResult	Resultatet av den What-If åtgärden. Innehåller en lista över förutsagda ändringar och en URL-länk för att komma till nästa uppsättning resultat.
WhatIfPropertyChange	Den förutsagda ändringen av resursegenskapen.
WhatIfResultFormat	Formatet på What-If resultat

ChangeType

Typ av ändring som görs i resursen när distributionen körs.

Name	Typ	Description
Create	string	Resursen finns inte i det aktuella tillståndet men finns i önskat tillstånd. Resursen skapas när distributionen körs.
Delete	string	Resursen finns i det aktuella tillståndet och saknas i önskat tillstånd. Resursen tas bort när distributionen körs.
Deploy	string	Resursen finns i aktuellt tillstånd och önskat tillstånd och distribueras om när distributionen körs. Egenskaperna för resursen ändras eventuellt.
Ignore	string	Resursen finns i det aktuella tillståndet och saknas i önskat tillstånd. Resursen kommer inte att distribueras eller ändras när distributionen körs.
Modify	string	Resursen finns i aktuellt tillstånd och önskat tillstånd och distribueras om när distributionen körs. Egenskaperna för resursen ändras.
NoChange	string	Resursen finns i aktuellt tillstånd och önskat tillstånd och distribueras om när distributionen körs. Resursens egenskaper ändras inte.
Unsupported	string	Resursen stöds inte av Konsekvens.

CloudError

Ett felsvar för en resurshanteringsbegäran.

Name	Typ	Description
error	ErrorResponse	Felsvar Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.)

DebugSetting

Felsökningsinställningen.

Name	Typ	Description
detailLevel	string	Anger vilken typ av information som ska loggas för felsökning. De tillåtna värdena är none, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är none. När du anger det här värdet bör du noga överväga vilken typ av information du skickar in under distributionen. Genom att logga information om begäran eller svaret kan du potentiellt exponera känsliga data som hämtas via distributionsåtgärderna.

DeploymentMode

Det läge som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder fullständigt läge eftersom du oavsiktligt kan ta bort resurser.

Name	Typ	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

Distribution Konsekvensegenskaper.

Name	Typ	Description
debugSetting	DebugSetting	Felsökningsinställningen för distributionen.
expressionEvaluationOptions	ExpressionEvaluationOptions	Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen. Gäller endast för kapslade mallar. Om det inte anges är standardvärdet yttre.
mode	DeploymentMode	Det läge som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder fullständigt läge eftersom du oavsiktligt kan ta bort resurser.
onErrorDeployment	OnErrorDeployment	Distributionen av felbeteende.
parameters	object	Namn- och värdepar som definierar distributionsparametrarna för mallen. Du använder det här elementet när du vill ange parametervärdena direkt i begäran i stället för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. Det kan vara en JObject- eller en välformulerad JSON-sträng.
parametersLink	ParametersLink	URI för parameterfilen. Du använder det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda.
template	object	Mallinnehållet. Du använder det här elementet när du vill skicka mallsyntaxen direkt i begäran i stället för att länka till en befintlig mall. Det kan vara en JObject- eller välformulerad JSON-sträng. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.
templateLink	TemplateLink	Mallens URI. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.
whatIfSettings	DeploymentWhatIfSettings	Valfria What-If åtgärdsinställningar.

DeploymentWhatIfSettings

Inställningar för distribution What-If åtgärder.

Name	Typ	Description
resultFormat	WhatIfResultFormat	Formatet på What-If resultat

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorResponse

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ExpressionEvaluationOptions

Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen.

Name	Typ	Description
scope	ExpressionEvaluationOptionsScopeType	Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.

ExpressionEvaluationOptionsScopeType

Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.

Name	Typ	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Distribution av felbeteende.

Name	Typ	Description
deploymentName	string	Distributionen som ska användas i ett felfall.
type	OnErrorDeploymentType	Distributionen av felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

OnErrorDeploymentType

Distributionen av felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

Name	Typ	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entitet som representerar referensen till distributionsparametrarna.

Name	Typ	Description
contentVersion	string	Om den ingår måste den matcha ContentVersion i mallen.
uri	string	URI för parameterfilen.

PropertyChangeType

Typ av egenskapsändring.

Name	Typ	Description
Array	string	Egenskapen är en matris och innehåller kapslade ändringar.
Create	string	Egenskapen finns inte i det aktuella tillståndet men finns i önskat tillstånd. Egenskapen skapas när distributionen körs.
Delete	string	Egenskapen finns i det aktuella tillståndet och saknas i önskat tillstånd. Den tas bort när distributionen körs.
Modify	string	Egenskapen finns i både aktuellt och önskat tillstånd och är annorlunda. Värdet för egenskapen ändras när distributionen körs.
NoEffect	string	Egenskapen kommer inte att anges eller uppdateras.

ScopedDeploymentWhatIf

Distribution Konsekvensparametrar.

Name	Typ	Description
location	string	Platsen där distributionsdata ska lagras.
properties	DeploymentWhatIfProperties	Distributionsegenskaperna.

TemplateLink

Entitet som representerar referensen till mallen.

Name	Typ	Description
contentVersion	string	Om den ingår måste den matcha ContentVersion i mallen.
id	string	Resurs-ID:t för en mallspecifikation. Använd antingen ID- eller URI-egenskapen, men inte båda.
queryString	string	Frågesträngen (till exempel en SAS-token) som ska användas med templateLink-URI:n.
relativePath	string	Egenskapen relativePath kan användas för att distribuera en länkad mall på en plats i förhållande till den överordnade. Om den överordnade mallen var länkad till en TemplateSpec refererar detta till en artefakt i TemplateSpec. Om den överordnade var länkad med en URI är den underordnade distributionen en kombination av de överordnade och relativePath-URI:erna
uri	string	URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda.

WhatIfChange

Information om en enskild resursändring som förutsägs av What-If åtgärd.

Name	Typ	Description
after	object	Den förutsagda ögonblicksbilden av resursen efter att distributionen har körts.
before	object	Ögonblicksbilden av resursen innan distributionen körs.
changeType	ChangeType	Typ av ändring som görs i resursen när distributionen körs.
delta	WhatIfPropertyChange[]	De förutsagda ändringarna av resursegenskaper.
resourceId	string	Resurs-ID
unsupportedReason	string	Förklaringen till varför resursen inte stöds av Konsekvens.

WhatIfOperationResult

Resultatet av den What-If åtgärden. Innehåller en lista över förutsagda ändringar och en URL-länk för att komma till nästa uppsättning resultat.

Name	Typ	Description
error	ErrorResponse	Felsvar Fel när What-If åtgärden misslyckas.
properties.changes	WhatIfChange[]	Lista över resursändringar som förutsägs av What-If åtgärden.
status	string	Status för åtgärden What-If.

WhatIfPropertyChange

Den förutsagda ändringen av resursegenskapen.

Name	Typ	Description
after	object	Värdet för egenskapen efter att distributionen har körts.
before	object	Värdet för egenskapen innan distributionen körs.
children	WhatIfPropertyChange[]	Kapslade egenskapsändringar.
path	string	Sökvägen till egenskapen .
propertyChangeType	PropertyChangeType	Typ av egenskapsändring.

WhatIfResultFormat

Formatet på What-If resultat

Name	Typ	Description
FullResourcePayloads	string
ResourceIdOnly	string

Dela via

Deployments - What If At Tenant Scope

URI-parametrar

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Predict template changes at management group scope

Exempelbegäran

Exempelsvar

Definitioner

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Ytterligare resurser