Deployments - What If At Tenant Scope

Başvuru

Service:: Resource Management

API Version:: 2021-04-01

Kiracı grubunun kapsamında yürütülürse dağıtım tarafından yapılacak değişiklikleri döndürür.

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

URI Parametreleri

Name İçinde Gerekli Tür Description

Name	İçinde	Gerekli	Tür	Description
deploymentName	path	True	string	Dağıtımın adı. Regex pattern: `^[-\w\._\(\)]+$`
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

deploymentName

path

True

string

Dağıtımın adı.

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

api-version

query

True

string

Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
location	True	string	Dağıtım verilerini depolama konumu.
properties	True	DeploymentWhatIfProperties	Dağıtım özellikleri.

Yanıtlar

Name	Tür	Description
200 OK	WhatIfOperationResult	Tamam - What-If işlem durumunu döndürür
202 Accepted		Kabul Edildi - Uzun süre çalışan işlem durumunu sorgulamak için Konum üst bilgisindeki URL'yi döndürür. Headers Location: string Retry-After: string
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

WhatIfOperationResult

Tamam - What-If işlem durumunu döndürür

202 Accepted

Kabul Edildi - Uzun süre çalışan işlem durumunu sorgulamak için Konum üst bilgisindeki URL'yi döndürür.

Headers

Location: string
Retry-After: string

Other Status Codes

CloudError

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
ChangeType	Dağıtım yürütürken kaynakta yapılacak değişikliğin türü.
CloudError	Kaynak yönetimi isteği için hata yanıtı.
DebugSetting	Hata ayıklama ayarı.
DeploymentMode	Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil edilmeyen mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve kaynak grubundaki şablona dahil olmayan mevcut kaynaklar silinir. Kaynakları istemeden sildiğinizden, Tamamlama modunu kullanırken dikkatli olun.
DeploymentWhatIfProperties	Dağıtım Durum özellikleri.
DeploymentWhatIfSettings	Dağıtım What-If işlem ayarları.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorResponse	Hata Yanıtı
ExpressionEvaluationOptions	Şablon ifadelerinin üst şablon kapsamında mı yoksa iç içe yerleştirilmiş şablon kapsamında mı değerlendirildiğini belirtir.
ExpressionEvaluationOptionsScopeType	İç içe geçmiş bir şablondaki parametrelerin, değişkenlerin ve işlevlerin değerlendirilmesi için kullanılacak kapsam.
OnErrorDeployment	Hata davranışında dağıtım.
OnErrorDeploymentType	Hata davranışı türündeki dağıtım. Olası değerler LastSuccessful ve SpecificDeployment değerleridir.
ParametersLink	Dağıtım parametrelerine başvuruyu temsil eden varlık.
PropertyChangeType	Özellik değişikliğinin türü.
ScopedDeploymentWhatIf	Dağıtım Durum işlem parametreleri.
TemplateLink	Şablon başvuruyu temsil eden varlık.
WhatIfChange	What-If işlemi tarafından tahmin edilen tek bir kaynak değişikliği hakkında bilgi.
WhatIfOperationResult	What-If işleminin sonucu. Tahmin edilen değişikliklerin listesini ve bir sonraki sonuç kümesine ulaşmak için bir URL bağlantısı içerir.
WhatIfPropertyChange	Kaynak özelliğinde tahmin edilen değişiklik.
WhatIfResultFormat	What-If sonuçlarının biçimi

ChangeType

Dağıtım yürütürken kaynakta yapılacak değişikliğin türü.

Name	Tür	Description
Create	string	Kaynak geçerli durumda değil, istenen durumda mevcut. Dağıtım yürütürken kaynak oluşturulur.
Delete	string	Kaynak geçerli durumda ve istenen durumda yok. Dağıtım yürütürken kaynak silinir.
Deploy	string	Kaynak geçerli durumda ve istenen durumda bulunur ve dağıtım yürütürken yeniden dağıtılır. Kaynağın özellikleri değişebilir veya değişmeyebilir.
Ignore	string	Kaynak geçerli durumda ve istenen durumda yok. Dağıtım yürütürken kaynak dağıtılmaz veya değiştirilmez.
Modify	string	Kaynak geçerli durumda ve istenen durumda bulunur ve dağıtım yürütürken yeniden dağıtılır. Kaynağın özellikleri değişir.
NoChange	string	Kaynak geçerli durumda ve istenen durumda bulunur ve dağıtım yürütürken yeniden dağıtılır. Kaynağın özellikleri değişmez.
Unsupported	string	Kaynak What-If tarafından desteklenmiyor.

