Deployments - What If At Tenant Scope

Reference

Service:: Resource Management

API Version:: 2021-04-01

Vrátí změny, které provede nasazení v rozsahu skupiny tenantů.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
deploymentName	path	True	string	Název nasazení. Regex pattern: `^[-\w\._\(\)]+$`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

deploymentName

path

True

string

Název nasazení.

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

api-version

query

True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
location	True	string	Umístění pro uložení dat nasazení.
properties	True	DeploymentWhatIfProperties	Vlastnosti nasazení.

Odpovědi

Name	Typ	Description
200 OK	WhatIfOperationResult	OK – vrátí stav operace What-If.
202 Accepted		Přijato – vrátí adresu URL v hlavičce umístění pro dotaz na stav dlouhotrvající operace. Headers Location: string Retry-After: string
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

WhatIfOperationResult

OK – vrátí stav operace What-If.

202 Accepted

Přijato – vrátí adresu URL v hlavičce umístění pro dotaz na stav dlouhotrvající operace.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
ChangeType	Typ změny, která se provede v prostředku při spuštění nasazení.
CloudError	Chybová odpověď pro žádost o správu prostředků.
DebugSetting	Nastavení ladění
DeploymentMode	Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení buďte opatrní, protože můžete neúmyslně odstranit prostředky.
DeploymentWhatIfProperties	Vlastnosti citlivostní analýzy nasazení
DeploymentWhatIfSettings	Nasazení What-If nastavení operace.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Odpověď na chybu
ExpressionEvaluationOptions	Určuje, jestli se výrazy šablony vyhodnocují v rámci rozsahu nadřazené šablony nebo vnořené šablony.
ExpressionEvaluationOptionsScopeType	Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.
OnErrorDeployment	Nasazení při chybovém chování.
OnErrorDeploymentType	Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment.
ParametersLink	Entita představující odkaz na parametry nasazení
PropertyChangeType	Typ vlastnosti se změní.
ScopedDeploymentWhatIf	Parametry operace Citlivostní analýza nasazení.
TemplateLink	Entita představující odkaz na šablonu
WhatIfChange	Informace o změně jednoho prostředku předpovězené operací What-If
WhatIfOperationResult	Výsledek operace What-If. Obsahuje seznam předpověděných změn a odkaz url pro přístup k další sadě výsledků.
WhatIfPropertyChange	Predikovaná změna vlastnosti prostředku
WhatIfResultFormat	Formát výsledků What-If

ChangeType

Typ změny, která se provede v prostředku při spuštění nasazení.

Name	Typ	Description
Create	string	Prostředek neexistuje v aktuálním stavu, ale je v požadovaném stavu. Prostředek se vytvoří při spuštění nasazení.
Delete	string	Prostředek existuje v aktuálním stavu a chybí v požadovaném stavu. Prostředek se odstraní při spuštění nasazení.
Deploy	string	Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se mohou nebo nemusí změnit.
Ignore	string	Prostředek existuje v aktuálním stavu a chybí v požadovaném stavu. Při spuštění nasazení se prostředek nenasadí ani neupraví.
Modify	string	Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se změní.
NoChange	string	Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se nezmění.
Unsupported	string	What-If prostředek nepodporuje.

CloudError

Chybová odpověď pro žádost o správu prostředků.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Běžná odpověď na chybu pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (To také odpovídá formátu odpovědi na chybu OData.)

DebugSetting

Nastavení ladění

Name	Typ	Description
detailLevel	string	Určuje typ informací, které se mají protokolovat pro ladění. Povolené hodnoty jsou none, requestContent, responseContent nebo requestContent a responseContent oddělené čárkami. Výchozí hodnota je none. Při nastavování této hodnoty pečlivě zvažte typ informací, které předáváte během nasazování. Protokolováním informací o požadavku nebo odpovědi můžete potenciálně zveřejnit citlivá data, která se načítají prostřednictvím operací nasazení.

DeploymentMode

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení buďte opatrní, protože můžete neúmyslně odstranit prostředky.

Name	Typ	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

Vlastnosti citlivostní analýzy nasazení

Name	Typ	Description
debugSetting	DebugSetting	Nastavení ladění nasazení.
expressionEvaluationOptions	ExpressionEvaluationOptions	Určuje, jestli se výrazy šablony vyhodnocují v rámci rozsahu nadřazené šablony nebo vnořené šablony. Platí jenom pro vnořené šablony. Pokud není zadán, výchozí hodnota je vnější.
mode	DeploymentMode	Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo dokončená. V přírůstkovém režimu se prostředky nasadí bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a stávající prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při používání režimu úplného dokončení buďte opatrní, protože můžete neúmyslně odstranit prostředky.
onErrorDeployment	OnErrorDeployment	Chování nasazení při chybě.
parameters	object	Páry název a hodnota, které definují parametry nasazení pro šablonu. Tento prvek použijete, když chcete zadat hodnoty parametrů přímo v požadavku místo propojení s existujícím souborem parametrů. Použijte vlastnost parametersLink nebo vlastnost parameters, ale ne obě vlastnosti. Může to být JObject nebo dobře formátovaný řetězec JSON.
parametersLink	ParametersLink	Identifikátor URI souboru parametrů. Tento prvek použijete k propojení s existujícím souborem parametrů. Použijte vlastnost parametersLink nebo vlastnost parameters, ale ne obě vlastnosti.
template	object	Obsah šablony. Tento prvek použijete, když chcete předat syntaxi šablony přímo v požadavku místo propojení s existující šablonou. Může to být JObject nebo dobře formátovaný řetězec JSON. Použijte vlastnost templateLink nebo vlastnost šablony, ale ne obojí.
templateLink	TemplateLink	Identifikátor URI šablony Použijte vlastnost templateLink nebo vlastnost šablony, ale ne obojí.
whatIfSettings	DeploymentWhatIfSettings	Volitelné What-If nastavení operace.

