Aracılığıyla paylaş


Deployments - What If At Subscription Scope

Abonelik 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/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf?api-version=2025-04-01

URI Parametreleri

Name İçinde Gerekli Tür Description
deploymentName
path True

string

minLength: 1
maxLength: 64
pattern: ^[-\w\._\(\)]+$

Dağıtımın adı.

subscriptionId
path True

string

minLength: 1

Hedef aboneliğin kimliği.

api-version
query True

string

minLength: 1

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

İstek Gövdesi

Name Gerekli Tür Description
properties True

DeploymentWhatIfProperties

Dağıtım özellikleri.

location

string

Dağıtım verilerini depolama konumu.

Yanıtlar

Name Tür Description
200 OK

WhatIfOperationResult

Azure işlemi başarıyla tamamlandı.

202 Accepted

Kaynak işlemi kabul edildi.

Üst Bilgiler

  • Location: string
  • Retry-After: integer
Other Status Codes

CloudError

Beklenmeyen bir hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

Predict template changes at subscription scope

Örnek isteği

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment/whatIf?api-version=2025-04-01

{
  "location": "westus",
  "properties": {
    "mode": "Incremental",
    "parameters": {},
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    }
  }
}

Örnek yanıt

{
  "properties": {
    "changes": [
      {
        "after": {
          "name": "myExistingIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
          "location": "westus2",
          "tags": {
            "myNewTag": "my tag value"
          }
        },
        "before": {
          "name": "myExistingIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity",
          "location": "westus2"
        },
        "changeType": "Modify",
        "delta": [
          {
            "path": "tags.myNewTag",
            "after": "my tag value",
            "propertyChangeType": "Create"
          }
        ],
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity"
      },
      {
        "after": {
          "name": "myNewIdentity",
          "type": "Microsoft.ManagedIdentity/userAssignedIdentities",
          "apiVersion": "2018-11-30",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity",
          "location": "eastus",
          "tags": {
            "myOtherNewTag": "another new tag value"
          }
        },
        "changeType": "Create",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity"
      },
      {
        "after": {
          "name": "my-resource-group2",
          "type": "Microsoft.Resources/resourceGroups",
          "apiVersion": "2019-03-01",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
          "location": "{location3}"
        },
        "changeType": "Create",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2"
      }
    ]
  },
  "status": "Succeeded"
}
Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Tanımlar

Name Description
ChangeType

Dağıtım yürütülü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ı.

DeploymentDiagnosticsDefinition
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput

Parametreleştirme için dağıtım dış girişi.

DeploymentExternalInputDefinition

Parametreleştirme için dağıtım harici giriş tanımı.

DeploymentMode

Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil olmayan mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve şablona dahil olmayan kaynak grubundaki mevcut kaynaklar silinir. İstenmeyen bir şekilde kaynakları silebileceği için Complete modunu kullanırken dikkatli olun.

DeploymentParameter

Şablon için dağıtım parametresi.

DeploymentWhatIf

What-if işlemi parametrelerini dağıtma.

DeploymentWhatIfProperties

Dağıtım Durum özellikleri.

DeploymentWhatIfSettings

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

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

ErrorResponse

Tüm Azure Resource Manager API'lerinin başarısız işlemler için hata detaylarını döndürmesi için yaygın hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.)

ExpressionEvaluationOptions

Şablon ifadelerinin üst şablon kapsamında mı yoksa iç içe şablon mu kapsamında değerlendirileceğini belirtir.

ExpressionEvaluationOptionsScopeType

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

ExtensionConfigPropertyType
KeyVaultParameterReference

Azure Key Vault parameter reference.

KeyVaultReference

Azure Key Vault referansı.

Level

Ek yanıt düzeyini belirtir.

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ü.

TemplateLink

Şablon başvuruyu temsil eden varlık.

ValidationLevel

Dağıtımda gerçekleştirilen doğrulama düzeyi.

WhatIfChange

What-If işlemiyle 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 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ülürken kaynakta yapılacak değişikliğin türü.

Değer Description
Create

Kaynak geçerli durumda değil, istenen durumda mevcut. Dağıtım yürütürken kaynak oluşturulur.

Delete

Kaynak geçerli durumda var ve istenen durumda yok. Dağıtım yürütürken kaynak silinir.

Ignore

Kaynak geçerli durumda var ve istenen durumda yok. Dağıtım yürütürken kaynak dağıtılmaz veya değiştirilmez.

Deploy

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.

NoChange

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.

Modify

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.

