Deployments - What If At Subscription Scope

Layanan:: Resource Management

Versi API:: 2025-04-01

Mengembalikan perubahan yang akan dilakukan oleh penyebaran jika dijalankan pada cakupan langganan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._]+$	Nama pendistribusian.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	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	Operasi Azure berhasil diselesaikan.
202 Accepted		Operasi sumber daya diterima. Header Location: string Retry-After: integer
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Nama

Jenis

Deskripsi

200 OK

WhatIfOperationResult

Operasi Azure berhasil diselesaikan.

202 Accepted

Operasi sumber daya diterima.

Header

Location: string
Retry-After: integer

Other Status Codes

CloudError

Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Predict template changes at subscription scope

Permintaan sampel

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"
    }
  }
}


import com.azure.resourcemanager.resources.models.DeploymentMode;
import com.azure.resourcemanager.resources.models.DeploymentWhatIf;
import com.azure.resourcemanager.resources.models.DeploymentWhatIfProperties;
import com.azure.resourcemanager.resources.models.TemplateLink;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Deployments WhatIfAtSubscriptionScope.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/
     * PostDeploymentWhatIfOnSubscription.json
     */
    /**
     * Sample code: Predict template changes at subscription scope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void predictTemplateChangesAtSubscriptionScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().deploymentClient().getDeployments().whatIfAtSubscriptionScope(
            "my-deployment",
            new DeploymentWhatIf().withLocation("westus")
                .withProperties(new DeploymentWhatIfProperties()
                    .withTemplateLink(new TemplateLink().withUri("https://example.com/exampleTemplate.json"))
                    .withParameters(mapOf()).withMode(DeploymentMode.INCREMENTAL)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.deployments import DeploymentsMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-deployments
# USAGE
    python post_deployment_what_if_on_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DeploymentsMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000001",
    )

    response = client.deployments.begin_what_if_at_subscription_scope(
        deployment_name="my-deployment",
        parameters={
            "location": "westus",
            "properties": {
                "mode": "Incremental",
                "parameters": {},
                "templateLink": {"uri": "https://example.com/exampleTemplate.json"},
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnSubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armdeployments_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/armdeployments"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/05809299e74fc16df7badbab3fb29e25da59f7d2/specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnSubscription.json
func ExampleDeploymentsClient_BeginWhatIfAtSubscriptionScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeployments.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginWhatIfAtSubscriptionScope(ctx, "my-deployment", armdeployments.DeploymentWhatIf{
		Location: to.Ptr("westus"),
		Properties: &armdeployments.DeploymentWhatIfProperties{
			Mode:       to.Ptr(armdeployments.DeploymentModeIncremental),
			Parameters: map[string]*armdeployments.DeploymentParameter{},
			TemplateLink: &armdeployments.TemplateLink{
				URI: to.Ptr("https://example.com/exampleTemplate.json"),
			},
		},
	}, 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 = armdeployments.WhatIfOperationResult{
	// 	Properties: &armdeployments.WhatIfOperationProperties{
	// 		Changes: []*armdeployments.WhatIfChange{
	// 			{
	// 				After: map[string]any{
	// 					"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":map[string]any{
	// 						"myNewTag": "my tag value",
	// 					},
	// 				},
	// 				Before: map[string]any{
	// 					"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: to.Ptr(armdeployments.ChangeTypeModify),
	// 				Delta: []*armdeployments.WhatIfPropertyChange{
	// 					{
	// 						Path: to.Ptr("tags.myNewTag"),
	// 						After: "my tag value",
	// 						PropertyChangeType: to.Ptr(armdeployments.PropertyChangeTypeCreate),
	// 				}},
	// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity"),
	// 			},
	// 			{
	// 				After: map[string]any{
	// 					"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":map[string]any{
	// 						"myOtherNewTag": "another new tag value",
	// 					},
	// 				},
	// 				ChangeType: to.Ptr(armdeployments.ChangeTypeCreate),
	// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity"),
	// 			},
	// 			{
	// 				After: map[string]any{
	// 					"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: to.Ptr(armdeployments.ChangeTypeCreate),
	// 				ResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2"),
	// 		}},
	// 	},
	// 	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 { DeploymentsClient } = require("@azure/arm-resourcesdeployments");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Returns changes that will be made by the deployment if executed at the scope of the subscription.
 *
 * @summary Returns changes that will be made by the deployment if executed at the scope of the subscription.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/deployments/stable/2025-04-01/examples/PostDeploymentWhatIfOnSubscription.json
 */
