Deployments - What If At Tenant Scope

Referencia

Service:: Resource Management

API Version:: 2021-04-01

Olyan módosításokat ad vissza, amelyeket az üzembe helyezés hajt végre, ha a bérlőcsoport hatókörében hajtják végre.

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

URI-paraméterek

Name In Kötelező Típus Description

Name	In	Kötelező	Típus	Description
deploymentName	path	True	string	Az üzembe helyezés neve. Regex pattern: `^[-\w\._\(\)]+$`
api-version	query	True	string	A művelethez használandó API-verzió.

deploymentName

path

True

string

Az üzembe helyezés neve.

Regex pattern: ^[-\w\._]+$

api-version

query

True

string

A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Az üzembehelyezési adatok tárolásának helye.
properties	True	DeploymentWhatIfProperties	Az üzembehelyezési tulajdonságok.

Válaszok

Name	Típus	Description
200 OK	WhatIfOperationResult	OK – What-If művelet állapotát adja vissza
202 Accepted		Elfogadva – A helyfejléc URL-címét adja vissza a hosszú ideig futó művelet állapotának lekérdezéséhez. Headers Location: string Retry-After: string
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Name

Típus

Description

200 OK

WhatIfOperationResult

OK – What-If művelet állapotát adja vissza

202 Accepted

Elfogadva – A helyfejléc URL-címét adja vissza a hosszú ideig futó művelet állapotának lekérdezéséhez.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Predict template changes at management group scope

Sample Request

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

Sample Response

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

Status code:: 202

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

Definíciók

Name	Description
ChangeType	Az erőforráson az üzembe helyezés végrehajtásakor végrehajtandó módosítás típusa.
CloudError	Hibaválasz egy erőforrás-kezelési kérelemhez.
DebugSetting	A hibakeresési beállítás.
DeploymentMode	Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő erőforráscsoportban lévő meglévő erőforrások törlődnek. Legyen óvatos a Teljes mód használata során, mivel előfordulhat, hogy véletlenül törli az erőforrásokat.
DeploymentWhatIfProperties	Üzembe helyezési lehetőség tulajdonságai.
DeploymentWhatIfSettings	Üzembe helyezési What-If műveleti beállítások.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Hibaválasz
ExpressionEvaluationOptions	Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e.
ExpressionEvaluationOptionsScopeType	A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.
OnErrorDeployment	Üzembe helyezés hiba működés közben.
OnErrorDeploymentType	Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.
ParametersLink	Az üzembehelyezési paraméterekre mutató hivatkozást képviselő entitás.
PropertyChangeType	A tulajdonságváltozás típusa.
ScopedDeploymentWhatIf	Üzembe helyezési lehetőség műveleti paraméterei.
TemplateLink	A sablonra mutató hivatkozást képviselő entitás.
WhatIfChange	A What-If művelet által előrejelzett egyetlen erőforrás-változásra vonatkozó információk.
WhatIfOperationResult	A What-If művelet eredménye. Tartalmazza az előrejelzett változások listáját és egy URL-hivatkozást a következő eredményhalmaz eléréséhez.
WhatIfPropertyChange	Az erőforrástulajdonság előrejelzett módosítása.
WhatIfResultFormat	A What-If eredmények formátuma

ChangeType

Az erőforráson az üzembe helyezés végrehajtásakor végrehajtandó módosítás típusa.

Name	Típus	Description
Create	string	Az erőforrás nem létezik az aktuális állapotban, de a kívánt állapotban van. Az erőforrás az üzembe helyezés végrehajtásakor jön létre.
Delete	string	Az erőforrás az aktuális állapotban létezik, és hiányzik a kívánt állapotból. Az erőforrás az üzembe helyezés végrehajtásakor törlődik.
Deploy	string	Az erőforrás az aktuális állapotban és a kívánt állapotban van, és az üzembe helyezés végrehajtásakor újra üzembe helyezi. Az erőforrás tulajdonságai megváltozhatnak, de nem feltétlenül.
Ignore	string	Az erőforrás az aktuális állapotban létezik, és hiányzik a kívánt állapotból. Az erőforrás nem lesz üzembe helyezve vagy módosítva az üzembe helyezés végrehajtásakor.
Modify	string	Az erőforrás az aktuális állapotban és a kívánt állapotban van, és az üzembe helyezés végrehajtásakor újra üzembe helyezi. Az erőforrás tulajdonságai megváltoznak.
NoChange	string	Az erőforrás az aktuális állapotban és a kívánt állapotban van, és az üzembe helyezés végrehajtásakor újra üzembe helyezi. Az erőforrás tulajdonságai nem változnak.
Unsupported	string	Az erőforrást a What-If nem támogatja.