Unsupported

Kaynak What-If tarafından desteklenmiyor.

CloudError

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

Name Tür Description
error

ErrorResponse

Tüm Azure Resource Manager API'lerinin başarısız işlemler için hata detaylarını döndürmesi için yaygın 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 hem requestContent hem de responseContent virgülle ayrılmış değerlerdir. Varsayılan değer yoktur. 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 kullanıma sunma olasılığınız vardır.

DeploymentDiagnosticsDefinition

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.

code

string

Hata kodu.

level

Level

Ek yanıt düzeyini belirtir.

message

string

Hata iletisi.

target

string

Hata hedefi.

DeploymentExtensionConfigItem

Name Tür Description
keyVaultReference

KeyVaultParameterReference

Azure Key Vault referansı, uzantı yapılandırma özelliğinin gizli değerini almak için kullanılır.

type

ExtensionConfigPropertyType

Uzantı yapılandırma özelliğinin değer türü.

value

Uzantı config özelliğinin değeri.

DeploymentExtensionDefinition

Name Tür Description
alias

string

Dağıtım şablonunda tanımlandığı gibi uzantının diğer adı.

config

<string,  DeploymentExtensionConfigItem>

Uzantı yapılandırması.

configId

string

Uzantı yapılandırma kimliği. Bir uzantı içindeki dağıtım kontrol düzlemini benzersiz bir şekilde tanımlar.

name

string

Uzantı adı.

version

string

Uzantı sürümü.

DeploymentExternalInput

Parametreleştirme için dağıtım dış girişi.

Name Tür Description
value

Harici giriş değeri.

DeploymentExternalInputDefinition

Parametreleştirme için dağıtım harici giriş tanımı.

Name Tür Description
config

Harici giriş için yapılandırma.

kind

string

Harici girdi türü.

DeploymentMode

Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil olmayan mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve şablona dahil olmayan kaynak grubundaki mevcut kaynaklar silinir. İstenmeyen bir şekilde kaynakları silebileceği için Complete modunu kullanırken dikkatli olun.

Değer Description
Incremental

Artımlı

Complete

Tamamlandı

DeploymentParameter

Şablon için dağıtım parametresi.

Name Tür Description
expression

string

Parametreye ifade girin.

reference

KeyVaultParameterReference

Azure Key Vault parameter reference.

value

Parametreye değer girin.

DeploymentWhatIf

What-if işlemi parametrelerini dağıtma.

Name Tür Description
location

string

Dağıtım verilerini depolama konumu.

properties

DeploymentWhatIfProperties

Dağıtım özellikleri.

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 şablon mu kapsamında değerlendirileceğini belirtir. Yalnızca iç içe şablonlar için geçerlidir. Belirtilmezse, varsayılan değer dıştır.

extensionConfigs

object

Dağıtım uzantıları için kullanılacak yapılandırmalar. Bu nesnenin anahtarları, dağıtım şablonunda tanımlandığı gibi dağıtım uzantısı diğer adlarıdır.

externalInputDefinitions

<string,  DeploymentExternalInputDefinition>

Beklenen harici giriş değerlerini tanımlamak için harici araçlar tarafından kullanılan harici giriş tanımları.

externalInputs

<string,  DeploymentExternalInput>

Parametre değerlendirmesi için harici araçlar tarafından kullanılan harici giriş değerleri.

mode

DeploymentMode

Kaynakları dağıtmak için kullanılan mod. Bu değer Artımlı veya Tamamlandı olabilir. Artımlı modda, kaynaklar şablona dahil olmayan mevcut kaynaklar silinmeden dağıtılır. Tamamlandı modunda kaynaklar dağıtılır ve şablona dahil olmayan kaynak grubundaki mevcut kaynaklar silinir. İstenmeyen bir şekilde kaynakları silebileceği için Complete modunu kullanırken dikkatli olun.

onErrorDeployment

OnErrorDeployment

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

parameters

<string,  DeploymentParameter>

Şablon için dağıtım parametrelerini tanımlayan ad ve değer çiftleri. Parametre değerlerini mevcut 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. 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

Şablon içeriği. Şablon söz dizimini var olan 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 şablon özelliğini kullanın, ancak ikisini birden kullanmayın.

templateLink

TemplateLink

Şablonun URI'sini. templateLink özelliğini veya şablon özelliğini kullanın, ancak ikisini birden kullanmayın.

validationLevel

ValidationLevel

Dağıtımın doğrulama düzeyi

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