CloudError

Kaynak yönetimi isteği için hata yanıtı.

Name	Tür	Description
error	ErrorResponse	Hata Yanıtı Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.)

DebugSetting

Hata ayıklama ayarı.

Name	Tür	Description
detailLevel	string	Hata ayıklama için günlüğe kaydedilecek bilgi türünü belirtir. İzin verilen değerler hiçbiri, requestContent, responseContent veya virgülle ayrılmış requestContent ve responseContent değerleridir. Varsayılan değer none'dır. Bu değeri ayarlarken, dağıtım sırasında geçirdiğiniz bilgi türünü dikkatle göz önünde bulundurun. İstek veya yanıt hakkındaki bilgileri günlüğe kaydederek, dağıtım işlemleri aracılığıyla alınan hassas verileri potansiyel olarak kullanıma açabilirsiniz.

DeploymentMode

Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil edilmeyen mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve kaynak grubundaki şablona dahil olmayan mevcut kaynaklar silinir. Kaynakları istemeden sildiğinizden, Tamamlama modunu kullanırken dikkatli olun.

Name	Tür	Description
Complete	string
Incremental	string

DeploymentWhatIfProperties

Dağıtım Durum özellikleri.

Name	Tür	Description
debugSetting	DebugSetting	Dağıtımın hata ayıklama ayarı.
expressionEvaluationOptions	ExpressionEvaluationOptions	Şablon ifadelerinin üst şablon kapsamında mı yoksa iç içe yerleştirilmiş şablon kapsamında mı değerlendirildiğini belirtir. Yalnızca iç içe yerleştirilmiş şablonlar için geçerlidir. Belirtilmezse, varsayılan değer dıştır.
mode	DeploymentMode	Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil edilmeyen mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve kaynak grubundaki şablona dahil olmayan mevcut kaynaklar silinir. Kaynakları istemeden sildiğinizden, Tamamlama modunu kullanırken dikkatli olun.
onErrorDeployment	OnErrorDeployment	Hata davranışında dağıtım.
parameters	object	Şablon için dağıtım parametrelerini tanımlayan ad ve değer çiftleri. Parametre değerlerini varolan bir parametre dosyasına bağlamak yerine doğrudan istekte sağlamak istediğinizde bu öğeyi kullanırsınız. parametersLink özelliğini veya parameters özelliğini kullanın, ancak ikisini birden kullanmayın. Bu bir JObject veya iyi biçimlendirilmiş bir JSON dizesi olabilir.
parametersLink	ParametersLink	Parametre dosyasının URI'sini. Var olan bir parametre dosyasına bağlanmak için bu öğeyi kullanırsınız. parametersLink özelliğini veya parameters özelliğini kullanın, ancak ikisini birden kullanmayın.
template	object	Şablon içeriği. Şablon söz dizimini varolan bir şablona bağlamak yerine doğrudan istekte geçirmek istediğinizde bu öğeyi kullanırsınız. JObject veya iyi biçimlendirilmiş bir JSON dizesi olabilir. templateLink özelliğini veya template özelliğini kullanın, ancak ikisini birden kullanmayın.
templateLink	TemplateLink	Şablonun URI'si. templateLink özelliğini veya template özelliğini kullanın, ancak ikisini birden kullanmayın.
whatIfSettings	DeploymentWhatIfSettings	İsteğe bağlı What-If işlem ayarları.

DeploymentWhatIfSettings

Dağıtım What-If işlem ayarları.

Name	Tür	Description
resultFormat	WhatIfResultFormat	What-If sonuçlarının biçimi

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorResponse

