Deployments - What If

Mengembalikan perubahan yang akan dilakukan oleh penyebaran jika dijalankan pada cakupan grup sumber daya.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
deploymentName
path True

string

Nama penyebaran.

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

resourceGroupName
path True

string

Nama grup sumber daya tempat templat akan disebarkan. Nama tidak peka huruf besar/kecil.

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

subscriptionId
path True

string

ID langganan Microsoft Azure.

api-version
query True

string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
properties True

DeploymentWhatIfProperties

Properti penyebaran.

location

string

Lokasi untuk menyimpan data penyebaran.

Respons

Nama Jenis Deskripsi
200 OK

WhatIfOperationResult

OK - Mengembalikan status operasi What-If

202 Accepted

Diterima - Mengembalikan URL di header Lokasi ke kueri untuk status operasi yang berjalan lama.

Headers

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

CloudError

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

Predict template changes at resource group scope

Sample Request

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

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

Sample Response

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

Definisi

Nama Deskripsi
ChangeType

Jenis perubahan yang akan dilakukan pada sumber daya saat penyebaran dijalankan.

CloudError

Respons kesalahan untuk permintaan manajemen sumber daya.

DebugSetting

Pengaturan debug.

DeploymentMode

Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat berupa Inkremental atau Complete. Dalam mode Inkremental, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Lengkap, sumber daya disebarkan dan sumber daya yang ada dalam grup sumber daya yang tidak disertakan dalam templat dihapus. Berhati-hatilah saat menggunakan mode Lengkap karena Anda mungkin secara tidak sengaja menghapus sumber daya.

DeploymentWhatIf

Parameter operasi Bagaimana-jika Penyebaran.

DeploymentWhatIfProperties

Properti Bagaimana-jika Penyebaran.

DeploymentWhatIfSettings

Penyebaran What-If pengaturan operasi.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorResponse

Respons Kesalahan

ExpressionEvaluationOptions

Menentukan apakah ekspresi templat dievaluasi dalam cakupan templat induk atau templat berlapis.

ExpressionEvaluationOptionsScopeType

Cakupan yang akan digunakan untuk evaluasi parameter, variabel, dan fungsi dalam templat berlapis.

OnErrorDeployment

Penyebaran pada perilaku kesalahan.

OnErrorDeploymentType

Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment.

ParametersLink

Entitas yang mewakili referensi ke parameter penyebaran.

PropertyChangeType

Jenis perubahan properti.

TemplateLink

Entitas yang mewakili referensi ke templat.

WhatIfChange

Informasi tentang perubahan sumber daya tunggal yang diprediksi oleh operasi What-If.

WhatIfOperationResult

Hasil operasi What-If. Berisi daftar perubahan yang diprediksi dan tautan URL untuk masuk ke kumpulan hasil berikutnya.

WhatIfPropertyChange

Prediksi perubahan pada properti sumber daya.

WhatIfResultFormat

Format hasil What-If

ChangeType

Jenis perubahan yang akan dilakukan pada sumber daya saat penyebaran dijalankan.

Nama Jenis Deskripsi
Create

string

Sumber daya tidak ada dalam status saat ini tetapi ada dalam status yang diinginkan. Sumber daya akan dibuat saat penyebaran dijalankan.

Delete

string

Sumber daya ada dalam status saat ini dan hilang dari status yang diinginkan. Sumber daya akan dihapus saat penyebaran dijalankan.

Deploy

string

Sumber daya ada dalam status saat ini dan status yang diinginkan dan akan disebarkan ulang ketika penyebaran dijalankan. Properti sumber daya mungkin berubah mungkin juga tidak berubah.

Ignore

string

Sumber daya ada dalam status saat ini dan hilang dari status yang diinginkan. Sumber daya tidak akan disebarkan atau dimodifikasi saat penyebaran dijalankan.

Modify

string

Sumber daya ada dalam status saat ini dan status yang diinginkan dan akan disebarkan ulang ketika penyebaran dijalankan. Properti sumber daya akan berubah.

NoChange

string

Sumber daya ada dalam status saat ini dan status yang diinginkan dan akan disebarkan ulang ketika penyebaran dijalankan. Properti sumber daya tidak akan berubah.

Unsupported

string

Sumber daya tidak didukung oleh What-If.

