Deployments - What If At Tenant Scope

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 dzierżawy.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

Nazwa	W	Wymagane	Typ	Opis
deploymentName	path	True	string	Nazwa wdrożenia. Wzorzec wyrażenia regularnego: `^[-\w\._\(\)]+$`
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

deploymentName

path

True

string

Nazwa wdrożenia.

Wzorzec wyrażenia regularnego: ^[-\w\._]+$

api-version

query

True

string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

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

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WhatIfOperationResult	OK — zwraca stan operacji What-If
202 Accepted		Zaakceptowane — zwraca adres URL w nagłówku Lokalizacja, 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 Lokalizacja, 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 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 management group scope

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Kod stanu:: 202

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

Definicje

Nazwa	Opis
ChangeType	Typ zmiany, która zostanie wprowadzonych do zasobu podczas wykonywania wdrożenia.
CloudError	Odpowiedź na błąd żądania zarządzania zasobami.
DebugSetting	Ustawienie debugowania.
DeploymentMode	Tryb używany do wdrażania zasobów. Może to być wartość przyrostowa lub kompletna. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie pełnym 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 pełnego, ponieważ możesz przypadkowo usunąć zasoby.
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, czy szablonu zagnieżdżonego.
ExpressionEvaluationOptionsScopeType	Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.
OnErrorDeployment	Wdrażanie przy zachowaniu błędów.
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 zmiany właściwości.
ScopedDeploymentWhatIf	Wdrażanie parametrów operacji analizy co-jeżeli.
TemplateLink	Jednostka reprezentująca odwołanie do szablonu.
WhatIfChange	Informacje o zmianie pojedynczego zasobu przewidywanej przez operację What-If.
WhatIfOperationResult	Wynik operacji What-If. Zawiera listę przewidywanych zmian i link adresu URL umożliwiający uzyskanie do następnego zestawu wyników.
WhatIfPropertyChange	Przewidywana zmiana właściwości zasobu.
WhatIfResultFormat	Format wyników What-If

ChangeType

Typ zmiany, która zostanie wprowadzonych do zasobu podczas wykonywania wdrożenia.

Nazwa	Typ	Opis
Create	string	Zasób nie istnieje w bieżącym stanie, ale jest obecny w żądanym stanie. Zasób zostanie utworzony po wykonaniu wdrożenia.
Delete	string	Zasób istnieje w bieżącym stanie i brakuje go w żądanym stanie. Zasób zostanie usunięty po wykonaniu wdrożenia.
Deploy	string	Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie wdrożony ponownie po wykonaniu wdrożenia. Właściwości zasobu mogą, ale nie muszą ulec zmianie.
Ignore	string	Zasób istnieje w bieżącym stanie i brakuje go w żądanym stanie. Po wykonaniu wdrożenia zasób nie zostanie wdrożony ani zmodyfikowany.
Modify	string	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	string	Zasób istnieje w bieżącym stanie i żądanym stanie i zostanie wdrożony ponownie po wykonaniu wdrożenia. Właściwości zasobu nie zostaną zmienione.
Unsupported	string	Zasób nie jest obsługiwany przez funkcję What-If.

CloudError

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 zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

DebugSetting

Ustawienie debugowania.

Nazwa	Typ	Opis
detailLevel	string	Określa typ informacji do rejestrowania na potrzeby debugowania. Dozwolone wartości to brak, requestContent, responseContent lub zarówno requestContent, jak i responseContent oddzielone przecinkiem. 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

Tryb używany do wdrażania zasobów. Może to być wartość przyrostowa lub kompletna. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie pełnym 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 pełnego, ponieważ możesz przypadkowo usunąć zasoby.

Nazwa	Typ	Opis
Complete	string
Incremental	string

DeploymentWhatIfProperties

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, czy 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. Może to być wartość przyrostowa lub kompletna. W trybie przyrostowym zasoby są wdrażane bez usuwania istniejących zasobów, które nie są uwzględnione w szablonie. W trybie pełnym 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 pełnego, ponieważ możesz przypadkowo usunąć zasoby.
onErrorDeployment	OnErrorDeployment	Wdrożenie przy zachowaniu błędu.
parameters	object	Pary nazw i wartości definiujące parametry wdrożenia dla szablonu. Tego elementu należy użyć, jeśli 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ć 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

Ustawienia operacji What-If wdrażania.

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

ErrorAdditionalInfo

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

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

ErrorResponse

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

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

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

ExpressionEvaluationOptionsScopeType

Zakres, który ma być używany do oceny parametrów, zmiennych i funkcji w szablonie zagnieżdżonym.

Nazwa	Typ	Opis
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Wdrażanie przy zachowaniu błędów.

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

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

Nazwa	Typ	Opis
LastSuccessful	string
SpecificDeployment	string

ParametersLink

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

Typ zmiany właściwości.

Nazwa	Typ	Opis
Array	string	Właściwość jest tablicą i zawiera zagnieżdżone zmiany.
Create	string	Właściwość nie istnieje w bieżącym stanie, ale jest obecna w żądanym stanie. Właściwość zostanie utworzona po wykonaniu wdrożenia.
Delete	string	Właściwość istnieje w bieżącym stanie i brakuje jej w żądanym stanie. Zostanie on usunięty po wykonaniu wdrożenia.
Modify	string	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	string	Właściwość nie zostanie ustawiona ani zaktualizowana.

ScopedDeploymentWhatIf

Wdrażanie parametrów operacji analizy co-jeżeli.

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

TemplateLink

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 id lub uri, ale nie obu.
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, spowoduje to odwołanie 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 relativePath
uri	string	Identyfikator URI szablonu do wdrożenia. Użyj właściwości URI lub id, ale nie obu.

WhatIfChange

Informacje o zmianie pojedynczego 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 wprowadzonych do zasobu podczas wykonywania wdrożenia.
delta	WhatIfPropertyChange[]	Przewidywane zmiany właściwości zasobów.
resourceId	string	Identyfikator zasobu
unsupportedReason	string	Wyjaśnienie, dlaczego zasób jest nieobsługiwany przez what-If.

WhatIfOperationResult

Wynik operacji What-If. Zawiera listę przewidywanych zmian i link adresu URL umożliwiający uzyskanie 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

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 zmiany właściwości.

WhatIfResultFormat

Format wyników What-If

Nazwa	Typ	Opis
FullResourcePayloads	string
ResourceIdOnly	string

Udostępnij za pośrednictwem

Deployments - What If At Tenant Scope

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Predict template changes at management group scope

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Dodatkowe zasoby