Hata Yanıtı

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorResponse[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ExpressionEvaluationOptions

Şablon ifadelerinin üst şablon kapsamında mı yoksa iç içe yerleştirilmiş şablon kapsamında mı değerlendirildiğini belirtir.

Name	Tür	Description
scope	ExpressionEvaluationOptionsScopeType	İç içe geçmiş bir şablondaki parametrelerin, değişkenlerin ve işlevlerin değerlendirilmesi için kullanılacak kapsam.

ExpressionEvaluationOptionsScopeType

İç içe geçmiş bir şablondaki parametrelerin, değişkenlerin ve işlevlerin değerlendirilmesi için kullanılacak kapsam.

Name	Tür	Description
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

Hata davranışında dağıtım.

Name	Tür	Description
deploymentName	string	Hata durumunda kullanılacak dağıtım.
type	OnErrorDeploymentType	Hata davranışı türündeki dağıtım. Olası değerler LastSuccessful ve SpecificDeployment değerleridir.

OnErrorDeploymentType

Hata davranışı türündeki dağıtım. Olası değerler LastSuccessful ve SpecificDeployment değerleridir.

Name	Tür	Description
LastSuccessful	string
SpecificDeployment	string

ParametersLink

Dağıtım parametrelerine başvuruyu temsil eden varlık.

Name	Tür	Description
contentVersion	string	Varsa, şablondaki ContentVersion ile eşleşmelidir.
uri	string	Parametre dosyasının URI'sini.

PropertyChangeType

Özellik değişikliğinin türü.

Name	Tür	Description
Array	string	özelliği bir dizidir ve iç içe yerleştirilmiş değişiklikler içerir.
Create	string	özelliği geçerli durumda yok, ancak istenen durumda mevcut. Özellik, dağıtım yürütürken oluşturulur.
Delete	string	özelliği geçerli durumda var ve istenen durumda eksik. Dağıtım yürütürken silinir.
Modify	string	özelliği hem geçerli hem de istenen durumda bulunur ve farklıdır. Dağıtım yürütürken özelliğin değeri değişir.
NoEffect	string	Özellik ayarlanmaz veya güncelleştirilmez.

ScopedDeploymentWhatIf

Dağıtım Durum işlem parametreleri.

Name	Tür	Description
location	string	Dağıtım verilerini depolama konumu.
properties	DeploymentWhatIfProperties	Dağıtım özellikleri.

TemplateLink

Şablon başvuruyu temsil eden varlık.

Name	Tür	Description
contentVersion	string	Varsa, şablondaki ContentVersion ile eşleşmelidir.
id	string	Şablon Belirtiminin kaynak kimliği. Kimlik veya uri özelliğini kullanın, ancak ikisini birden kullanmayın.
queryString	string	templateLink URI'siyle kullanılacak sorgu dizesi (örneğin, sas belirteci).
relativePath	string	relativePath özelliği, bağlı şablonu üst öğeye göre bir konuma dağıtmak için kullanılabilir. Üst şablon bir TemplateSpec ile bağlantılıysa, bu şablon TemplateSpec'teki bir yapıta başvurur. Üst öğe bir URI ile bağlantılıysa, alt dağıtım üst ve relativePath URI'lerinin bir bileşimi olacaktır
uri	string	Dağıtılacak şablonun URI'si. Uri veya id özelliğini kullanın, ancak ikisini birden kullanmayın.

WhatIfChange

What-If işlemi tarafından tahmin edilen tek bir kaynak değişikliği hakkında bilgi.

Name	Tür	Description
after	object	Dağıtım yürütüldükten sonra kaynağın tahmin edilen anlık görüntüsü.
before	object	Dağıtım yürütülmeden önce kaynağın anlık görüntüsü.
changeType	ChangeType	Dağıtım yürütürken kaynakta yapılacak değişikliğin türü.
delta	WhatIfPropertyChange[]	Kaynak özelliklerinde tahmin edilen değişiklikler.
resourceId	string	Kaynak kimliği
unsupportedReason	string	Kaynağın What-If tarafından neden desteklenmediğiyle ilgili açıklama.

WhatIfOperationResult

What-If işleminin sonucu. Tahmin edilen değişikliklerin listesini ve bir sonraki sonuç kümesine ulaşmak için bir URL bağlantısı içerir.

Name	Tür	Description
error	ErrorResponse	Hata Yanıtı What-If işlemi başarısız olduğunda hata.
properties.changes	WhatIfChange[]	What-If işlemi tarafından tahmin edilen kaynak değişikliklerinin listesi.
status	string	What-If işleminin durumu.

WhatIfPropertyChange

Kaynak özelliğinde tahmin edilen değişiklik.

Name	Tür	Description
after	object	Dağıtım yürütüldükten sonra özelliğinin değeri.
before	object	Dağıtım yürütülmeden önce özelliğinin değeri.
children	WhatIfPropertyChange[]	İç içe özellik değişiklikleri.
path	string	özelliğinin yolu.
propertyChangeType	PropertyChangeType	Özellik değişikliğinin türü.

WhatIfResultFormat

What-If sonuçlarının biçimi

Name	Tür	Description
FullResourcePayloads	string
ResourceIdOnly	string

Deployments - What If At Tenant Scope

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

Predict template changes at management group scope

Sample Request

Sample Response

Tanımlar

ChangeType

CloudError

DebugSetting

DeploymentMode

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

ScopedDeploymentWhatIf

TemplateLink

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat

Ek kaynaklar