Deployments - What If At Subscription Scope
Retourne les modifications qui seront apportées par le déploiement s’ils sont exécutés dans l’étendue de l’abonnement.
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf?api-version=2021-04-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
deployment
|
path | True |
string |
Le nom du déploiement. Modèle d’expression régulière: |
subscription
|
path | True |
string |
ID d’abonnement Microsoft Azure. |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
properties | True |
Propriétés de déploiement. |
|
location |
string |
Emplacement où stocker les données de déploiement. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
OK : retourne What-If status d’opération |
|
202 Accepted |
Accepté : retourne l’URL dans l’en-tête Location pour interroger les status d’opération de longue durée. En-têtes
|
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Exemples
Predict template changes at subscription scope
Exemple de requête
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"
}
}
Exemple de réponse
{
"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
Définitions
Nom | Description |
---|---|
Change |
Type de modification qui sera apportée à la ressource lors de l’exécution du déploiement. |
Cloud |
Réponse d’erreur pour une demande de gestion des ressources. |
Debug |
Paramètre de débogage. |
Deployment |
Mode utilisé pour déployer des ressources. Cette valeur peut être Incrémentielle ou Complète. En mode incrémentiel, les ressources sont déployées sans supprimer de ressources existantes non incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes du groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Soyez prudent lorsque vous utilisez le mode Complet, car vous pouvez supprimer involontairement des ressources. |
Deployment |
Paramètres d’opération de simulation de déploiement. |
Deployment |
Propriétés de scénario de déploiement. |
Deployment |
Paramètres d’opération de déploiement What-If. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Réponse d’erreur |
Expression |
Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. |
Expression |
Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. |
On |
Déploiement sur le comportement d’erreur. |
On |
Type de comportement de déploiement sur erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment. |
Parameters |
Entité représentant la référence aux paramètres de déploiement. |
Property |
Type de modification de propriété. |
Template |
Entité représentant la référence au modèle. |
What |
Informations sur une modification de ressource unique prédite par What-If opération. |
What |
Résultat de l’opération de What-If. Contient une liste des modifications prédites et un lien d’URL pour accéder au jeu de résultats suivant. |
What |
Modification prédite de la propriété de ressource. |
What |
Format des résultats What-If |
ChangeType
Type de modification qui sera apportée à la ressource lors de l’exécution du déploiement.
Nom | Type | Description |
---|---|---|
Create |
string |
La ressource n’existe pas dans l’état actuel, mais est présente dans l’état souhaité. La ressource sera créée lors de l’exécution du déploiement. |
Delete |
string |
La ressource existe dans l’état actuel et est absente de l’état souhaité. La ressource sera supprimée lors de l’exécution du déploiement. |
Deploy |
string |
La ressource existe dans l’état actuel et l’état souhaité, et sera redéployée lors de l’exécution du déploiement. Il est possible que les propriétés de la ressource changent. |
Ignore |
string |
La ressource existe dans l’état actuel et est absente de l’état souhaité. La ressource n’est pas déployée ou modifiée lors de l’exécution du déploiement. |
Modify |
string |
La ressource existe dans l’état actuel et l’état souhaité, et sera redéployée lors de l’exécution du déploiement. Les propriétés de la ressource changeront. |
NoChange |
string |
La ressource existe dans l’état actuel et l’état souhaité, et sera redéployée lors de l’exécution du déploiement. Les propriétés de la ressource ne changeront pas. |
Unsupported |
string |
La ressource n’est pas prise en charge par what-if. |
CloudError
Réponse d’erreur pour une demande de gestion des ressources.
Nom | Type | Description |
---|---|---|
error |
Réponse d’erreur |
DebugSetting
Paramètre de débogage.
Nom | Type | Description |
---|---|---|
detailLevel |
string |
Spécifie le type d’informations à consigner pour le débogage. Les valeurs autorisées sont none, requestContent, responseContent ou requestContent et responseContent séparées par une virgule. La valeur par défaut est aucune gestion. Lorsque vous définissez cette valeur, examinez soigneusement le type d’informations que vous transmettez pendant le déploiement. En enregistrant des informations sur la requête ou la réponse, vous risquez d’exposer des données sensibles récupérées au cours des opérations de déploiement. |
DeploymentMode
Mode utilisé pour déployer des ressources. Cette valeur peut être Incrémentielle ou Complète. En mode incrémentiel, les ressources sont déployées sans supprimer de ressources existantes non incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes du groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Soyez prudent lorsque vous utilisez le mode Complet, car vous pouvez supprimer involontairement des ressources.
Nom | Type | Description |
---|---|---|
Complete |
string |
|
Incremental |
string |
DeploymentWhatIf
Paramètres d’opération de simulation de déploiement.
Nom | Type | Description |
---|---|---|
location |
string |
Emplacement où stocker les données de déploiement. |
properties |
Propriétés de déploiement. |
DeploymentWhatIfProperties
Propriétés de scénario de déploiement.
Nom | Type | Description |
---|---|---|
debugSetting |
Paramètre de débogage du déploiement. |
|
expressionEvaluationOptions |
Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué. Applicable uniquement aux modèles imbriqués. Si elle n’est pas spécifiée, la valeur par défaut est externe. |
|
mode |
Mode utilisé pour déployer des ressources. Cette valeur peut être Incrémentielle ou Complète. En mode incrémentiel, les ressources sont déployées sans supprimer de ressources existantes non incluses dans le modèle. En mode Complet, les ressources sont déployées et les ressources existantes du groupe de ressources qui ne sont pas incluses dans le modèle sont supprimées. Soyez prudent lorsque vous utilisez le mode Complet, car vous pouvez supprimer involontairement des ressources. |
|
onErrorDeployment |
Déploiement sur le comportement d’erreur. |
|
parameters |
object |
Paires nom et valeur qui définissent les paramètres de déploiement du modèle. Vous utilisez cet élément lorsque vous souhaitez fournir les valeurs de paramètre directement dans la demande plutôt que de créer un lien vers un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. Il peut s’agir d’un JObject ou d’une chaîne JSON bien formée. |
parametersLink |
URI du fichier de paramètres. Vous utilisez cet élément pour établir un lien vers un fichier de paramètres existant. Utilisez la propriété parametersLink ou la propriété parameters, mais pas les deux. |
|
template |
object |
Contenu du modèle. Vous utilisez cet élément lorsque vous souhaitez transmettre la syntaxe du modèle directement dans la demande plutôt que de créer un lien vers un modèle existant. Il peut s’agir d’un JObject ou d’une chaîne JSON bien formée. Utilisez la propriété templateLink ou la propriété template, mais pas les deux. |
templateLink |
URI du modèle. Utilisez la propriété templateLink ou la propriété template, mais pas les deux. |
|
whatIfSettings |
Paramètres d’opération de What-If facultatifs. |
DeploymentWhatIfSettings
Paramètres d’opération de déploiement What-If.
Nom | Type | Description |
---|---|---|
resultFormat |
Format des résultats What-If |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
Nom | Type | Description |
---|---|---|
info |
object |
Informations supplémentaires |
type |
string |
Type d’informations supplémentaires. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
additionalInfo |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ExpressionEvaluationOptions
Spécifie si les expressions de modèle sont évaluées dans l’étendue du modèle parent ou du modèle imbriqué.
Nom | Type | Description |
---|---|---|
scope |
Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué. |
ExpressionEvaluationOptionsScopeType
Étendue à utiliser pour l’évaluation des paramètres, des variables et des fonctions dans un modèle imbriqué.
Nom | Type | Description |
---|---|---|
Inner |
string |
|
NotSpecified |
string |
|
Outer |
string |
OnErrorDeployment
Déploiement sur le comportement d’erreur.
Nom | Type | Description |
---|---|---|
deploymentName |
string |
Déploiement à utiliser en cas d’erreur. |
type |
Type de comportement de déploiement sur erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment. |
OnErrorDeploymentType
Type de comportement de déploiement sur erreur. Les valeurs possibles sont LastSuccessful et SpecificDeployment.
Nom | Type | Description |
---|---|---|
LastSuccessful |
string |
|
SpecificDeployment |
string |
ParametersLink
Entité représentant la référence aux paramètres de déploiement.
Nom | Type | Description |
---|---|---|
contentVersion |
string |
S’il est inclus, doit correspondre à ContentVersion dans le modèle. |
uri |
string |
URI du fichier de paramètres. |
PropertyChangeType
Type de modification de propriété.
Nom | Type | Description |
---|---|---|
Array |
string |
La propriété est un tableau et contient les modifications imbriquées. |
Create |
string |
La propriété n’existe pas dans l’état actuel, mais est présente dans l’état souhaité. La propriété est créée lors de l’exécution du déploiement. |
Delete |
string |
La propriété existe dans l’état actuel et est absente de l’état souhaité. Il sera supprimé lors de l’exécution du déploiement. |
Modify |
string |
La propriété existe à la fois dans l’état actuel et souhaité et est différente. La valeur de la propriété change lorsque le déploiement est exécuté. |
NoEffect |
string |
La propriété ne sera pas définie ou mise à jour. |
TemplateLink
Entité représentant la référence au modèle.
Nom | Type | Description |
---|---|---|
contentVersion |
string |
S’il est inclus, doit correspondre à ContentVersion dans le modèle. |
id |
string |
ID de ressource d’une spécification de modèle. Utilisez la propriété id ou uri, mais pas les deux. |
queryString |
string |
Chaîne de requête (par exemple, un jeton SAS) à utiliser avec l’URI templateLink. |
relativePath |
string |
La propriété relativePath peut être utilisée pour déployer un modèle lié à un emplacement par rapport au parent. Si le modèle parent a été lié à un TemplateSpec, cela fait référence à un artefact dans templateSpec. Si le parent a été lié à un URI, le déploiement enfant est une combinaison des URI parent et relativePath |
uri |
string |
URI du modèle à déployer. Utilisez la propriété uri ou id, mais pas les deux. |
WhatIfChange
Informations sur une modification de ressource unique prédite par What-If opération.
Nom | Type | Description |
---|---|---|
after |
object |
La instantané prédite de la ressource après l’exécution du déploiement. |
before |
object |
La instantané de la ressource avant l’exécution du déploiement. |
changeType |
Type de modification qui sera apportée à la ressource lors de l’exécution du déploiement. |
|
delta |
Modifications prédites des propriétés de ressource. |
|
resourceId |
string |
ID de ressource |
unsupportedReason |
string |
Explication de la raison pour laquelle la ressource n’est pas prise en charge par what-if. |
WhatIfOperationResult
Résultat de l’opération de What-If. Contient une liste des modifications prédites et un lien d’URL pour accéder au jeu de résultats suivant.
Nom | Type | Description |
---|---|---|
error |
Réponse d’erreur |
|
properties.changes |
Liste des modifications de ressources prédites par What-If opération. |
|
status |
string |
État de l’opération What-If. |
WhatIfPropertyChange
Modification prédite de la propriété de ressource.
Nom | Type | Description |
---|---|---|
after |
object |
Valeur de la propriété après l’exécution du déploiement. |
before |
object |
Valeur de la propriété avant l’exécution du déploiement. |
children |
Modifications des propriétés imbriquées. |
|
path |
string |
Chemin d'accès à la propriété. |
propertyChangeType |
Type de modification de propriété. |
WhatIfResultFormat
Format des résultats What-If
Nom | Type | Description |
---|---|---|
FullResourcePayloads |
string |
|
ResourceIdOnly |
string |