Deployments - What If At Subscription Scope

Služba:: Resource Management

Verze rozhraní API:: 2025-04-01

Vrátí změny, které provede nasazení v rozsahu předplatného.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._]+$	Název nasazení.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties	True	DeploymentWhatIfProperties	Vlastnosti nasazení.
location		string	Umístění pro uložení dat nasazení.

Odpovědi

Name	Typ	Description
200 OK	WhatIfOperationResult	Operace Azure byla úspěšně dokončena.
202 Accepted		Operace prostředku byla přijata. Hlavičky Location: string Retry-After: integer
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Name

Typ

Description

200 OK

WhatIfOperationResult

Operace Azure byla úspěšně dokončena.

202 Accepted

Operace prostředku byla přijata.

Hlavičky

Location: string
Retry-After: integer

Other Status Codes

CloudError

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Predict template changes at subscription scope

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
}

Stavový kód:: 202

Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Definice

Name	Description
ChangeType	Typ změny, která se provede u prostředku při spuštění nasazení
CloudError	Odpověď na chybu žádosti o správu prostředků.
DebugSetting	Nastavení ladění.
DeploymentDiagnosticsDefinition
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput	Nasazení externího vstupu pro parametrizaci.
DeploymentExternalInputDefinition	Definice externího vstupu nasazení pro parametrizaci.
DeploymentMode	Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.
DeploymentParameter	Parametr nasazení pro šablonu.
DeploymentWhatIf	Parametry operace Citlivostní analýza nasazení
DeploymentWhatIfProperties	Vlastnosti citlivostní citlivosti nasazení
DeploymentWhatIfSettings	Nastavení operace What-If nasazení
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorResponse	Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích. (To se také řídí formátem odpovědi na chybu OData.)
ExpressionEvaluationOptions	Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony.
ExpressionEvaluationOptionsScopeType	Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí v vnořené šabloně.
ExtensionConfigPropertyType
KeyVaultParameterReference	Azure Key Vault parameter reference.
KeyVaultReference	Azure Key Vault reference.
Level	Označuje dodatečnou úroveň odezvy.
OnErrorDeployment	Nasazení při chování chyby
OnErrorDeploymentType	Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.
ParametersLink	Entita představující odkaz na parametry nasazení
PropertyChangeType	Typ vlastnosti se změní.
TemplateLink	Entita představující odkaz na šablonu.
ValidationLevel	Úroveň ověření provedeného při nasazení.
WhatIfChange	Informace o jedné změně prostředku předpovězené operací What-If
WhatIfOperationResult	Výsledek operace What-If Obsahuje seznam předpovídané změny a odkaz na adresu URL, který se dostane k další sadě výsledků.
WhatIfPropertyChange	Predikovaná změna vlastnosti prostředku.
WhatIfResultFormat	Formát výsledků What-If

ChangeType

Výčet

Typ změny, která se provede u prostředku při spuštění nasazení

Hodnota	Description
Create	Prostředek v aktuálním stavu neexistuje, ale nachází se v požadovaném stavu. Prostředek se vytvoří při spuštění nasazení.
Delete	Prostředek existuje v aktuálním stavu a v požadovaném stavu chybí. Prostředek se odstraní při spuštění nasazení.
Ignore	Prostředek existuje v aktuálním stavu a v požadovaném stavu chybí. Prostředek se při spuštění nasazení nenasadí ani nezmění.
Deploy	Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se mohou nebo nemusí změnit.
NoChange	Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se nezmění.
Modify	Prostředek existuje v aktuálním a požadovaném stavu a po spuštění nasazení se znovu nasadí. Vlastnosti prostředku se změní.
Unsupported	Prostředek není podporován nástrojem What-If.

CloudError

Objekt

Odpověď na chybu žádosti o správu prostředků.

Name	Typ	Description
error	ErrorResponse	Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích. (To se také řídí formátem odpovědi na chybu OData.)

DebugSetting

Objekt

Nastavení ladění.

