Deployments - What If At Subscription Scope

Gibt Änderungen zurück, die von der Bereitstellung vorgenommen werden, wenn sie im Bereich des Abonnements ausgeführt werden.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
deploymentName
path True

string

Der Name der Bereitstellung

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

subscriptionId
path True

string

Die Microsoft Azure-Abonnement-ID.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties True

DeploymentWhatIfProperties

Die Bereitstellungseigenschaften.

location

string

Der Speicherort für die Bereitstellungsdaten.

Antworten

Name Typ Beschreibung
200 OK

WhatIfOperationResult

OK: Gibt What-If Vorgang status zurück.

202 Accepted

Akzeptiert: Gibt die URL im Location-Header zurück, um status lang andauernde Vorgänge abzufragen.

Headers

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

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Predict template changes at subscription scope

Sample Request

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

{
  "location": "westus",
  "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"
          }
        }
      },
      {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
        "changeType": "Create",
        "after": {
          "apiVersion": "2019-03-01",
          "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2",
          "type": "Microsoft.Resources/resourceGroups",
          "name": "my-resource-group2",
          "location": "{location3}"
        }
      }
    ]
  }
}
Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Definitionen

Name Beschreibung
ChangeType

Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird.

CloudError

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

DebugSetting

Die Debugeinstellung.

DeploymentMode

Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie ressourcen unbeabsichtigt löschen können.

DeploymentWhatIf

Was-wäre-wenn-Vorgangsparameter für die Bereitstellung.

DeploymentWhatIfProperties

Was-wäre-wenn-Eigenschaften der Bereitstellung.

DeploymentWhatIfSettings

Bereitstellung What-If Vorgangseinstellungen.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorResponse

Fehlerantwort

ExpressionEvaluationOptions

Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten Vorlage oder der geschachtelten Vorlage ausgewertet werden.

ExpressionEvaluationOptionsScopeType

Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.

OnErrorDeployment

Bereitstellung bei Fehlerverhalten.

OnErrorDeploymentType

Der Bereitstellungstyp für fehlerverhalten. Mögliche Werte sind LastSuccessful und SpecificDeployment.

ParametersLink

Entität, die den Verweis auf die Bereitstellungsparameter darstellt.

PropertyChangeType

Der Typ der Eigenschaft ändert sich.

TemplateLink

Entität, die den Verweis auf die Vorlage darstellt.

WhatIfChange

Informationen zu einer einzelnen Ressourcenänderung, die von What-If Vorgang vorhergesagt wird.

WhatIfOperationResult

Ergebnis des What-If Vorgangs. Enthält eine Liste der vorhergesagten Änderungen und einen URL-Link, um zum nächsten Satz von Ergebnissen zu gelangen.

WhatIfPropertyChange

Die vorhergesagte Änderung an der Ressourceneigenschaft.

WhatIfResultFormat

Das Format der What-If Ergebnisse

ChangeType

Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird.

Name Typ Beschreibung
Create

string

Die Ressource ist nicht im aktuellen Zustand vorhanden, sondern im gewünschten Zustand vorhanden. Die Ressource wird erstellt, wenn die Bereitstellung ausgeführt wird.

Delete

string

Die Ressource befindet sich im aktuellen Zustand und fehlt im gewünschten Zustand. Die Ressource wird gelöscht, wenn die Bereitstellung ausgeführt wird.

Deploy

string

Die Ressource ist im aktuellen Zustand und im gewünschten Zustand vorhanden und wird bei Ausführung der Bereitstellung erneut bereitgestellt. Die Eigenschaften der Ressource können sich ändern oder auch nicht.

Ignore

string

Die Ressource befindet sich im aktuellen Zustand und fehlt im gewünschten Zustand. Die Ressource wird nicht bereitgestellt oder geändert, wenn die Bereitstellung ausgeführt wird.

Modify

string

Die Ressource befindet sich im aktuellen Zustand und im gewünschten Zustand und wird erneut bereitgestellt, wenn die Bereitstellung ausgeführt wird. Die Eigenschaften der Ressource ändern sich.

NoChange

string

Die Ressource ist im aktuellen Zustand und im gewünschten Zustand vorhanden und wird bei Ausführung der Bereitstellung erneut bereitgestellt. Die Eigenschaften der Ressource werden nicht geändert.

Unsupported

string

Die Ressource wird von Was-wäre-wenn nicht unterstützt.

CloudError

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name Typ Beschreibung
error

ErrorResponse

Fehlerantwort
Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

DebugSetting

Die Debugeinstellung.

Name Typ Beschreibung
detailLevel

string

