Deployments - What If At Tenant Scope

Referentie

Service:: Resource Management

API-versie:: 2021-04-01

Retourneert wijzigingen die door de implementatie worden aangebracht als deze worden uitgevoerd binnen het bereik van de tenantgroep.

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

URI-parameters

Name In Vereist Type Description

Name	In	Vereist	Type	Description
deploymentName	path	True	string	De naam van de implementatie. Regex-patroon: `^[-\w\._\(\)]+$`
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

deploymentName

path

True

string

De naam van de implementatie.

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

api-version

query

True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	De locatie voor het opslaan van de implementatiegegevens.
properties	True	DeploymentWhatIfProperties	De implementatie-eigenschappen.

Antwoorden

Name	Type	Description
200 OK	WhatIfOperationResult	OK: retourneert What-If bewerkingsstatus
202 Accepted		Geaccepteerd: retourneert de URL in de locatieheader om de status van de langlopende bewerking op te vragen. Kopteksten Location: string Retry-After: string
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

WhatIfOperationResult

OK: retourneert What-If bewerkingsstatus

202 Accepted

Geaccepteerd: retourneert de URL in de locatieheader om de status van de langlopende bewerking op te vragen.

Kopteksten

Location: string
Retry-After: string

Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

Predict template changes at management group scope

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Statuscode:: 202

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

Definities

Name	Description
ChangeType	Type wijziging dat wordt aangebracht in de resource wanneer de implementatie wordt uitgevoerd.
CloudError	Een foutreactie voor een resourcebeheeraanvraag.
DebugSetting	De instelling voor foutopsporing.
DeploymentMode	De modus die wordt gebruikt om resources te implementeren. Deze waarde kan incrementeel of Voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de modus Volledig worden resources geïmplementeerd en worden bestaande resources in de resourcegroep die niet in de sjabloon zijn opgenomen, verwijderd. Wees voorzichtig met het gebruik van de modus Volledig, want u kunt onbedoeld resources verwijderen.
DeploymentWhatIfProperties	Wat-als-eigenschappen implementeren.
DeploymentWhatIfSettings	Instellingen voor implementatie What-If bewerking.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorResponse	Foutreactie
ExpressionEvaluationOptions	Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon.
ExpressionEvaluationOptionsScopeType	Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.
OnErrorDeployment	Implementatie bij foutgedrag.
OnErrorDeploymentType	De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.
ParametersLink	Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.
PropertyChangeType	Het type eigenschapswijziging.
ScopedDeploymentWhatIf	Parameters voor wat-als-bewerking implementeren.
TemplateLink	Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.
WhatIfChange	Informatie over één resourcewijziging die wordt voorspeld door What-If bewerking.
WhatIfOperationResult	Resultaat van de What-If bewerking. Bevat een lijst met voorspelde wijzigingen en een URL-koppeling om naar de volgende set resultaten te gaan.
WhatIfPropertyChange	De voorspelde wijziging van de resource-eigenschap.
WhatIfResultFormat	De indeling van de What-If resultaten

ChangeType

Type wijziging dat wordt aangebracht in de resource wanneer de implementatie wordt uitgevoerd.

Name	Type	Description
Create	string	De resource bestaat niet in de huidige status, maar is aanwezig in de gewenste status. De resource wordt gemaakt wanneer de implementatie wordt uitgevoerd.
Delete	string	De resource bestaat in de huidige status en ontbreekt in de gewenste status. De resource wordt verwijderd wanneer de implementatie wordt uitgevoerd.
Deploy	string	De resource bestaat in de huidige status en de gewenste status en wordt opnieuw geïmplementeerd wanneer de implementatie wordt uitgevoerd. De eigenschappen van de resource worden mogelijk wel of niet gewijzigd.
Ignore	string	De resource bestaat in de huidige status en ontbreekt in de gewenste status. De resource wordt niet geïmplementeerd of gewijzigd wanneer de implementatie wordt uitgevoerd.
Modify	string	De resource bestaat in de huidige status en de gewenste status en wordt opnieuw geïmplementeerd wanneer de implementatie wordt uitgevoerd. De eigenschappen van de resource worden gewijzigd.
NoChange	string	De resource bestaat in de huidige status en de gewenste status en wordt opnieuw geïmplementeerd wanneer de implementatie wordt uitgevoerd. De eigenschappen van de resource worden niet gewijzigd.
Unsupported	string	De resource wordt niet ondersteund door What-If.