async function predictTemplateChangesAtSubscriptionScope() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000001";
  const deploymentName = "my-deployment";
  const parameters = {
    location: "westus",
    properties: {
      mode: "Incremental",
      parameters: {},
      templateLink: { uri: "https://example.com/exampleTemplate.json" },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new DeploymentsClient(credential, subscriptionId);
  const result = await client.deployments.beginWhatIfAtSubscriptionScopeAndWait(
    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

Respon sampel

Kode status:: 200

{
  "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"
}

Kode status:: 202

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.
DeploymentDiagnosticsDefinition
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput	Input eksternal penyebaran untuk parameterisasi.
DeploymentExternalInputDefinition	Definisi input eksternal penyebaran untuk parameterisasi.
DeploymentMode	Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat bertahas atau Lengkap. Dalam mode Bertahap, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Selesai, 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.
DeploymentParameter	Parameter penyebaran untuk templat.
DeploymentWhatIf	Parameter operasi What-if penyebaran.
DeploymentWhatIfProperties	Properti What-if penyebaran.
DeploymentWhatIfSettings	Penyebaran What-If pengaturan operasi.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)
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.
ExtensionConfigPropertyType
KeyVaultParameterReference	Referensi parameter Azure Key Vault.
KeyVaultReference	Referensi Azure Key Vault.
Level	Menunjukkan tingkat respons tambahan.
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.
ValidationLevel	Tingkat validasi yang dilakukan pada penerapan.
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

Enumerasi

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

Nilai	Deskripsi
Create	Sumber daya tidak ada dalam status saat ini tetapi ada dalam status yang diinginkan. Sumber daya akan dibuat ketika penyebaran dijalankan.
Delete	Sumber daya ada dalam status saat ini dan hilang dari status yang diinginkan. Sumber daya akan dihapus saat penyebaran dijalankan.
Ignore	Sumber daya ada dalam status saat ini dan hilang dari status yang diinginkan. Sumber daya tidak akan disebarkan atau dimodifikasi saat penyebaran dijalankan.
Deploy	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.
NoChange	Sumber daya ada dalam status saat ini dan status yang diinginkan dan akan disebarkan ulang ketika penyebaran dijalankan. Properti sumber daya tidak akan berubah.
Modify	Sumber daya ada dalam status saat ini dan status yang diinginkan dan akan disebarkan ulang ketika penyebaran dijalankan. Properti sumber daya akan berubah.
Unsupported	Sumber daya tidak didukung oleh What-If.

CloudError

Objek

Respons kesalahan untuk permintaan manajemen sumber daya.

Nama	Jenis	Deskripsi
error	ErrorResponse	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

Objek

Pengaturan debug.

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

DeploymentDiagnosticsDefinition

Objek

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
level	Level	Menunjukkan tingkat respons tambahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

DeploymentExtensionConfigItem

Objek

Nama	Jenis	Deskripsi
keyVaultReference	KeyVaultParameterReference	Referensi Azure Key Vault yang digunakan untuk mengambil nilai rahasia properti konfigurasi ekstensi.
type	ExtensionConfigPropertyType	Jenis nilai properti konfigurasi ekstensi.
value		Nilai properti konfigurasi ekstensi.

DeploymentExtensionDefinition

Objek

Nama	Jenis	Deskripsi
alias	string	Alias ekstensi seperti yang didefinisikan dalam templat penyebaran.
config	<string, DeploymentExtensionConfigItem>	Konfigurasi ekstensi.
configId	string	ID konfigurasi ekstensi. Ini secara unik mengidentifikasi sarana kontrol penyebaran dalam ekstensi.
name	string	Nama ekstensi.
version	string	Versi ekstensi.

DeploymentExternalInput

Objek

Input eksternal penyebaran untuk parameterisasi.

Nama	Jenis	Deskripsi
value		Nilai input eksternal.

DeploymentExternalInputDefinition

Objek

Definisi input eksternal penyebaran untuk parameterisasi.

Nama	Jenis	Deskripsi
config		Konfigurasi untuk input eksternal.
kind	string	Jenis input eksternal.

DeploymentMode

Enumerasi

Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat bertahas atau Lengkap. Dalam mode Bertahap, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Selesai, 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.

Nilai	Deskripsi
Incremental	bertambah bertahap
Complete	Selesai

DeploymentParameter

Objek

Parameter penyebaran untuk templat.

Nama	Jenis	Deskripsi
expression	string	Masukkan ekspresi ke parameter.
reference	KeyVaultParameterReference	Referensi parameter Azure Key Vault.
value		Nilai input ke parameter .

DeploymentWhatIf

Objek

Parameter operasi What-if penyebaran.

Nama	Jenis	Deskripsi
location	string	Lokasi untuk menyimpan data penyebaran.
properties	DeploymentWhatIfProperties	Properti penyebaran.

DeploymentWhatIfProperties

Objek

Properti What-if 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.
extensionConfigs	object	Konfigurasi yang digunakan untuk ekstensi penyebaran. Kunci objek ini adalah alias ekstensi penyebaran seperti yang didefinisikan dalam templat penyebaran.
externalInputDefinitions	<string, DeploymentExternalInputDefinition>	Definisi input eksternal, digunakan oleh perkakas eksternal untuk menentukan nilai input eksternal yang diharapkan.
externalInputs	<string, DeploymentExternalInput>	Nilai input eksternal, digunakan oleh perkakas eksternal untuk evaluasi parameter.
mode	DeploymentMode	Mode yang digunakan untuk menyebarkan sumber daya. Nilai ini dapat bertahas atau Lengkap. Dalam mode Bertahap, sumber daya disebarkan tanpa menghapus sumber daya yang ada yang tidak disertakan dalam templat. Dalam mode Selesai, 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	<string, DeploymentParameter>	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		Konten templat. Anda menggunakan elemen ini ketika 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.
validationLevel	ValidationLevel	Tingkat validasi penyebaran
whatIfSettings	DeploymentWhatIfSettings	Pengaturan operasi What-If opsional.

DeploymentWhatIfSettings

Objek

Penyebaran What-If pengaturan operasi.

Nama	Jenis	Deskripsi
resultFormat	WhatIfResultFormat	Format hasil What-If

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorResponse

Objek

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

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

Objek

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

Enumerasi

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

Nilai	Deskripsi
NotSpecified	Tidak Ditentukan
Outer	Luar
Inner	Dalam

ExtensionConfigPropertyType

Enumerasi

Nilai	Deskripsi
String	Jenis properti yang mewakili nilai string.
Int	Jenis properti yang mewakili nilai bilangan bulat.
Bool	Jenis properti yang mewakili nilai boolean.
Array	Jenis properti yang mewakili nilai array.
Object	Jenis properti yang mewakili nilai objek.
SecureString	Jenis properti yang mewakili nilai string aman.
SecureObject	Jenis properti yang mewakili nilai objek aman.

KeyVaultParameterReference

Objek

Referensi parameter Azure Key Vault.

Nama	Jenis	Deskripsi
keyVault	KeyVaultReference	Referensi Azure Key Vault.
secretName	string	Nama rahasia Azure Key Vault.
secretVersion	string	Versi rahasia Azure Key Vault.

KeyVaultReference

Objek

Referensi Azure Key Vault.

Nama	Jenis	Deskripsi
id	string	ID sumber daya Azure Key Vault.

Level

Enumerasi

Menunjukkan tingkat respons tambahan.

Nilai	Deskripsi
Warning	Peringatan
Info	Informasi
Error	Kesalahan

OnErrorDeployment

Objek

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

Enumerasi

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

Nilai	Deskripsi
LastSuccessful	Terakhir Berhasil
SpecificDeployment	Penyebaran Spesifik

ParametersLink

Objek

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

Enumerasi

Jenis perubahan properti.

Nilai	Deskripsi
Create	Properti tidak ada dalam status saat ini tetapi ada dalam status yang diinginkan. Properti akan dibuat ketika penyebaran dijalankan.
Delete	Properti ada dalam status saat ini dan hilang dari status yang diinginkan. Ini akan dihapus ketika penyebaran dijalankan.
Modify	Properti ada dalam status saat ini dan yang diinginkan dan berbeda. Nilai properti akan berubah saat penyebaran dijalankan.
Array	Properti adalah array dan berisi perubahan berlapis.
NoEffect	Properti tidak akan diatur atau diperbarui.

TemplateLink

Objek

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

ValidationLevel

Enumerasi

Tingkat validasi yang dilakukan pada penerapan.

Nilai	Deskripsi
Template	Analisis statis templat dilakukan.
Provider	Analisis statis templat dilakukan dan deklarasi sumber daya dikirim ke penyedia sumber daya untuk validasi semantik. Memvalidasi bahwa pemanggil memiliki izin tulis RBAC pada setiap sumber daya.
ProviderNoRbac	Analisis statis templat dilakukan dan deklarasi sumber daya dikirim ke penyedia sumber daya untuk validasi semantik. Melewati validasi bahwa pemanggil memiliki izin tulis RBAC pada setiap sumber daya.

WhatIfChange

Objek

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

Nama	Jenis	Deskripsi
after		Rekam jepret sumber daya yang diprediksi setelah penyebaran dijalankan.
before		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.
deploymentId	string	ID sumber daya Penyebaran yang bertanggung jawab atas perubahan ini.
extension	DeploymentExtensionDefinition	Ekstensi yang digunakan sumber daya untuk disebarkan.
identifiers		Subset properti yang secara unik mengidentifikasi sumber daya Bicep yang dapat diperluas karena tidak memiliki id sumber daya seperti yang dimiliki sumber daya Azure.
resourceId	string	ID Sumber Daya
symbolicName	string	Nama simbolis sumber daya yang bertanggung jawab atas perubahan ini.
unsupportedReason	string	Penjelasan tentang mengapa sumber daya tidak didukung oleh What-If.

WhatIfOperationResult

Objek

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

Nama	Jenis	Deskripsi
error	ErrorResponse	Kesalahan saat operasi What-If gagal.
properties.changes	WhatIfChange[]	Daftar perubahan sumber daya yang diprediksi oleh operasi What-If.
properties.diagnostics	DeploymentDiagnosticsDefinition[]	Daftar diagnostik sumber daya yang terdeteksi oleh operasi What-If.
properties.potentialChanges	WhatIfChange[]	Daftar perubahan sumber daya yang diprediksi oleh operasi What-If.
status	string	Status operasi What-If.

WhatIfPropertyChange

Objek

Prediksi perubahan pada properti sumber daya.

Nama	Jenis	Deskripsi
after		Nilai properti setelah penyebaran dijalankan.
before		Nilai properti sebelum penyebaran dijalankan.
children	WhatIfPropertyChange[]	Perubahan properti berlapis.
path	string	Jalur properti.
propertyChangeType	PropertyChangeType	Jenis perubahan properti.

WhatIfResultFormat

Enumerasi

Format hasil What-If

Nilai	Deskripsi
ResourceIdOnly	ResourceIdOnly
FullResourcePayloads	Muatan Sumber Daya Penuh

Bagikan melalui

Deployments - What If At Subscription Scope

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

Predict template changes at subscription scope

Permintaan sampel

Respon sampel

Definisi

ChangeType

CloudError

DebugSetting

DeploymentDiagnosticsDefinition

DeploymentExtensionConfigItem

DeploymentExtensionDefinition

DeploymentExternalInput

DeploymentExternalInputDefinition

DeploymentMode

DeploymentParameter

DeploymentWhatIf

DeploymentWhatIfProperties

DeploymentWhatIfSettings

ErrorAdditionalInfo

ErrorResponse

ExpressionEvaluationOptions

ExpressionEvaluationOptionsScopeType

ExtensionConfigPropertyType

KeyVaultParameterReference

KeyVaultReference

Level

OnErrorDeployment

OnErrorDeploymentType

ParametersLink

PropertyChangeType

TemplateLink

ValidationLevel

WhatIfChange

WhatIfOperationResult

WhatIfPropertyChange

WhatIfResultFormat