Condividi tramite


Deployments - What If

Restituisce le modifiche che verranno apportate dalla distribuzione se eseguite nell'ambito del gruppo di risorse.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
deploymentName
path True

string

Nome della distribuzione.

Criterio di espressione regolare: ^[-\w\._\(\)]+$

resourceGroupName
path True

string

Nome del gruppo di risorse in cui verrà distribuito il modello. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

Criterio di espressione regolare: ^[-\w\._\(\)]+$

subscriptionId
path True

string

ID sottoscrizione di Microsoft Azure.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties True

DeploymentWhatIfProperties

Proprietà di distribuzione.

location

string

Percorso in cui archiviare i dati di distribuzione.

Risposte

Nome Tipo Descrizione
200 OK

WhatIfOperationResult

OK : restituisce lo stato dell'operazione What-If

202 Accepted

Accettato: restituisce l'URL nell'intestazione Percorso per eseguire una query sullo stato dell'operazione a esecuzione prolungata.

Intestazioni

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

CloudError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Predict template changes at resource group scope

Esempio di richiesta

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

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}

Risposta di esempio

{
  "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"
          }
        }
      }
    ]
  }
}
Location: /subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

Definizioni

Nome Descrizione
ChangeType

Tipo di modifica che verrà apportata alla risorsa quando viene eseguita la distribuzione.

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

DebugSetting

Impostazione di debug.

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere incrementale o completo. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità completa perché è possibile eliminare in modo involontario le risorse.

DeploymentWhatIf

Parametri dell'operazione di distribuzione.

DeploymentWhatIfProperties

Distribuzione delle proprietà what-if.

DeploymentWhatIfSettings

Impostazioni delle operazioni di distribuzione What-If.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

ErrorResponse

Risposta di errore

ExpressionEvaluationOptions

Specifica se le espressioni di modello vengono valutate nell'ambito del modello padre o del modello annidato.

ExpressionEvaluationOptionsScopeType

Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.

OnErrorDeployment

Distribuzione sul comportamento degli errori.

OnErrorDeploymentType

La distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

ParametersLink

Entità che rappresenta il riferimento ai parametri di distribuzione.

PropertyChangeType

Tipo di modifica della proprietà.

TemplateLink

Entità che rappresenta il riferimento al modello.

WhatIfChange

Informazioni su una singola modifica della risorsa stimata dall'operazione di What-If.

WhatIfOperationResult

Risultato dell'operazione di What-If. Contiene un elenco di modifiche stimate e un collegamento URL per ottenere il set successivo di risultati.

WhatIfPropertyChange

Modifica stimata alla proprietà della risorsa.

WhatIfResultFormat

Formato dei risultati What-If

ChangeType

Tipo di modifica che verrà apportata alla risorsa quando viene eseguita la distribuzione.

Nome Tipo Descrizione
Create

string

La risorsa non esiste nello stato corrente, ma è presente nello stato desiderato. La risorsa verrà creata al momento dell'esecuzione della distribuzione.

Delete

string

La risorsa esiste nello stato corrente e manca dallo stato desiderato. La risorsa verrà eliminata quando viene eseguita la distribuzione.

Deploy

string

La risorsa esiste nello stato corrente e lo stato desiderato e verrà ridistribuito quando viene eseguita la distribuzione. Le proprietà della risorsa possono essere modificate o meno.

Ignore

string

La risorsa esiste nello stato corrente e manca dallo stato desiderato. La risorsa non verrà distribuita o modificata quando viene eseguita la distribuzione.

Modify

string

La risorsa esiste nello stato corrente e nello stato desiderato e verrà ridistribuito quando viene eseguita la distribuzione. Le proprietà della risorsa verranno modificate.

NoChange

string

La risorsa esiste nello stato corrente e lo stato desiderato e verrà ridistribuito quando viene eseguita la distribuzione. Le proprietà della risorsa non verranno modificate.

Unsupported

string

La risorsa non è supportata da What-If.

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

Nome Tipo Descrizione
error

ErrorResponse

Risposta di errore
Risposta di errore comune per tutte le API di Resource Manager di Azure per restituire i dettagli degli errori per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

DebugSetting

Impostazione di debug.

Nome Tipo Descrizione
detailLevel

string

Specifica il tipo di informazioni da registrare per il debug. I valori consentiti sono none, requestContent, responseContent o requestContent e responseContent separati da una virgola. Il valore predefinito è none. Quando si imposta questo valore, considerare attentamente il tipo di informazioni passate durante la distribuzione. La registrazione di informazioni sulla richiesta o sulla risposta può esporre dati riservati, che vengono recuperati tramite le operazioni di distribuzione.

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere incrementale o completo. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità completa perché è possibile eliminare in modo involontario le risorse.

Nome Tipo Descrizione
Complete

string

Incremental

string

DeploymentWhatIf

Parametri dell'operazione di distribuzione.

Nome Tipo Descrizione
location

string

Percorso per archiviare i dati di distribuzione.

properties

DeploymentWhatIfProperties

Proprietà di distribuzione.

DeploymentWhatIfProperties

Distribuzione delle proprietà what-if.

Nome Tipo Descrizione
debugSetting

DebugSetting

Impostazione di debug della distribuzione.

expressionEvaluationOptions

ExpressionEvaluationOptions

Specifica se le espressioni di modello vengono valutate nell'ambito del modello padre o del modello annidato. Applicabile solo ai modelli annidati. Se non specificato, il valore predefinito è esterno.

mode

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere incrementale o completo. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità completa perché è possibile eliminare in modo involontario le risorse.