Tüm Azure Resource Manager API'lerinin başarısız işlemler için hata detaylarını döndürmesi için yaygın hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.)

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 şablon mu kapsamında değerlendirileceğ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.

Değer Description
NotSpecified

Belirtilmemiş

Outer

Dış

Inner

ExtensionConfigPropertyType

Değer Description
String

Bir dize değerini temsil eden özellik türü.

Int

Bir tamsayı değerini temsil eden özellik türü.

Bool

Bir boole değerini temsil eden özellik türü.

Array

Bir dizi değerini temsil eden özellik türü.

Object

Bir nesne değerini temsil eden özellik türü.

SecureString

Güvenli bir dize değerini temsil eden özellik türü.

SecureObject

Güvenli bir nesne değerini temsil eden özellik türü.

KeyVaultParameterReference

Azure Key Vault parameter reference.

Name Tür Description
keyVault

KeyVaultReference

Azure Key Vault referansı.

secretName

string

Azure Key Vault secret name.

secretVersion

string

Azure Key Vault gizli versiyonu.

KeyVaultReference

Azure Key Vault referansı.

Name Tür Description
id

string

Azure Key Vault resource id.

Level

Ek yanıt düzeyini belirtir.

Değer Description
Warning

Uyarı

Info

Bilgi

Error

Error

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.

Değer Description
LastSuccessful

LastSuccessful

SpecificDeployment

SpecificDeployment

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ü.

Değer Description
Create

özelliği geçerli durumda yok, ancak istenen durumda mevcut. Özelliği, dağıtım yürütürken oluşturulur.

Delete

Özelliği geçerli durumda var ve istenen durumda eksik. Dağıtım yürütürken silinir.

Modify

ö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.

Array

özelliği bir dizidir ve iç içe yerleştirilmiş değişiklikler içerir.

NoEffect

Özelliği ayarlanmaz veya güncelleştirilmez.

Ş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 şablona göre bir konuma dağıtmak için kullanılabilir. Üst şablon bir TemplateSpec ile bağlantılıysa bu, TemplateSpec içindeki 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'sini. Uri veya id özelliğini kullanın, ancak ikisini birden kullanmayın.

ValidationLevel

Dağıtımda gerçekleştirilen doğrulama düzeyi.

Değer Description
Template

Şablonun statik analizi yapılır.

Provider

Şablonun statik analizi gerçekleştirilir ve anlamsal doğrulama için kaynak sağlayıcılarına kaynak bildirimleri gönderilir. Çağıranın her kaynakta RBAC yazma izinlerine sahip olduğunu doğrular.

ProviderNoRbac

Şablonun statik analizi gerçekleştirilir ve anlamsal doğrulama için kaynak sağlayıcılarına kaynak bildirimleri gönderilir. Çağıranın her kaynakta RBAC yazma izinlerine sahip olduğunu doğrulamayı atlar.

WhatIfChange

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

Name Tür Description
after

Dağıtım yürütüldükten sonra kaynağın tahmin edilen anlık görüntüsü.

before

Dağıtım yürütülmeden önce kaynağın anlık görüntüsü.

changeType

ChangeType

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

delta

WhatIfPropertyChange[]

Kaynak özelliklerinde tahmin edilen değişiklikler.

deploymentId

string

Bu değişiklikten sorumlu olan Dağıtımın kaynak kimliği.

extension

DeploymentExtensionDefinition

Kaynağın dağıtıldığı uzantı.

identifiers

Bicep genişletilebilir kaynağını benzersiz şekilde tanımlayan bir özellik alt kümesi, Azure kaynağı gibi bir kaynak kimliği yok.

resourceId

string

Kaynak Kimliği

symbolicName

string

Bu değişiklikten sorumlu kaynağın simgesel adı.

unsupportedReason

string

Kaynağın neden What-If tarafından desteklenmediğiyle ilgili açıklama.

WhatIfOperationResult

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

Name Tür Description
error

ErrorResponse

What-If işlemi başarısız olduğunda hata oluştu.

properties.changes

WhatIfChange[]

What-If işlemi tarafından tahmin edilen kaynak değişikliklerinin listesi.

properties.diagnostics

DeploymentDiagnosticsDefinition[]

What-If işlemi tarafından algılanan kaynak tanılamalarının listesi.

properties.potentialChanges

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

Dağıtım yürütüldükten sonra özelliğinin değeri.

before

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

Değer Description
ResourceIdOnly

ResourceIdOnly

FullResourcePayloads

FullResourcePayloads