CloudError

Respons kesalahan untuk permintaan manajemen sumber daya.

Nama Jenis Deskripsi
error

ErrorResponse

Respons Kesalahan
Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)

DebugSetting

Pengaturan debug.

Nama Jenis Deskripsi
detailLevel

string

Menentukan jenis informasi yang akan dicatat untuk penelusuran kesalahan. Nilai yang diizinkan tidak ada, requestContent, responseContent, atau requestContent dan responseContent yang dipisahkan oleh koma. Defaultnya tidak ada. Saat mengatur nilai ini, pertimbangkan dengan cermat jenis informasi yang Anda berikan selama penyebaran. Dengan mencatat informasi tentang permintaan atau respons, Anda berpotensi mengekspos data sensitif yang diambil melalui operasi penyebaran.

DeploymentMode

Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat berupa Inkremental atau Complete. Dalam mode Inkremental, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Lengkap, sumber daya disebarkan dan sumber daya yang ada dalam grup sumber daya yang tidak disertakan dalam templat dihapus. Berhati-hatilah saat menggunakan mode Lengkap karena Anda mungkin secara tidak sengaja menghapus sumber daya.

Nama Jenis Deskripsi
Complete

string

Incremental

string

DeploymentWhatIf

Parameter operasi Bagaimana-jika Penyebaran.

Nama Jenis Deskripsi
location

string

Lokasi untuk menyimpan data penyebaran.

properties

DeploymentWhatIfProperties

Properti penyebaran.

DeploymentWhatIfProperties

Properti Bagaimana-jika Penyebaran.

Nama Jenis Deskripsi
debugSetting

DebugSetting

Pengaturan debug penyebaran.

expressionEvaluationOptions

ExpressionEvaluationOptions

Menentukan apakah ekspresi templat dievaluasi dalam cakupan templat induk atau templat berlapis. Hanya berlaku untuk templat berlapis. Jika tidak ditentukan, nilai defaultnya adalah luar.

mode

DeploymentMode

Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat berupa Inkremental atau Complete. Dalam mode Inkremental, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Lengkap, sumber daya disebarkan dan sumber daya yang ada dalam grup sumber daya yang tidak disertakan dalam templat dihapus. Berhati-hatilah saat menggunakan mode Lengkap karena Anda mungkin secara tidak sengaja menghapus sumber daya.

onErrorDeployment

OnErrorDeployment

Penyebaran pada perilaku kesalahan.

parameters

object

Pasangan nama dan nilai yang menentukan parameter penyebaran untuk templat. Anda menggunakan elemen ini ketika Anda ingin memberikan nilai parameter langsung dalam permintaan daripada menautkan ke file parameter yang ada. Gunakan properti parametersLink atau properti parameter, tetapi tidak keduanya. Ini bisa menjadi JObject atau string JSON yang terbentuk dengan baik.

parametersLink

ParametersLink

URI file parameter. Anda menggunakan elemen ini untuk menautkan ke file parameter yang ada. Gunakan properti parametersLink atau properti parameter, tetapi tidak keduanya.

template

object

Konten templat. Anda menggunakan elemen ini saat Anda ingin meneruskan sintaks templat langsung dalam permintaan daripada menautkan ke templat yang ada. Ini bisa menjadi string JObject atau JSON yang terbentuk dengan baik. Gunakan properti templateLink atau properti templat, tetapi tidak keduanya.

templateLink

TemplateLink

URI templat. Gunakan properti templateLink atau properti templat, tetapi tidak keduanya.

whatIfSettings

DeploymentWhatIfSettings

Pengaturan operasi What-If opsional.

DeploymentWhatIfSettings

Penyebaran What-If pengaturan operasi.

Nama Jenis Deskripsi
resultFormat

WhatIfResultFormat

Format hasil What-If

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.

type

string

Jenis info tambahan.

ErrorResponse

Respons Kesalahan

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.

code

string

Kode kesalahan.

details

ErrorResponse[]

Detail kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan.

ExpressionEvaluationOptions

Menentukan apakah ekspresi templat dievaluasi dalam cakupan templat induk atau templat berlapis.

Nama Jenis Deskripsi
scope

ExpressionEvaluationOptionsScopeType