CloudError

Hibaválasz egy erőforrás-kezelési kérelemhez.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Az összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

DebugSetting

A hibakeresési beállítás.

Name	Típus	Description
detailLevel	string	Megadja a hibakereséshez naplózandó információk típusát. Az engedélyezett értékek: requestContent, responseContent vagy requestContent és responseContent vesszővel elválasztva. Az alapértelmezett érték a none. Az érték beállításakor gondosan vegye figyelembe, hogy milyen típusú információkat ad át az üzembe helyezés során. A kéréssel vagy válaszsal kapcsolatos információk naplózásával potenciálisan bizalmas adatokat tehet közzé, amelyeket az üzembehelyezési műveletek során kérnek le.

DeploymentMode

Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő erőforráscsoportban lévő meglévő erőforrások törlődnek. Legyen óvatos a Teljes mód használata során, mivel előfordulhat, hogy véletlenül törli az erőforrásokat.

Name	Típus	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

Üzembe helyezési lehetőség tulajdonságai.

Name	Típus	Description
debugSetting	DebugSetting	Az üzembe helyezés hibakeresési beállítása.
expressionEvaluationOptions	ExpressionEvaluationOptions	Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e. Csak beágyazott sablonokra alkalmazható. Ha nincs megadva, az alapértelmezett érték külső.
mode	DeploymentMode	Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő erőforráscsoportban lévő meglévő erőforrások törlődnek. Legyen óvatos a Teljes mód használata során, mivel előfordulhat, hogy véletlenül törli az erőforrásokat.
onErrorDeployment	OnErrorDeployment	A hiba működésével kapcsolatos üzembe helyezés.
parameters	object	Név- és értékpárok, amelyek meghatározzák a sablon üzembehelyezési paramétereit. Ezt az elemet akkor használja, ha közvetlenül a kérelemben szeretné megadni a paraméterértékeket, nem pedig egy meglévő paraméterfájlra mutató hivatkozást. Használja a parametersLink tulajdonságot vagy a parameters tulajdonságot, de mindkettőt nem. Ez lehet JObject vagy jól formázott JSON-sztring.
parametersLink	ParametersLink	A paraméterfájl URI-ja. Ezzel az elemel hivatkozhat egy meglévő paraméterfájlra. Használja a parametersLink tulajdonságot vagy a parameters tulajdonságot, de mindkettőt nem.
template	object	A sablon tartalma. Ezt az elemet akkor használja, ha a sablon szintaxisát közvetlenül a kérelemben szeretné átadni, nem pedig egy meglévő sablonra mutató hivatkozást. Ez lehet JObject vagy jól formázott JSON-sztring. Használja a templateLink tulajdonságot vagy a sablontulajdonságot, de mindkettőt nem.
templateLink	TemplateLink	A sablon URI-ja. Használja a templateLink tulajdonságot vagy a sablontulajdonságot, de mindkettőt nem.
whatIfSettings	DeploymentWhatIfSettings	Nem kötelező What-If műveleti beállítások.

DeploymentWhatIfSettings

Üzembe helyezési What-If műveleti beállítások.

Name	Típus	Description
resultFormat	WhatIfResultFormat	A What-If eredmények formátuma

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ExpressionEvaluationOptions

Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e.

Name	Típus	Description
scope	ExpressionEvaluationOptionsScopeType	A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.

ExpressionEvaluationOptionsScopeType

A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.

Name	Típus	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Üzembe helyezés hiba működés közben.

Name	Típus	Description
deploymentName	string	A hibaesetben használni kívánt üzembe helyezés.
type	OnErrorDeploymentType	Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

Name	Típus	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Az üzembehelyezési paraméterekre mutató hivatkozást képviselő entitás.