Gibt den Typ der Informationen an, die für das Debuggen protokolliert werden sollen. Die zulässigen Werte sind none, requestContent, responseContent oder requestContent und responseContent getrennt durch ein Komma. Der Standardwert ist „none“. Berücksichtigen Sie beim Festlegen dieses Werts sorgfältig den Typ der Informationen, die Sie während der Bereitstellung übergeben. Indem Sie Informationen über die Anforderung oder die Antwort protokollieren, machen Sie möglicherweise vertrauliche Daten verfügbar, die durch die Bereitstellungsvorgänge abgerufen werden.

DeploymentMode

Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie ressourcen unbeabsichtigt löschen können.

Name Typ Beschreibung
Complete

string

Incremental

string

DeploymentWhatIf

Was-wäre-wenn-Vorgangsparameter für die Bereitstellung.

Name Typ Beschreibung
location

string

Der Speicherort für die Bereitstellungsdaten.

properties

DeploymentWhatIfProperties

Die Bereitstellungseigenschaften.

DeploymentWhatIfProperties

Was-wäre-wenn-Eigenschaften der Bereitstellung.

Name Typ Beschreibung
debugSetting

DebugSetting

Die Debugeinstellung der Bereitstellung.

expressionEvaluationOptions

ExpressionEvaluationOptions

Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten Vorlage oder der geschachtelten Vorlage ausgewertet werden. Gilt nur für geschachtelte Vorlagen. Wenn nicht angegeben, ist der Standardwert äußerer Wert.

mode

DeploymentMode

Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder vollständig sein. Im inkrementellen Modus werden Ressourcen bereitgestellt, ohne vorhandene Ressourcen zu löschen, die nicht in der Vorlage enthalten sind. Im Vollständigen Modus werden Ressourcen bereitgestellt, und vorhandene Ressourcen in der Ressourcengruppe, die nicht in der Vorlage enthalten sind, werden gelöscht. Seien Sie vorsichtig, wenn Sie den Vollständigen Modus verwenden, da Sie ressourcen unbeabsichtigt löschen können.

onErrorDeployment

OnErrorDeployment

Die Bereitstellung bei Fehlerverhalten.

parameters

object

Name- und Wertpaare, die die Bereitstellungsparameter für die Vorlage definieren. Sie verwenden dieses Element, wenn Sie die Parameterwerte direkt in der Anforderung bereitstellen möchten, anstatt mit einer vorhandenen Parameterdatei zu verknüpfen. Verwenden Sie entweder die parametersLink-Eigenschaft oder die parameters-Eigenschaft, aber nicht beides. Es kann sich um ein JObject-Objekt oder eine wohlgeformte JSON-Zeichenfolge handeln.

parametersLink

ParametersLink

Der URI der Parameterdatei. Sie verwenden dieses Element, um eine Verknüpfung mit einer vorhandenen Parameterdatei zu erstellen. Verwenden Sie entweder die parametersLink-Eigenschaft oder die parameters-Eigenschaft, aber nicht beides.

template

object

Der Vorlageninhalt. Sie verwenden dieses Element, wenn Sie die Vorlagensyntax direkt in der Anforderung übergeben möchten, anstatt mit einer vorhandenen Vorlage zu verknüpfen. Es kann sich um eine JObject-Zeichenfolge oder eine wohlgeformte JSON-Zeichenfolge handeln. Verwenden Sie entweder die templateLink-Eigenschaft oder die template-Eigenschaft, aber nicht beides.

templateLink

TemplateLink

Der URI der Vorlage. Verwenden Sie entweder die templateLink-Eigenschaft oder die template-Eigenschaft, aber nicht beides.

whatIfSettings

DeploymentWhatIfSettings

Optionale What-If Vorgangseinstellungen.

DeploymentWhatIfSettings

Bereitstellung What-If Vorgangseinstellungen.

Name Typ Beschreibung
resultFormat

WhatIfResultFormat

