Deployments - What If At Subscription Scope
Retourneert wijzigingen die door de implementatie worden aangebracht als deze worden uitgevoerd op het bereik van het abonnement.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf?api-version=2021-04-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
deployment
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[-\w\._\(\)]+$ |
De naam van de implementatie. |
subscription
|
path | True |
string |
De microsoft Azure-abonnements-id. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
properties | True |
De implementatie-eigenschappen. |
|
location |
string |
De locatie voor het opslaan van de implementatiegegevens. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK : retourneert What-If bewerkingsstatus |
|
202 Accepted |
Geaccepteerd: retourneert de URL in de locatieheader om een query uit te voeren op de langdurige bewerkingsstatus. Kopteksten
|
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
Predict template changes at subscription scope
Voorbeeldaanvraag
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"
}
}
Voorbeeldrespons
{
"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
Definities
Name | Description |
---|---|
Change |
Het type wijziging dat wordt aangebracht in de resource wanneer de implementatie wordt uitgevoerd. |
Cloud |
Een foutbericht voor een aanvraag voor resourcebeheer. |
Debug |
De instelling voor foutopsporing. |
Deployment |
De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen. |
Deployment |
Wat-als-bewerkingsparameters implementeren. |
Deployment |
Wat-als-eigenschappen implementeren. |
Deployment |
Implementatie What-If bewerkingsinstellingen. |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
Foutreactie |
Expression |
Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon. |
Expression |
Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon. |
On |
Implementatie bij foutgedrag. |
On |
De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment. |
Parameters |
Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt. |
Property |
Het type eigenschapswijziging. |
Template |
Entiteit die de verwijzing naar de sjabloon vertegenwoordigt. |
What |
Informatie over één resourcewijziging die wordt voorspeld door What-If bewerking. |
What |
Resultaat van de What-If bewerking. Bevat een lijst met voorspelde wijzigingen en een URL-koppeling om naar de volgende set resultaten te gaan. |
What |
De voorspelde wijziging in de resource-eigenschap. |
What |
De indeling van de What-If resultaten |
ChangeType
Het type wijziging dat wordt aangebracht in de resource wanneer de implementatie wordt uitgevoerd.
Waarde | Description |
---|---|
Create |
De resource bestaat niet in de huidige status, maar heeft de gewenste status. De resource wordt gemaakt wanneer de implementatie wordt uitgevoerd. |
Delete |
De resource bestaat in de huidige status en ontbreekt in de gewenste status. De resource wordt verwijderd wanneer de implementatie wordt uitgevoerd. |
Deploy |
De resource bestaat in de huidige status en de gewenste status en wordt opnieuw geïmplementeerd wanneer de implementatie wordt uitgevoerd. De eigenschappen van de resource kunnen al dan niet veranderen. |
Ignore |
De resource bestaat in de huidige status en ontbreekt in de gewenste status. De resource wordt niet geïmplementeerd of gewijzigd wanneer de implementatie wordt uitgevoerd. |
Modify |
De resource bestaat in de huidige status en de gewenste status en wordt opnieuw geïmplementeerd wanneer de implementatie wordt uitgevoerd. De eigenschappen van de resource worden gewijzigd. |
NoChange |
De resource bestaat in de huidige status en de gewenste status en wordt opnieuw geïmplementeerd wanneer de implementatie wordt uitgevoerd. De eigenschappen van de resource worden niet gewijzigd. |
Unsupported |
De resource wordt niet ondersteund door What-If. |
CloudError
Een foutbericht voor een aanvraag voor resourcebeheer.
Name | Type | Description |
---|---|---|
error |
Foutreactie |
DebugSetting
De instelling voor foutopsporing.
Name | Type | Description |
---|---|---|
detailLevel |
string |
Hiermee geeft u het type informatie op dat moet worden vastgelegd voor foutopsporing. De toegestane waarden zijn geen, requestContent, responseContent of zowel requestContent als responseContent, gescheiden door een komma. De standaardwaarde is geen. Houd bij het instellen van deze waarde zorgvuldig rekening met het type informatie dat u tijdens de implementatie doorgeeft. Door informatie over de aanvraag of het antwoord te registreren, kunt u mogelijk gevoelige gegevens beschikbaar maken die worden opgehaald via de implementatiebewerkingen. |
DeploymentMode
De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen.
Waarde | Description |
---|---|
Complete | |
Incremental |
DeploymentWhatIf
Wat-als-bewerkingsparameters implementeren.
Name | Type | Description |
---|---|---|
location |
string |
De locatie voor het opslaan van de implementatiegegevens. |
properties |
De implementatie-eigenschappen. |
DeploymentWhatIfProperties
Wat-als-eigenschappen implementeren.
Name | Type | Description |
---|---|---|
debugSetting |
De foutopsporingsinstelling van de implementatie. |
|
expressionEvaluationOptions |
Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon. Alleen van toepassing op geneste sjablonen. Als dit niet is opgegeven, is de standaardwaarde buitenste waarde. |
|
mode |
De modus die wordt gebruikt voor het implementeren van resources. Deze waarde kan incrementeel of voltooid zijn. In de incrementele modus worden resources geïmplementeerd zonder bestaande resources te verwijderen die niet zijn opgenomen in de sjabloon. In de volledige modus worden resources geïmplementeerd en worden bestaande resources in de resourcegroep verwijderd die niet zijn opgenomen in de sjabloon. Wees voorzichtig bij het gebruik van de volledige modus, omdat u resources onbedoeld kunt verwijderen. |
|
onErrorDeployment |
De implementatie op foutgedrag. |
|
parameters |
object |
Naam- en waardeparen waarmee de implementatieparameters voor de sjabloon worden gedefinieerd. U gebruikt dit element als u de parameterwaarden rechtstreeks in de aanvraag wilt opgeven in plaats van een koppeling te maken naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de parametereigenschap, maar niet beide. Dit kan een JObject of een goed opgemaakte JSON-tekenreeks zijn. |
parametersLink |
De URI van het parameterbestand. U gebruikt dit element om een koppeling te maken naar een bestaand parameterbestand. Gebruik de eigenschap parametersLink of de parametereigenschap, maar niet beide. |
|
template |
object |
De sjablooninhoud. U gebruikt dit element als u de syntaxis van de sjabloon rechtstreeks in de aanvraag wilt doorgeven in plaats van een koppeling naar een bestaande sjabloon. Dit kan een JObject of een goed opgemaakte JSON-tekenreeks zijn. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide. |
templateLink |
De URI van de sjabloon. Gebruik de eigenschap templateLink of de sjablooneigenschap, maar niet beide. |
|
whatIfSettings |
Optionele What-If bewerkingsinstellingen. |
DeploymentWhatIfSettings
Implementatie What-If bewerkingsinstellingen.
Name | Type | Description |
---|---|---|
resultFormat |
De indeling van de What-If resultaten |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het extra informatietype. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
additionalInfo |
De fout bevat aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ExpressionEvaluationOptions
Hiermee geeft u op of sjabloonexpressies worden geëvalueerd binnen het bereik van de bovenliggende sjabloon of geneste sjabloon.
Name | Type | Description |
---|---|---|
scope |
Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon. |
ExpressionEvaluationOptionsScopeType
Het bereik dat moet worden gebruikt voor de evaluatie van parameters, variabelen en functies in een geneste sjabloon.
Waarde | Description |
---|---|
Inner | |
NotSpecified | |
Outer |
OnErrorDeployment
Implementatie bij foutgedrag.
Name | Type | Description |
---|---|---|
deploymentName |
string |
De implementatie die moet worden gebruikt voor een foutcase. |
type |
De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment. |
OnErrorDeploymentType
De implementatie op foutgedragstype. Mogelijke waarden zijn LastSuccessful en SpecificDeployment.
Waarde | Description |
---|---|
LastSuccessful | |
SpecificDeployment |
ParametersLink
Entiteit die de verwijzing naar de implementatieparameters vertegenwoordigt.
Name | Type | Description |
---|---|---|
contentVersion |
string |
Indien opgenomen, moet deze overeenkomen met de ContentVersion in de sjabloon. |
uri |
string |
De URI van het parameterbestand. |
PropertyChangeType
Het type eigenschapswijziging.
Waarde | Description |
---|---|
Array |
De eigenschap is een matrix en bevat geneste wijzigingen. |
Create |
De eigenschap bestaat niet in de huidige status, maar heeft de gewenste status. De eigenschap wordt gemaakt wanneer de implementatie wordt uitgevoerd. |
Delete |
De eigenschap bestaat in de huidige status en ontbreekt in de gewenste status. Deze wordt verwijderd wanneer de implementatie wordt uitgevoerd. |
Modify |
De eigenschap bestaat in zowel de huidige als de gewenste status en is anders. De waarde van de eigenschap wordt gewijzigd wanneer de implementatie wordt uitgevoerd. |
NoEffect |
De eigenschap wordt niet ingesteld of bijgewerkt. |
TemplateLink
Entiteit die de verwijzing naar de sjabloon vertegenwoordigt.
Name | Type | Description |
---|---|---|
contentVersion |
string |
Indien opgenomen, moet deze overeenkomen met de ContentVersion in de sjabloon. |
id |
string |
De resource-id van een sjabloonspecificatie. Gebruik de id of URI-eigenschap, maar niet beide. |
queryString |
string |
De querytekenreeks (bijvoorbeeld een SAS-token) die moet worden gebruikt met de templateLink-URI. |
relativePath |
string |
De relatievePath-eigenschap kan worden gebruikt om een gekoppelde sjabloon te implementeren op een locatie ten opzichte van het bovenliggende item. Als de bovenliggende sjabloon is gekoppeld aan een TemplateSpec, verwijst dit naar een artefact in de TemplateSpec. Als het bovenliggende item is gekoppeld aan een URI, is de onderliggende implementatie een combinatie van de bovenliggende en relatievePath-URI's |
uri |
string |
De URI van de sjabloon die moet worden geïmplementeerd. Gebruik de eigenschap URI of id, maar niet beide. |
WhatIfChange
Informatie over één resourcewijziging die wordt voorspeld door What-If bewerking.
Name | Type | Description |
---|---|---|
after |
object |
De voorspelde momentopname van de resource nadat de implementatie is uitgevoerd. |
before |
object |
De momentopname van de resource voordat de implementatie wordt uitgevoerd. |
changeType |
Het type wijziging dat wordt aangebracht in de resource wanneer de implementatie wordt uitgevoerd. |
|
delta |
De voorspelde wijzigingen in resource-eigenschappen. |
|
resourceId |
string |
Resource-ID |
unsupportedReason |
string |
De uitleg over waarom de resource niet wordt ondersteund door What-If. |
WhatIfOperationResult
Resultaat van de What-If bewerking. Bevat een lijst met voorspelde wijzigingen en een URL-koppeling om naar de volgende set resultaten te gaan.
Name | Type | Description |
---|---|---|
error |
Foutreactie |
|
properties.changes |
Lijst met resourcewijzigingen voorspeld door What-If bewerking. |
|
status |
string |
Status van de What-If bewerking. |
WhatIfPropertyChange
De voorspelde wijziging in de resource-eigenschap.
Name | Type | Description |
---|---|---|
after |
object |
De waarde van de eigenschap nadat de implementatie is uitgevoerd. |
before |
object |
De waarde van de eigenschap voordat de implementatie wordt uitgevoerd. |
children |
Geneste eigenschapswijzigingen. |
|
path |
string |
Het pad van de eigenschap. |
propertyChangeType |
Het type eigenschapswijziging. |
WhatIfResultFormat
De indeling van de What-If resultaten
Waarde | Description |
---|---|
FullResourcePayloads | |
ResourceIdOnly |