CloudError

Een foutreactie voor een resourcebeheeraanvraag.

Name	Type	Description
error	ErrorResponse	Foutreactie Algemene foutreactie voor alle Azure Resource Manager-API's om foutdetails voor mislukte bewerkingen te retourneren. (Dit volgt ook de indeling van de OData-foutreactie.)

DebugSetting

De instelling voor foutopsporing.

Name	Type	Description
detailLevel	string	Hiermee geeft u het type informatie op dat moet worden vastgelegd voor foutopsporing. De toegestane waarden zijn none, requestContent, responseContent of zowel requestContent als responseContent, gescheiden door een komma. De standaardwaarde is geen. Houd bij het instellen van deze waarde zorgvuldig rekening met het type informatie dat u tijdens de implementatie doorgeeft. Door informatie over de aanvraag of reactie te registreren, kunt u mogelijk gevoelige gegevens beschikbaar maken die worden opgehaald via de implementatiebewerkingen.

DeploymentMode

De modus die wordt gebruikt om resources te implementeren. Deze waarde kan incrementeel of Voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de modus Volledig worden resources geïmplementeerd en worden bestaande resources in de resourcegroep die niet in de sjabloon zijn opgenomen, verwijderd. Wees voorzichtig met het gebruik van de modus Volledig, want u kunt onbedoeld resources verwijderen.

Name	Type	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

Wat-als-eigenschappen implementeren.

Name	Type	Description
debugSetting	DebugSetting	De instelling voor foutopsporing van de implementatie.
expressionEvaluationOptions	ExpressionEvaluationOptions	Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon. Alleen van toepassing op geneste sjablonen. Als dit niet is opgegeven, is de standaardwaarde buitenste waarde.
mode	DeploymentMode	De modus die wordt gebruikt om resources te implementeren. Deze waarde kan incrementeel of Voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de modus Volledig worden resources geïmplementeerd en worden bestaande resources in de resourcegroep die niet in de sjabloon zijn opgenomen, verwijderd. Wees voorzichtig met het gebruik van de modus Volledig, want u kunt onbedoeld resources verwijderen.
onErrorDeployment	OnErrorDeployment	Het foutgedrag van de implementatie.
parameters	object	Naam- en waardeparen waarmee de implementatieparameters voor de sjabloon worden gedefinieerd. U gebruikt dit element als u de parameterwaarden rechtstreeks in de aanvraag wilt opgeven in plaats van een koppeling te maken naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de eigenschap parameters, maar niet beide. Dit kan een JObject of een goed gevormde JSON-tekenreeks zijn.
parametersLink	ParametersLink	De URI van het parameterbestand. U gebruikt dit element om een koppeling te maken naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de eigenschap parameters, maar niet beide.
template	object	De sjablooninhoud. U gebruikt dit element als u de sjabloonsyntaxis rechtstreeks in de aanvraag wilt doorgeven in plaats van een koppeling naar een bestaande sjabloon. Dit kan een JObject of een goed gevormde JSON-tekenreeks zijn. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide.
templateLink	TemplateLink	De URI van de sjabloon. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide.
whatIfSettings	DeploymentWhatIfSettings	Optionele What-If bewerkingsinstellingen.

DeploymentWhatIfSettings

Instellingen voor implementatie What-If bewerking.

Name	Type	Description
resultFormat	WhatIfResultFormat	De indeling van de What-If resultaten

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ExpressionEvaluationOptions

Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon.

Name	Type	Description
scope	ExpressionEvaluationOptionsScopeType	Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.

ExpressionEvaluationOptionsScopeType

Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.

Name	Type	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Implementatie bij foutgedrag.

Name	Type	Description
deploymentName	string	De implementatie die moet worden gebruikt voor foutcases.
type	OnErrorDeploymentType	De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.

OnErrorDeploymentType