Name	Typ	Description
detailLevel	string	Určuje typ informací, které se mají protokolovat pro ladění. Povolené hodnoty nejsou žádné, requestContent, responseContent nebo requestContent i responseContent oddělené čárkou. Výchozí hodnota není žádná. Při nastavování této hodnoty pečlivě zvažte typ informací, které předáváte během nasazování. Protokolováním informací o požadavku nebo odpovědi můžete potenciálně vystavit citlivá data načtená prostřednictvím operací nasazení.

DeploymentDiagnosticsDefinition

Objekt

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
level	Level	Označuje dodatečnou úroveň odezvy.
message	string	Chybová zpráva.
target	string	Cíl chyby.

DeploymentExtensionConfigItem

Objekt

Name	Typ	Description
keyVaultReference	KeyVaultParameterReference	Reference Azure Key Vault použitá k získání tajné hodnoty vlastnosti extension config.
type	ExtensionConfigPropertyType	Typ hodnoty vlastnosti konfigurace rozšíření.
value		Hodnota vlastnosti extension config.

DeploymentExtensionDefinition

Objekt

Name	Typ	Description
alias	string	Alias rozšíření, jak je definován v šabloně nasazení.
config	<string, DeploymentExtensionConfigItem>	Konfigurace rozšíření.
configId	string	ID konfigurace rozšíření. Jednoznačně identifikuje řídicí rovinu nasazení v rámci rozšíření.
name	string	Název přípony.
version	string	Verze rozšíření.

DeploymentExternalInput

Objekt

Nasazení externího vstupu pro parametrizaci.

Name	Typ	Description
value		Externí vstupní hodnota.

DeploymentExternalInputDefinition

Objekt

Definice externího vstupu nasazení pro parametrizaci.

Name	Typ	Description
config		Konfigurace pro externí vstup.
kind	string	Druh externího vstupu.

DeploymentMode

Výčet

Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.

Hodnota	Description
Incremental	Přírůstkový
Complete	Dokončeno

DeploymentParameter

Objekt

Parametr nasazení pro šablonu.

Name	Typ	Description
expression	string	Vstupní výraz do parametru.
reference	KeyVaultParameterReference	Azure Key Vault parameter reference.
value		Vstupní hodnota parametru .

DeploymentWhatIf

Objekt

Parametry operace Citlivostní analýza nasazení

Name	Typ	Description
location	string	Umístění pro uložení dat nasazení.
properties	DeploymentWhatIfProperties	Vlastnosti nasazení.

DeploymentWhatIfProperties

Objekt

Vlastnosti citlivostní citlivosti nasazení

Name	Typ	Description
debugSetting	DebugSetting	Nastavení ladění nasazení.
expressionEvaluationOptions	ExpressionEvaluationOptions	Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony. Platí pouze pro vnořené šablony. Pokud není zadána, výchozí hodnota je vnější.
extensionConfigs	object	Konfigurace, které se mají použít pro rozšíření nasazení. Klíče tohoto objektu jsou aliasy rozšíření nasazení definované v šabloně nasazení.
externalInputDefinitions	<string, DeploymentExternalInputDefinition>	Definice externích vstupů, které používají externí nástroje k definování očekávaných externích vstupních hodnot.
externalInputs	<string, DeploymentExternalInput>	Externí vstupní hodnoty, používané externími nástroji pro vyhodnocení parametrů.
mode	DeploymentMode	Režim, který se používá k nasazení prostředků. Tato hodnota může být přírůstková nebo úplná. V přírůstkovém režimu se prostředky nasazují bez odstranění existujících prostředků, které nejsou součástí šablony. V režimu Dokončení se prostředky nasadí a existující prostředky ve skupině prostředků, které nejsou součástí šablony, se odstraní. Při použití režimu Dokončení buďte opatrní, protože nechtěně odstraňte prostředky.
onErrorDeployment	OnErrorDeployment	Nasazení při chování chyby.
parameters	<string, DeploymentParameter>	Dvojice názvů a hodnot, které definují parametry nasazení pro šablonu. Tento prvek použijete, pokud chcete zadat hodnoty parametrů přímo v požadavku místo propojení s existujícím souborem parametrů. Použijte buď vlastnost parametersLink, nebo vlastnost parametrů, ale ne obojí. Může to být JObject nebo dobře formátovaný řetězec JSON.
parametersLink	ParametersLink	Identifikátor URI souboru parametrů. Tento prvek slouží k propojení s existujícím souborem parametrů. Použijte buď vlastnost parametersLink, nebo vlastnost parametrů, ale ne obojí.
template		Obsah šablony. Tento prvek použijete, pokud chcete předat syntaxi šablony přímo v požadavku místo propojení s existující šablonou. Může to být řetězec JSON ve správném formátu nebo JObject. Použijte buď vlastnost templateLink, nebo vlastnost šablony, ale ne obojí.
templateLink	TemplateLink	Identifikátor URI šablony. Použijte buď vlastnost templateLink, nebo vlastnost šablony, ale ne obojí.
validationLevel	ValidationLevel	Úroveň ověření nasazení
whatIfSettings	DeploymentWhatIfSettings	Volitelné nastavení operace What-If.