Name	Típus	Description
contentVersion	string	Ha szerepel a fájlban, meg kell egyeznie a sablon ContentVersion elemével.
uri	string	A paraméterfájl URI-ja.

PropertyChangeType

A tulajdonságváltozás típusa.

Name	Típus	Description
Array	string	A tulajdonság egy tömb, amely beágyazott módosításokat tartalmaz.
Create	string	A tulajdonság nem létezik az aktuális állapotban, de a kívánt állapotban van. A tulajdonság az üzembe helyezés végrehajtásakor jön létre.
Delete	string	A tulajdonság az aktuális állapotban létezik, és hiányzik a kívánt állapotból. Az üzembe helyezés végrehajtásakor a rendszer törli.
Modify	string	A tulajdonság a jelenlegi és a kívánt állapotban is létezik, és eltérő. A tulajdonság értéke megváltozik az üzembe helyezés végrehajtásakor.
NoEffect	string	A tulajdonság nem lesz beállítva vagy frissítve.

ScopedDeploymentWhatIf

Üzembe helyezési lehetőség műveleti paraméterei.

Name	Típus	Description
location	string	Az üzembehelyezési adatok tárolásának helye.
properties	DeploymentWhatIfProperties	Az üzembehelyezési tulajdonságok.

TemplateLink

A sablonra mutató hivatkozást képviselő entitás.

Name	Típus	Description
contentVersion	string	Ha szerepel a fájlban, meg kell egyeznie a sablon ContentVersion elemével.
id	string	Egy sablonspecifikáció erőforrás-azonosítója. Használja az id vagy az uri tulajdonságot, de mindkettőt nem.
queryString	string	A templateLink URI-val használandó lekérdezési sztring (például SAS-jogkivonat).
relativePath	string	A relativePath tulajdonság használatával a szülőhöz viszonyított helyen helyezhet üzembe csatolt sablont. Ha a szülősablon egy TemplateSpec elemhez lett csatolva, az a TemplateSpec elemére fog hivatkozni. Ha a szülő URI-val lett összekapcsolva, a gyermek üzembe helyezése a szülő és a relatívPath URI-k kombinációja lesz
uri	string	Az üzembe helyezendő sablon URI-ja. Használja az uri vagy az id tulajdonságot, de mindkettőt nem.

WhatIfChange

A What-If művelet által előrejelzett egyetlen erőforrás-változásra vonatkozó információk.

Name	Típus	Description
after	object	Az erőforrás előrejelzett pillanatképe az üzembe helyezés végrehajtása után.
before	object	Az erőforrás pillanatképe az üzembe helyezés végrehajtása előtt.
changeType	ChangeType	Az erőforráson az üzembe helyezés végrehajtásakor végrehajtandó módosítás típusa.
delta	WhatIfPropertyChange[]	Az erőforrás tulajdonságainak előrejelzett változásai.
resourceId	string	Erőforrás-azonosító
unsupportedReason	string	Annak magyarázata, hogy miért nem támogatja az erőforrást a What-If.

WhatIfOperationResult

A What-If művelet eredménye. Tartalmazza az előrejelzett változások listáját és egy URL-hivatkozást a következő eredményhalmaz eléréséhez.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Hiba What-If művelet meghiúsulásakor.
properties.changes	WhatIfChange[]	A What-If művelet által előrejelzett erőforrásváltozások listája.
status	string	A What-If művelet állapota.

WhatIfPropertyChange

Az erőforrástulajdonság előrejelzett módosítása.

Name	Típus	Description
after	object	A tulajdonság értéke az üzembe helyezés végrehajtása után.
before	object	A tulajdonság értéke az üzembe helyezés végrehajtása előtt.
children	WhatIfPropertyChange[]	Beágyazott tulajdonságváltozások.
path	string	A tulajdonság elérési útja.
propertyChangeType	PropertyChangeType	A tulajdonságváltozás típusa.

WhatIfResultFormat

A What-If eredmények formátuma

Name	Típus	Description
FullResourcePayloads	string
ResourceIdOnly	string

Deployments - What If At Tenant Scope

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Scopes

Példák

Predict template changes at management group scope

Sample Request

Sample Response

Definíciók

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

További források