De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.

Name	Type	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.

Name	Type	Description
contentVersion	string	Indien opgenomen, moet overeenkomen met de ContentVersion in de sjabloon.
uri	string	De URI van het parameterbestand.

PropertyChangeType

Het type eigenschapswijziging.

Name	Type	Description
Array	string	De eigenschap is een matrix en bevat geneste wijzigingen.
Create	string	De eigenschap bestaat niet in de huidige status, maar is aanwezig in de gewenste status. De eigenschap wordt gemaakt wanneer de implementatie wordt uitgevoerd.
Delete	string	De eigenschap bestaat in de huidige status en ontbreekt in de gewenste status. Deze wordt verwijderd wanneer de implementatie wordt uitgevoerd.
Modify	string	De eigenschap bestaat in zowel de huidige als de gewenste status en is anders. De waarde van de eigenschap verandert wanneer de implementatie wordt uitgevoerd.
NoEffect	string	De eigenschap wordt niet ingesteld of bijgewerkt.

ScopedDeploymentWhatIf

Parameters voor wat-als-bewerking implementeren.

Name	Type	Description
location	string	De locatie voor het opslaan van de implementatiegegevens.
properties	DeploymentWhatIfProperties	De implementatie-eigenschappen.

TemplateLink

Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.

Name	Type	Description
contentVersion	string	Indien opgenomen, moet overeenkomen met de ContentVersion in de sjabloon.
id	string	De resource-id van een sjabloonspecificatie. Gebruik de eigenschap id of URI, maar niet beide.
queryString	string	De querytekenreeks (bijvoorbeeld een SAS-token) die moet worden gebruikt met de templateLink-URI.
relativePath	string	De eigenschap relativePath kan worden gebruikt om een gekoppelde sjabloon te implementeren op een locatie ten opzichte van het bovenliggende item. Als de bovenliggende sjabloon is gekoppeld aan een TemplateSpec, verwijst dit naar een artefact in de TemplateSpec. Als het bovenliggende item is gekoppeld aan een URI, is de onderliggende implementatie een combinatie van de bovenliggende en relatievePath-URI's
uri	string	De URI van de sjabloon die moet worden geïmplementeerd. Gebruik de eigenschap URI of id, maar niet beide.

WhatIfChange

Informatie over één resourcewijziging die wordt voorspeld door What-If bewerking.

Name	Type	Description
after	object	De voorspelde momentopname van de resource nadat de implementatie is uitgevoerd.
before	object	De momentopname van de resource voordat de implementatie wordt uitgevoerd.
changeType	ChangeType	Type wijziging dat wordt aangebracht in de resource wanneer de implementatie wordt uitgevoerd.
delta	WhatIfPropertyChange[]	De voorspelde wijzigingen in resource-eigenschappen.
resourceId	string	Resource-id
unsupportedReason	string	De uitleg over waarom de resource niet wordt ondersteund door What-If.

WhatIfOperationResult

Resultaat van de What-If bewerking. Bevat een lijst met voorspelde wijzigingen en een URL-koppeling om naar de volgende set resultaten te gaan.

Name	Type	Description
error	ErrorResponse	Foutreactie Fout wanneer What-If bewerking mislukt.
properties.changes	WhatIfChange[]	Lijst met resourcewijzigingen die zijn voorspeld door What-If bewerking.
status	string	Status van de What-If bewerking.

WhatIfPropertyChange

De voorspelde wijziging van de resource-eigenschap.

Name	Type	Description
after	object	De waarde van de eigenschap nadat de implementatie is uitgevoerd.
before	object	De waarde van de eigenschap voordat de implementatie wordt uitgevoerd.
children	WhatIfPropertyChange[]	Wijzigingen in geneste eigenschappen.
path	string	Het pad van de eigenschap.
propertyChangeType	PropertyChangeType	Het type eigenschapswijziging.

WhatIfResultFormat

De indeling van de What-If resultaten

Name	Type	Description
FullResourcePayloads	string
ResourceIdOnly	string

Delen via

Deployments - What If At Tenant Scope

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Predict template changes at management group scope

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Aanvullende resources