Deployments - What If At Tenant Scope
Gibt Änderungen zurück, die von der Bereitstellung vorgenommen werden, wenn sie im Bereich der Mandantengruppe ausgeführt werden.
POST https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf?api-version=2021-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
deployment
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[-\w\._\(\)]+$ |
Der Name der Bereitstellung. |
api-version
|
query | True |
string |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
location | True |
string |
Der Speicherort zum Speichern der Bereitstellungsdaten. |
properties | True |
Die Bereitstellungseigenschaften. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK – Gibt What-If Vorgangsstatus zurück. |
|
202 Accepted |
Akzeptiert – Gibt die URL im Location-Header zurück, um den Status des lang ausgeführten Vorgangs abzufragen. Header
|
|
Other Status Codes |
Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
Predict template changes at management group scope
Beispielanforderung
POST https://management.azure.com/providers/Microsoft.Resources/deployments/exampleDeploymentName/whatIf?api-version=2021-04-01
{
"location": "eastus",
"properties": {
"templateLink": {
"uri": "https://example.com/exampleTemplate.json"
},
"parameters": {},
"mode": "Incremental"
}
}
Beispiel für eine Antwort
{
"status": "Succeeded",
"properties": {
"changes": [
{
"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
"changeType": "Create",
"after": {
"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup",
"apiVersion": "2019-11-01",
"type": "Microsoft.Management/managementGroups",
"name": "myManagementGroup"
}
}
]
}
}
Location: /subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
Definitionen
Name | Beschreibung |
---|---|
Change |
Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird. |
Cloud |
Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung. |
Debug |
Die Debugeinstellung. |
Deployment |
Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder abgeschlossen 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, gelöscht. Achten Sie darauf, wenn Sie den Vollständigen Modus verwenden, da Sie möglicherweise unbeabsichtigt Ressourcen löschen. |
Deployment |
Bereitstellungs-Was-wäre-wenn-Eigenschaften. |
Deployment |
Bereitstellung What-If Vorgangseinstellungen. |
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
Error |
Fehlerantwort |
Expression |
Gibt an, ob Vorlagenausdrücke im Bereich der übergeordneten Vorlage oder geschachtelten Vorlage ausgewertet werden. |
Expression |
Der Bereich, der für die Auswertung von Parametern, Variablen und Funktionen in einer geschachtelten Vorlage verwendet werden soll. |
On |
Bereitstellung beim Fehlerverhalten. |
On |
Die Bereitstellung beim Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment. |
Parameters |
Entität, die den Verweis auf die Bereitstellungsparameter darstellt. |
Property |
Der Typ der Eigenschaftsänderung. |
Scoped |
Bereitstellungs-Was-wäre-wenn-Vorgangsparameter. |
Template |
Entität, die den Verweis auf die Vorlage darstellt. |
What |
Informationen zu einer einzelnen Ressourcenänderung, die von What-If Vorgang vorhergesagt wurde. |
What |
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. |
What |
Die vorhergesagte Änderung an der Ressourceneigenschaft. |
What |
Das Format der What-If Ergebnisse |
ChangeType
Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird.
Wert | Beschreibung |
---|---|
Create |
Die Ressource ist nicht im aktuellen Zustand vorhanden, ist aber im gewünschten Zustand vorhanden. Die Ressource wird erstellt, wenn die Bereitstellung ausgeführt wird. |
Delete |
Die Ressource ist im aktuellen Zustand vorhanden und fehlt im gewünschten Zustand. Die Ressource wird gelöscht, wenn die Bereitstellung ausgeführt wird. |
Deploy |
Die Ressource ist im aktuellen Zustand und im gewünschten Zustand vorhanden und wird erneut bereitgestellt, wenn die Bereitstellung ausgeführt wird. Die Eigenschaften der Ressource können sich ändern oder auch nicht. |
Ignore |
Die Ressource ist im aktuellen Zustand vorhanden und fehlt im gewünschten Zustand. Die Ressource wird nicht bereitgestellt oder geändert, wenn die Bereitstellung ausgeführt wird. |
Modify |
Die Ressource ist im aktuellen Zustand und im gewünschten Zustand vorhanden und wird erneut bereitgestellt, wenn die Bereitstellung ausgeführt wird. Die Eigenschaften der Ressource werden geändert. |
NoChange |
Die Ressource ist im aktuellen Zustand und im gewünschten Zustand vorhanden und wird erneut bereitgestellt, wenn die Bereitstellung ausgeführt wird. Die Eigenschaften der Ressource werden nicht geändert. |
Unsupported |
Die Ressource wird von What-If nicht unterstützt. |
CloudError
Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
Name | Typ | Beschreibung |
---|---|---|
error |
Fehlerantwort |
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", die durch ein Komma getrennt sind. Der Standardwert ist keine. Berücksichtigen Sie beim Festlegen dieses Werts sorgfältig die Art der Informationen, die Sie während der Bereitstellung übergeben. Durch die Protokollierung von Informationen über die Anforderung oder Antwort könnten Sie potenziell vertrauliche Daten verfügbar machen, die über die Bereitstellungsvorgänge abgerufen werden. |
DeploymentMode
Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder abgeschlossen 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, gelöscht. Achten Sie darauf, wenn Sie den Vollständigen Modus verwenden, da Sie möglicherweise unbeabsichtigt Ressourcen löschen.
Wert | Beschreibung |
---|---|
Complete | |
Incremental |
DeploymentWhatIfProperties
Bereitstellungs-Was-wäre-wenn-Eigenschaften.
Name | Typ | Beschreibung |
---|---|---|
debugSetting |
Die Debugeinstellung der Bereitstellung. |
|
expressionEvaluationOptions |
Gibt an, ob Vorlagenausdrücke im Bereich der übergeordneten Vorlage oder geschachtelten Vorlage ausgewertet werden. Gilt nur für geschachtelte Vorlagen. Wenn nicht angegeben, ist der Standardwert außen. |
|
mode |
Der Modus, der zum Bereitstellen von Ressourcen verwendet wird. Dieser Wert kann entweder inkrementell oder abgeschlossen 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, gelöscht. Achten Sie darauf, wenn Sie den Vollständigen Modus verwenden, da Sie möglicherweise unbeabsichtigt Ressourcen löschen. |
|
onErrorDeployment |
Die Bereitstellung beim 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 eine Verknüpfung mit einer vorhandenen Parameterdatei zu erstellen. Verwenden Sie entweder die ParametersLink-Eigenschaft oder die Parametereigenschaft, aber nicht beide. Es kann sich um ein JObject oder eine wohlgeformte JSON-Zeichenfolge sein. |
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 Parametereigenschaft, aber nicht beide. |
|
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- oder wohlgeformte JSON-Zeichenfolge sein. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide. |
templateLink |
Der URI der Vorlage. Verwenden Sie entweder die templateLink-Eigenschaft oder die Vorlageneigenschaft, aber nicht beide. |
|
whatIfSettings |
Optionale What-If Vorgangseinstellungen. |
DeploymentWhatIfSettings
Bereitstellung What-If Vorgangseinstellungen.
Name | Typ | Beschreibung |
---|---|---|
resultFormat |
Das Format der What-If Ergebnisse |
ErrorAdditionalInfo
Der Ressourcenverwaltungsfehler zusätzliche Informationen.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Die zusätzlichen Informationen. |
type |
string |
Der zusätzliche Informationstyp. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Informationen des Fehlers. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ExpressionEvaluationOptions
Gibt an, ob Vorlagenausdrücke im Bereich der übergeordneten Vorlage oder geschachtelten Vorlage ausgewertet werden.
Name | Typ | Beschreibung |
---|---|---|
scope |
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.
Wert | Beschreibung |
---|---|
Inner | |
NotSpecified | |
Outer |
OnErrorDeployment
Bereitstellung beim Fehlerverhalten.
Name | Typ | Beschreibung |
---|---|---|
deploymentName |
string |
Die Bereitstellung, die für den Fehlerfall verwendet werden soll. |
type |
Die Bereitstellung beim Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment. |
OnErrorDeploymentType
Die Bereitstellung beim Fehlerverhaltenstyp. Mögliche Werte sind LastSuccessful und SpecificDeployment.
Wert | Beschreibung |
---|---|
LastSuccessful | |
SpecificDeployment |
ParametersLink
Entität, die den Verweis auf die Bereitstellungsparameter darstellt.
Name | Typ | Beschreibung |
---|---|---|
contentVersion |
string |
Falls enthalten, muss der ContentVersion in der Vorlage entsprechen. |
uri |
string |
Der URI der Parameterdatei. |
PropertyChangeType
Der Typ der Eigenschaftsänderung.
Wert | Beschreibung |
---|---|
Array |
Die Eigenschaft ist ein Array und enthält geschachtelte Änderungen. |
Create |
Die Eigenschaft ist nicht im aktuellen Zustand vorhanden, ist aber im gewünschten Zustand vorhanden. Die Eigenschaft wird erstellt, wenn die Bereitstellung ausgeführt wird. |
Delete |
Die Eigenschaft ist im aktuellen Zustand vorhanden und fehlt im gewünschten Zustand. Sie wird gelöscht, wenn die Bereitstellung ausgeführt wird. |
Modify |
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 |
Die Eigenschaft wird nicht festgelegt oder aktualisiert. |
ScopedDeploymentWhatIf
Bereitstellungs-Was-wäre-wenn-Vorgangsparameter.
Name | Typ | Beschreibung |
---|---|---|
location |
string |
Der Speicherort zum Speichern der Bereitstellungsdaten. |
properties |
Die Bereitstellungseigenschaften. |
TemplateLink
Entität, die den Verweis auf die Vorlage darstellt.
Name | Typ | Beschreibung |
---|---|---|
contentVersion |
string |
Falls enthalten, muss der ContentVersion in der Vorlage entsprechen. |
id |
string |
Die Ressourcen-ID einer Vorlagenspezifikation. Verwenden Sie entweder die ID- oder URI-Eigenschaft, aber nicht beide. |
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 an einem Speicherort relativ zum übergeordneten Element bereitzustellen. Wenn die übergeordnete Vorlage mit einer TemplateSpec verknüpft wurde, wird auf ein Artefakt in der TemplateSpec verwiesen. Wenn das übergeordnete Element mit einem URI verknüpft wurde, ist die untergeordnete Bereitstellung eine Kombination aus den übergeordneten und relativenPath-URIs. |
uri |
string |
Der URI der bereitzustellenden Vorlage. Verwenden Sie entweder die URI- oder ID-Eigenschaft, aber nicht beide. |
WhatIfChange
Informationen zu einer einzelnen Ressourcenänderung, die von What-If Vorgang vorhergesagt wurde.
Name | Typ | Beschreibung |
---|---|---|
after |
object |
Die vorhergesagte Momentaufnahme der Ressource, nachdem die Bereitstellung ausgeführt wurde. |
before |
object |
Die Momentaufnahme der Ressource, bevor die Bereitstellung ausgeführt wird. |
changeType |
Art der Änderung, die an der Ressource vorgenommen wird, wenn die Bereitstellung ausgeführt wird. |
|
delta |
Die vorhergesagten Änderungen an Ressourceneigenschaften. |
|
resourceId |
string |
Ressourcen-ID |
unsupportedReason |
string |
Die Erläuterung dazu, 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 |
Fehlerantwort |
|
properties.changes |
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 |
Geschachtelte Eigenschaftenänderungen. |
|
path |
string |
Der Pfad der Eigenschaft. |
propertyChangeType |
Der Typ der Eigenschaftsänderung. |
WhatIfResultFormat
Das Format der What-If Ergebnisse
Wert | Beschreibung |
---|---|
FullResourcePayloads | |
ResourceIdOnly |