DeploymentWhatIfSettings

Objekt

Nastavení operace What-If nasazení

Name	Typ	Description
resultFormat	WhatIfResultFormat	Formát výsledků What-If

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích. (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorResponse[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ExpressionEvaluationOptions

Objekt

Určuje, jestli se výrazy šablony vyhodnocují v rámci oboru nadřazené šablony nebo vnořené šablony.

Name	Typ	Description
scope	ExpressionEvaluationOptionsScopeType	Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí v vnořené šabloně.

ExpressionEvaluationOptionsScopeType

Výčet

Obor, který se má použít pro vyhodnocení parametrů, proměnných a funkcí v vnořené šabloně.

Hodnota	Description
NotSpecified	Nespecifikováno
Outer	Vnější
Inner	Vnitřní

ExtensionConfigPropertyType

Výčet

Hodnota	Description
String	Typ vlastnosti představující řetězcovou hodnotu.
Int	Typ vlastnosti představující celočíselnou hodnotu.
Bool	Typ vlastnosti představující booleovskou hodnotu.
Array	Typ vlastnosti představující hodnotu pole.
Object	Typ vlastnosti představující hodnotu objektu.
SecureString	Typ vlastnosti představující hodnotu zabezpečeného řetězce.
SecureObject	Typ vlastnosti představující hodnotu zabezpečeného objektu.

KeyVaultParameterReference

Objekt

Azure Key Vault parameter reference.

Name	Typ	Description
keyVault	KeyVaultReference	Azure Key Vault reference.
secretName	string	Azure Key Vault secret name.
secretVersion	string	Azure Key Vault secret version.

KeyVaultReference

Objekt

Azure Key Vault reference.

Name	Typ	Description
id	string	Azure Key Vault resource id.

Level

Výčet

Označuje dodatečnou úroveň odezvy.

Hodnota	Description
Warning	Výstraha
Info	Informace
Error	Error

OnErrorDeployment

Objekt

Nasazení při chování chyby

Name	Typ	Description
deploymentName	string	Nasazení, které se má použít v případě chyby.
type	OnErrorDeploymentType	Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

OnErrorDeploymentType

Výčet

Nasazení typu chování chyby. Možné hodnoty jsou LastSuccessful a SpecificDeployment.

Hodnota	Description
LastSuccessful	LastSuccessful
SpecificDeployment	Specifické nasazení

ParametersLink

Objekt

Entita představující odkaz na parametry nasazení

Name	Typ	Description
contentVersion	string	V případě zahrnutí se musí shodovat s ContentVersion v šabloně.
uri	string	Identifikátor URI souboru parametrů.

PropertyChangeType

Výčet

Typ vlastnosti se změní.

Hodnota	Description
Create	Vlastnost neexistuje v aktuálním stavu, ale je přítomna v požadovaném stavu. Vlastnost se vytvoří při spuštění nasazení.
Delete	Vlastnost existuje v aktuálním stavu a v požadovaném stavu chybí. Po spuštění nasazení se odstraní.
Modify	Vlastnost existuje v aktuálním i požadovaném stavu a je odlišná. Hodnota vlastnosti se změní při spuštění nasazení.
Array	Vlastnost je pole a obsahuje vnořené změny.
NoEffect	Vlastnost nebude nastavena ani aktualizována.

TemplateLink

Objekt

Entita představující odkaz na šablonu.

Name	Typ	Description
contentVersion	string	V případě zahrnutí se musí shodovat s ContentVersion v šabloně.
id	string	ID prostředku specifikace šablony. Použijte buď id, nebo vlastnost URI, ale ne obojí.
queryString	string	Řetězec dotazu (například token SAS), který se má použít s identifikátorem URI templateLink.
relativePath	string	Vlastnost relativePath lze použít k nasazení propojené šablony v umístění vzhledem k nadřazené. Pokud byla nadřazená šablona propojena se šablonou TemplateSpec, bude odkazovat na artefakt v templateSpec. Pokud byl nadřazený objekt propojený s identifikátorem URI, bude podřízené nasazení kombinací nadřazených a relativních identifikátorů URI cesty.
uri	string	Identifikátor URI šablony, který se má nasadit. Použijte vlastnost identifikátoru URI nebo ID, ale ne obě.

ValidationLevel

Výčet

Úroveň ověření provedeného při nasazení.

Hodnota	Description
Template	Provede se statická analýza šablony.
Provider	Provede se statická analýza šablony a deklarace prostředků se odešlou poskytovatelům prostředků k sémantickému ověření. Ověří, zda má volající oprávnění k zápisu RBAC pro každý prostředek.
ProviderNoRbac	Provede se statická analýza šablony a deklarace prostředků se odešlou poskytovatelům prostředků k sémantickému ověření. Přeskočí ověření, zda má volající oprávnění k zápisu RBAC pro každý prostředek.

WhatIfChange

Objekt

Informace o jedné změně prostředku předpovězené operací What-If

Name	Typ	Description
after		Předpovězený snímek prostředku po spuštění nasazení
before		Snímek prostředku před spuštěním nasazení
changeType	ChangeType	Typ změny, která se provede u prostředku při spuštění nasazení
delta	WhatIfPropertyChange[]	Předpovězené změny vlastností prostředku.
deploymentId	string	ID prostředku nasazení zodpovědného za tuto změnu.
extension	DeploymentExtensionDefinition	Rozšíření, se kterým byl prostředek nasazen.
identifiers		Podmnožina vlastností, které jednoznačně identifikují rozšiřitelný zdroj Bicep, protože mu chybí ID zdroje jako Azure zdroj.
resourceId	string	ID zdroje
symbolicName	string	Symbolický název zdroje zodpovědného za tuto změnu.
unsupportedReason	string	Vysvětlení, proč prostředek není podporován službou What-If.

WhatIfOperationResult

Objekt

Výsledek operace What-If Obsahuje seznam předpovídané změny a odkaz na adresu URL, který se dostane k další sadě výsledků.

Name	Typ	Description
error	ErrorResponse	Chyba při selhání operace What-If
properties.changes	WhatIfChange[]	Seznam změn prostředků predikovaných operací What-If
properties.diagnostics	DeploymentDiagnosticsDefinition[]	Seznam diagnostiky zdrojů zjištěných What-If operací.
properties.potentialChanges	WhatIfChange[]	Seznam změn prostředků predikovaných operací What-If
status	string	Stav operace What-If

WhatIfPropertyChange

Objekt

Predikovaná změna vlastnosti prostředku.

Name	Typ	Description
after		Hodnota vlastnosti po spuštění nasazení.
before		Hodnota vlastnosti před spuštěním nasazení.
children	WhatIfPropertyChange[]	Vnořená vlastnost se změní.
path	string	Cesta vlastnosti.
propertyChangeType	PropertyChangeType	Typ vlastnosti se změní.

WhatIfResultFormat

Výčet

Formát výsledků What-If

Hodnota	Description
ResourceIdOnly	ResourceIdOnly
FullResourcePayloads	FullResourcePayloads

Sdílet prostřednictvím

Deployments - What If At Subscription Scope

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Predict template changes at subscription scope

Ukázkový požadavek

Ukázková odpověď

Definice

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