Das Format der What-If Ergebnisse

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorResponse[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ExpressionEvaluationOptions

Gibt an, ob Vorlagenausdrücke innerhalb des Bereichs der übergeordneten Vorlage oder der geschachtelten Vorlage ausgewertet werden.

Name Typ Beschreibung
scope

ExpressionEvaluationOptionsScopeType

Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.

ExpressionEvaluationOptionsScopeType

Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll.

Name Typ Beschreibung
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Bereitstellung bei Fehlerverhalten.

Name Typ Beschreibung
deploymentName

string

Die Bereitstellung, die für den Fehlerfall verwendet werden soll.

type

OnErrorDeploymentType

Der Bereitstellungstyp für fehlerverhalten. Mögliche Werte sind LastSuccessful und SpecificDeployment.

OnErrorDeploymentType

Der Bereitstellungstyp für fehlerverhalten. Mögliche Werte sind LastSuccessful und SpecificDeployment.

Name Typ Beschreibung
LastSuccessful

string

SpecificDeployment

string

Entität, die den Verweis auf die Bereitstellungsparameter darstellt.

Name Typ Beschreibung
contentVersion

string

Falls enthalten, muss mit der ContentVersion in der Vorlage übereinstimmen.

uri

string

Der URI der Parameterdatei.

PropertyChangeType

Der Typ der Eigenschaft ändert sich.

Name Typ Beschreibung
Array

string

Die -Eigenschaft ist ein Array und enthält geschachtelte Änderungen.

Create

string

Die -Eigenschaft ist nicht im aktuellen Zustand vorhanden, sondern im gewünschten Zustand vorhanden. Die -Eigenschaft wird erstellt, wenn die Bereitstellung ausgeführt wird.

Delete

string

Die -Eigenschaft befindet sich im aktuellen Zustand und fehlt im gewünschten Zustand. Sie wird gelöscht, wenn die Bereitstellung ausgeführt wird.

Modify

string

Die -Eigenschaft ist sowohl im aktuellen als auch im gewünschten Zustand vorhanden und unterscheidet sich. Der Wert der -Eigenschaft ändert sich, wenn die Bereitstellung ausgeführt wird.

NoEffect

string

Die -Eigenschaft wird nicht festgelegt oder aktualisiert.

Entität, die den Verweis auf die Vorlage darstellt.

Name Typ Beschreibung
contentVersion

string

Falls enthalten, muss mit der ContentVersion in der Vorlage übereinstimmen.

id

string

Die Ressourcen-ID einer Vorlagenspezifikation. Verwenden Sie entweder die ID- oder URI-Eigenschaft, aber nicht beides.

queryString

string

Die Abfragezeichenfolge (z. B. ein SAS-Token), die mit dem templateLink-URI verwendet werden soll.

relativePath

string

Die relativePath-Eigenschaft kann verwendet werden, um eine verknüpfte Vorlage relativ zum übergeordneten Standort bereitzustellen. Wenn die übergeordnete Vorlage mit einer TemplateSpec verknüpft wurde, verweist dies auf ein Artefakt im TemplateSpec. Wenn das übergeordnete Element mit einem URI verknüpft wurde, ist die untergeordnete Bereitstellung eine Kombination aus den übergeordneten und relativePath-URIs.

uri

string

Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder id-Eigenschaft, aber nicht beides.

WhatIfChange

Informationen zu einer einzelnen Ressourcenänderung, die von What-If Vorgang vorhergesagt wird.

Name Typ Beschreibung
after

object

Der vorhergesagte Momentaufnahme der Ressource, nachdem die Bereitstellung ausgeführt wurde.

before

object

Der Momentaufnahme der Ressource, bevor die Bereitstellung ausgeführt wird.

changeType

ChangeType

Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird.

delta

WhatIfPropertyChange[]

Die vorhergesagten Änderungen an den Ressourceneigenschaften.

resourceId

string

Ressourcen-ID

unsupportedReason

string

Die Erklärung, warum die Ressource von What-If nicht unterstützt wird.

WhatIfOperationResult

Ergebnis des What-If Vorgangs. Enthält eine Liste der vorhergesagten Änderungen und einen URL-Link, um zum nächsten Satz von Ergebnissen zu gelangen.

Name Typ Beschreibung
error

ErrorResponse

Fehlerantwort
Fehler, wenn What-If Vorgang fehlschlägt.

properties.changes

WhatIfChange[]

Liste der von What-If Vorgang vorhergesagten Ressourcenänderungen.

status

string

Status des What-If Vorgangs.

WhatIfPropertyChange

Die vorhergesagte Änderung an der Ressourceneigenschaft.

Name Typ Beschreibung
after

object

Der Wert der -Eigenschaft, nachdem die Bereitstellung ausgeführt wurde.

before

object

Der Wert der -Eigenschaft, bevor die Bereitstellung ausgeführt wird.

children

WhatIfPropertyChange[]

Geschachtelte Eigenschaftenänderungen.

path

string

Der Pfad der Eigenschaft.

propertyChangeType

PropertyChangeType

Der Typ der Eigenschaft ändert sich.

WhatIfResultFormat

Das Format der What-If Ergebnisse

Name Typ Beschreibung
FullResourcePayloads

string

ResourceIdOnly

string