onErrorDeployment

OnErrorDeployment

La distribuzione sul comportamento dell'errore.

parameters

object

Coppie nome e valore che definiscono i parametri di distribuzione per il modello. Questo elemento viene usato quando si desidera specificare i valori dei parametri direttamente nella richiesta anziché collegarsi a un file di parametri esistente. Usare la proprietà parametersLink o la proprietà parameters, ma non entrambe. Può essere una stringa JSON ben formata o JObject.

parametersLink

ParametersLink

URI del file di parametri. Usare questo elemento per collegare un file di parametri esistente. Usare la proprietà parametersLink o la proprietà parameters, ma non entrambe.

template

object

Contenuto del modello. Questo elemento viene usato quando si vuole passare la sintassi del modello direttamente nella richiesta anziché collegarsi a un modello esistente. Può essere una stringa JSON con formato JObject o ben formato. Usare la proprietà templateLink o la proprietà modello, ma non entrambi.

templateLink

TemplateLink

URI del modello. Usare la proprietà templateLink o la proprietà modello, ma non entrambi.

whatIfSettings

DeploymentWhatIfSettings

Impostazioni di operazione facoltative What-If.

DeploymentWhatIfSettings

Impostazioni delle operazioni di distribuzione What-If.

Nome Tipo Descrizione
resultFormat

WhatIfResultFormat

Formato dei risultati What-If

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorResponse[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ExpressionEvaluationOptions

Specifica se le espressioni di modello vengono valutate nell'ambito del modello padre o del modello annidato.

Nome Tipo Descrizione
scope

ExpressionEvaluationOptionsScopeType

Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.

ExpressionEvaluationOptionsScopeType

Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.

Nome Tipo Descrizione
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Distribuzione sul comportamento degli errori.

Nome Tipo Descrizione
deploymentName

string

Distribuzione da usare in caso di errore.

type

OnErrorDeploymentType

La distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

OnErrorDeploymentType

La distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

Nome Tipo Descrizione
LastSuccessful

string

SpecificDeployment

string

Entità che rappresenta il riferimento ai parametri di distribuzione.

Nome Tipo Descrizione
contentVersion

string

Se incluso, deve corrispondere a ContentVersion nel modello.

uri

string

URI del file di parametri.

PropertyChangeType

Tipo di modifica della proprietà.

Nome Tipo Descrizione
Array

string

La proprietà è una matrice e contiene modifiche annidate.

Create

string

La proprietà non esiste nello stato corrente, ma è presente nello stato desiderato. La proprietà verrà creata quando viene eseguita la distribuzione.

Delete

string

La proprietà esiste nello stato corrente ed è mancante dallo stato desiderato. Verrà eliminato quando viene eseguita la distribuzione.

Modify

string

La proprietà esiste sia nello stato corrente che in quello desiderato ed è diversa. Il valore della proprietà cambierà quando viene eseguita la distribuzione.

NoEffect

string

La proprietà non verrà impostata o aggiornata.

Entità che rappresenta il riferimento al modello.

Nome Tipo Descrizione
contentVersion

string

Se incluso, deve corrispondere a ContentVersion nel modello.

id

string

ID risorsa di una specifica modello. Utilizzare la proprietà ID o URI, ma non entrambi.

queryString

string

Stringa di query (ad esempio, un token di firma di accesso condiviso) da usare con l'URI templateLink.

relativePath

string

La proprietà relativePath può essere usata per distribuire un modello collegato in una posizione relativa all'elemento padre. Se il modello padre è stato collegato a un modello TemplateSpec, verrà fatto riferimento a un artefatto in TemplateSpec. Se l'elemento padre è stato collegato a un URI, la distribuzione figlio sarà una combinazione degli URI padre e relativi

uri

string

URI del modello da distribuire. Usare l'URI o la proprietà ID, ma non entrambi.

WhatIfChange

Informazioni su una singola modifica della risorsa stimata dall'operazione di What-If.

Nome Tipo Descrizione
after

object

Snapshot stimato della risorsa dopo l'esecuzione della distribuzione.

before

object

Snapshot della risorsa prima dell'esecuzione della distribuzione.

changeType

ChangeType

Tipo di modifica che verrà apportata alla risorsa quando viene eseguita la distribuzione.

delta

WhatIfPropertyChange[]

Le modifiche stimate alle proprietà delle risorse.

resourceId

string

ID risorsa

unsupportedReason

string

Spiegazione sul motivo per cui la risorsa non è supportata da What-If.

WhatIfOperationResult

Risultato dell'operazione di What-If. Contiene un elenco di modifiche stimate e un collegamento URL per ottenere il set successivo di risultati.

Nome Tipo Descrizione
error

ErrorResponse

Risposta di errore
Errore quando l'operazione di What-If ha esito negativo.

properties.changes

WhatIfChange[]

Elenco delle modifiche delle risorse stimate dall'operazione di What-If.

status

string

Stato dell'operazione di What-If.

WhatIfPropertyChange

Modifica stimata alla proprietà della risorsa.

Nome Tipo Descrizione
after

object

Valore della proprietà dopo l'esecuzione della distribuzione.

before

object

Valore della proprietà prima dell'esecuzione della distribuzione.

children

WhatIfPropertyChange[]

Modifiche alle proprietà annidate.

path

string

Percorso della proprietà.

propertyChangeType

PropertyChangeType

Tipo di modifica della proprietà.

WhatIfResultFormat

Formato dei risultati What-If

Nome Tipo Descrizione
FullResourcePayloads

string

ResourceIdOnly

string