Cakupan yang akan digunakan untuk evaluasi parameter, variabel, dan fungsi dalam templat berlapis.

ExpressionEvaluationOptionsScopeType

Cakupan yang akan digunakan untuk evaluasi parameter, variabel, dan fungsi dalam templat berlapis.

Nama Jenis Deskripsi
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Penyebaran pada perilaku kesalahan.

Nama Jenis Deskripsi
deploymentName

string

Penyebaran yang akan digunakan pada kasus kesalahan.

type

OnErrorDeploymentType

Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment.

OnErrorDeploymentType

Penyebaran pada jenis perilaku kesalahan. Nilai yang mungkin adalah LastSuccessful dan SpecificDeployment.

Nama Jenis Deskripsi
LastSuccessful

string

SpecificDeployment

string

Entitas yang mewakili referensi ke parameter penyebaran.

Nama Jenis Deskripsi
contentVersion

string

Jika disertakan, harus cocok dengan ContentVersion dalam templat.

uri

string

URI file parameter.

PropertyChangeType

Jenis perubahan properti.

Nama Jenis Deskripsi
Array

string

Properti adalah array dan berisi perubahan berlapis.

Create

string

Properti tidak ada dalam status saat ini tetapi ada dalam status yang diinginkan. Properti akan dibuat saat penyebaran dijalankan.

Delete

string

Properti ada dalam status saat ini dan hilang dari status yang diinginkan. Ini akan dihapus ketika penyebaran dijalankan.

Modify

string

Properti ada dalam status saat ini dan yang diinginkan dan berbeda. Nilai properti akan berubah saat penyebaran dijalankan.

NoEffect

string

Properti tidak akan diatur atau diperbarui.

Entitas yang mewakili referensi ke templat.

Nama Jenis Deskripsi
contentVersion

string

Jika disertakan, harus cocok dengan ContentVersion dalam templat.

id

string

Id sumber daya dari Spesifikasi Templat. Gunakan properti id atau uri, tetapi tidak keduanya.

queryString

string

String kueri (misalnya, token SAS) yang akan digunakan dengan templateLink URI.

relativePath

string

Properti relativePath dapat digunakan untuk menyebarkan templat yang ditautkan di lokasi yang relatif terhadap induk. Jika templat induk ditautkan dengan TemplateSpec, ini akan mereferensikan artefak di TemplateSpec. Jika induk ditautkan dengan URI, penyebaran anak akan menjadi kombinasi dari URI induk dan relativePath

uri

string

URI templat yang akan disebarkan. Gunakan properti uri atau id, tetapi tidak keduanya.

WhatIfChange

Informasi tentang perubahan sumber daya tunggal yang diprediksi oleh operasi What-If.

Nama Jenis Deskripsi
after

object

Rekam jepret sumber daya yang diprediksi setelah penyebaran dijalankan.

before

object

Rekam jepret sumber daya sebelum penyebaran dijalankan.

changeType

ChangeType

Jenis perubahan yang akan dilakukan pada sumber daya saat penyebaran dijalankan.

delta

WhatIfPropertyChange[]

Prediksi perubahan pada properti sumber daya.

resourceId

string

ID sumber daya

unsupportedReason

string

Penjelasan tentang mengapa sumber daya tidak didukung oleh What-If.

WhatIfOperationResult

Hasil operasi What-If. Berisi daftar perubahan yang diprediksi dan tautan URL untuk masuk ke kumpulan hasil berikutnya.

Nama Jenis Deskripsi
error

ErrorResponse

Respons Kesalahan
Kesalahan saat operasi What-If gagal.

properties.changes

WhatIfChange[]

Daftar perubahan sumber daya yang diprediksi oleh operasi What-If.

status

string

Status operasi What-If.

WhatIfPropertyChange

Prediksi perubahan pada properti sumber daya.

Nama Jenis Deskripsi
after

object

Nilai properti setelah penyebaran dijalankan.

before

object

Nilai properti sebelum penyebaran dijalankan.

children

WhatIfPropertyChange[]

Perubahan properti berlapis.

path

string

Jalur properti .

propertyChangeType

PropertyChangeType

Jenis perubahan properti.

WhatIfResultFormat

Format hasil What-If

Nama Jenis Deskripsi
FullResourcePayloads

string

ResourceIdOnly

string