DeploymentWhatIfSettings

Nasazení What-If nastavení operace.

Name	Typ	Description
resultFormat	WhatIfResultFormat	Formát výsledků What-If

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorResponse[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ExpressionEvaluationOptions

Určuje, jestli se výrazy šablony vyhodnocují v rámci rozsahu nadřazené šablony nebo vnořené šablony.

Name	Typ	Description
scope	ExpressionEvaluationOptionsScopeType	Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.

ExpressionEvaluationOptionsScopeType

Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí ve vnořené šabloně.

Name	Typ	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Nasazení při chybovém chování.

Name	Typ	Description
deploymentName	string	Nasazení, které se má použít v případě chyby.
type	OnErrorDeploymentType	Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

OnErrorDeploymentType

Typ chování nasazení při chybě. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

Name	Typ	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entita představující odkaz na parametry nasazení

Name	Typ	Description
contentVersion	string	Pokud je součástí, musí se shodovat s ContentVersion v šabloně.
uri	string	Identifikátor URI souboru parametrů.

PropertyChangeType

Typ vlastnosti se změní.

Name	Typ	Description
Array	string	Vlastnost je pole a obsahuje vnořené změny.
Create	string	Vlastnost neexistuje v aktuálním stavu, ale je v požadovaném stavu. Vlastnost se vytvoří při spuštění nasazení.
Delete	string	Vlastnost existuje v aktuálním stavu a v požadovaném stavu chybí. Při spuštění nasazení se odstraní.
Modify	string	Vlastnost existuje v aktuálním i požadovaném stavu a liší se. Hodnota vlastnosti se změní při spuštění nasazení.
NoEffect	string	Vlastnost nebude nastavena ani aktualizována.

ScopedDeploymentWhatIf

Parametry operace Citlivostní analýza nasazení.

Name	Typ	Description
location	string	Umístění pro uložení dat nasazení.
properties	DeploymentWhatIfProperties	Vlastnosti nasazení.

TemplateLink

Entita představující odkaz na šablonu

Name	Typ	Description
contentVersion	string	Pokud je součástí, musí se shodovat s ContentVersion v šabloně.
id	string	ID prostředku specifikace šablony. Použijte buď vlastnost ID, nebo URI, ale ne obě.
queryString	string	Řetězec dotazu (například token SAS), který se má použít s identifikátorem URI templateLink.
relativePath	string	Vlastnost relativePath lze použít k nasazení propojené šablony v umístění relativním k nadřazené. Pokud byla nadřazená šablona propojena se šablonou TemplateSpec, bude odkazovat na artefakt v TemplateSpec. Pokud byl nadřazený objekt propojený pomocí identifikátoru URI, podřízené nasazení bude kombinací nadřazených a relativních identifikátorů URI.
uri	string	Identifikátor URI šablony, která se má nasadit. Použijte vlastnost URI nebo ID, ale ne obě vlastnosti.

WhatIfChange

Informace o změně jednoho prostředku předpovězené operací What-If

Name	Typ	Description
after	object	Predikovaný snímek prostředku po spuštění nasazení
before	object	Snímek prostředku před spuštěním nasazení
changeType	ChangeType	Typ změny, která se provede v prostředku při spuštění nasazení.
delta	WhatIfPropertyChange[]	Predikované změny vlastností prostředku
resourceId	string	ID prostředku
unsupportedReason	string	Vysvětlení, proč what-If prostředek nepodporuje.

WhatIfOperationResult

Výsledek operace What-If. Obsahuje seznam předpověděných změn a odkaz url pro přístup k další sadě výsledků.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Chyba při selhání operace What-If
properties.changes	WhatIfChange[]	Seznam změn prostředků předpověděných operací What-If
status	string	Stav operace What-If.

WhatIfPropertyChange

Predikovaná změna vlastnosti prostředku

Name	Typ	Description
after	object	Hodnota vlastnosti po spuštění nasazení.
before	object	Hodnota vlastnosti před spuštěním nasazení.
children	WhatIfPropertyChange[]	Změny vnořených vlastností
path	string	Cesta vlastnosti.
propertyChangeType	PropertyChangeType	Typ vlastnosti se změní.

WhatIfResultFormat

Formát výsledků What-If

Name	Typ	Description
FullResourcePayloads	string
ResourceIdOnly	string

Deployments - What If At Tenant Scope

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

Predict template changes at management group scope

Sample Request

Sample Response

Definice

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Další materiály