Dela via


Deployments - What If At Subscription Scope

Returnerar ändringar som kommer att göras av distributionen om de körs i prenumerationens omfång.

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

URI-parametrar

Name I Obligatorisk Typ Description
deploymentName
path True

string

Namnet på distributionen.

Reguljärt uttrycksmönster: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Prenumerations-ID för Microsoft Azure.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
properties True

DeploymentWhatIfProperties

Distributionsegenskaperna.

location

string

Platsen där distributionsdata ska lagras.

Svar

Name Typ Description
200 OK

WhatIfOperationResult

OK – Returnerar What-If åtgärdsstatus

202 Accepted

Accepted – returnerar URL:en i platsrubriken för att fråga efter långvarig åtgärdsstatus.

Sidhuvuden

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

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Predict template changes at subscription scope

Exempelbegäran

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"
  }
}

Exempelsvar

{
  "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

Definitioner

Name Description
ChangeType

Typ av ändring som görs i resursen när distributionen körs.

CloudError

Ett felsvar för en resurshanteringsbegäran.

DebugSetting

Felsökningsinställningen.

DeploymentMode

Det läge som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder fullständigt läge eftersom du oavsiktligt kan ta bort resurser.

DeploymentWhatIf

Distribution Konsekvensparametrar.

DeploymentWhatIfProperties

Distribution Konsekvensegenskaper.

DeploymentWhatIfSettings

Inställningar för distribution What-If åtgärder.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorResponse

Felsvar

ExpressionEvaluationOptions

Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen.

ExpressionEvaluationOptionsScopeType

Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.

OnErrorDeployment

Distribution av felbeteende.

OnErrorDeploymentType

Distributionen av felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

ParametersLink

Entitet som representerar referensen till distributionsparametrarna.

PropertyChangeType

Typ av egenskapsändring.

TemplateLink

Entitet som representerar referensen till mallen.

WhatIfChange

Information om en enskild resursändring som förutsägs av What-If åtgärd.

WhatIfOperationResult

Resultatet av den What-If åtgärden. Innehåller en lista över förutsagda ändringar och en URL-länk för att komma till nästa uppsättning resultat.

WhatIfPropertyChange

Den förutsagda ändringen av resursegenskapen.

WhatIfResultFormat

Formatet på What-If resultat

ChangeType

Typ av ändring som görs i resursen när distributionen körs.

Name Typ Description
Create

string

Resursen finns inte i det aktuella tillståndet men finns i önskat tillstånd. Resursen skapas när distributionen körs.

Delete

string

Resursen finns i det aktuella tillståndet och saknas i önskat tillstånd. Resursen tas bort när distributionen körs.

Deploy

string

Resursen finns i aktuellt tillstånd och önskat tillstånd och distribueras om när distributionen körs. Egenskaperna för resursen ändras eventuellt.

Ignore

string

Resursen finns i det aktuella tillståndet och saknas i önskat tillstånd. Resursen kommer inte att distribueras eller ändras när distributionen körs.

Modify

string

Resursen finns i aktuellt tillstånd och önskat tillstånd och distribueras om när distributionen körs. Egenskaperna för resursen ändras.

NoChange

string

Resursen finns i aktuellt tillstånd och önskat tillstånd och distribueras om när distributionen körs. Resursens egenskaper ändras inte.

Unsupported

string

Resursen stöds inte av Konsekvens.

CloudError

Ett felsvar för en resurshanteringsbegäran.

Name Typ Description
error

ErrorResponse

Felsvar
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.)

DebugSetting

Felsökningsinställningen.

Name Typ Description
detailLevel

string

Anger vilken typ av information som ska loggas för felsökning. De tillåtna värdena är none, requestContent, responseContent eller både requestContent och responseContent avgränsade med ett kommatecken. Standardvärdet är none. När du anger det här värdet bör du noga överväga vilken typ av information du skickar in under distributionen. Genom att logga information om begäran eller svaret kan du potentiellt exponera känsliga data som hämtas via distributionsåtgärderna.

DeploymentMode

Det läge som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder fullständigt läge eftersom du oavsiktligt kan ta bort resurser.

Name Typ Description
Complete

string

Incremental

string

DeploymentWhatIf

Distribution Konsekvensparametrar.

Name Typ Description
location

string

Platsen där distributionsdata ska lagras.

properties

DeploymentWhatIfProperties

Distributionsegenskaperna.

DeploymentWhatIfProperties

Distribution Konsekvensegenskaper.

Name Typ Description
debugSetting

DebugSetting

Felsökningsinställningen för distributionen.

expressionEvaluationOptions

ExpressionEvaluationOptions

Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen. Gäller endast för kapslade mallar. Om det inte anges är standardvärdet yttre.

mode

DeploymentMode

Det läge som används för att distribuera resurser. Det här värdet kan vara antingen Inkrementellt eller Slutfört. I inkrementellt läge distribueras resurser utan att befintliga resurser som inte ingår i mallen tas bort. I fullständigt läge distribueras resurser och befintliga resurser i resursgruppen som inte ingår i mallen tas bort. Var försiktig när du använder fullständigt läge eftersom du oavsiktligt kan ta bort resurser.

onErrorDeployment

OnErrorDeployment

Distributionen av felbeteende.

parameters

object

Namn- och värdepar som definierar distributionsparametrarna för mallen. Du använder det här elementet när du vill ange parametervärdena direkt i begäran i stället för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda. Det kan vara en JObject- eller en välformulerad JSON-sträng.

parametersLink

ParametersLink

URI för parameterfilen. Du använder det här elementet för att länka till en befintlig parameterfil. Använd antingen egenskapen parametersLink eller parameteregenskapen, men inte båda.

template

object

Mallinnehållet. Du använder det här elementet när du vill skicka mallsyntaxen direkt i begäran i stället för att länka till en befintlig mall. Det kan vara en JObject- eller välformulerad JSON-sträng. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.

templateLink

TemplateLink

Mallens URI. Använd antingen egenskapen templateLink eller mallegenskapen, men inte båda.

whatIfSettings

DeploymentWhatIfSettings

Valfria What-If åtgärdsinställningar.

DeploymentWhatIfSettings

Inställningar för distribution What-If åtgärder.

Name Typ Description
resultFormat

WhatIfResultFormat

Formatet på What-If resultat

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorResponse

Felsvar

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorResponse[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ExpressionEvaluationOptions

Anger om malluttryck utvärderas inom omfånget för den överordnade mallen eller den kapslade mallen.

Name Typ Description
scope

ExpressionEvaluationOptionsScopeType

Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.

ExpressionEvaluationOptionsScopeType

Det omfång som ska användas för utvärdering av parametrar, variabler och funktioner i en kapslad mall.

Name Typ Description
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Distribution av felbeteende.

Name Typ Description
deploymentName

string

Distributionen som ska användas i ett felfall.

type

OnErrorDeploymentType

Distributionen av felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

OnErrorDeploymentType

Distributionen av felbeteendetypen. Möjliga värden är LastSuccessful och SpecificDeployment.

Name Typ Description
LastSuccessful

string

SpecificDeployment

string

Entitet som representerar referensen till distributionsparametrarna.

Name Typ Description
contentVersion

string

Om den ingår måste den matcha ContentVersion i mallen.

uri

string

URI för parameterfilen.

PropertyChangeType

Typ av egenskapsändring.

Name Typ Description
Array

string

Egenskapen är en matris och innehåller kapslade ändringar.

Create

string

Egenskapen finns inte i det aktuella tillståndet men finns i önskat tillstånd. Egenskapen skapas när distributionen körs.

Delete

string

Egenskapen finns i det aktuella tillståndet och saknas i önskat tillstånd. Den tas bort när distributionen körs.

Modify

string

Egenskapen finns i både aktuellt och önskat tillstånd och är annorlunda. Värdet för egenskapen ändras när distributionen körs.

NoEffect

string

Egenskapen kommer inte att anges eller uppdateras.

Entitet som representerar referensen till mallen.

Name Typ Description
contentVersion

string

Om den ingår måste den matcha ContentVersion i mallen.

id

string

Resurs-ID:t för en mallspecifikation. Använd antingen ID- eller URI-egenskapen, men inte båda.

queryString

string

Frågesträngen (till exempel en SAS-token) som ska användas med templateLink-URI:n.

relativePath

string

Egenskapen relativePath kan användas för att distribuera en länkad mall på en plats i förhållande till den överordnade. Om den överordnade mallen var länkad till en TemplateSpec refererar detta till en artefakt i TemplateSpec. Om den överordnade var länkad med en URI är den underordnade distributionen en kombination av de överordnade och relativePath-URI:erna

uri

string

URI:n för mallen som ska distribueras. Använd antingen egenskapen URI eller ID, men inte båda.

WhatIfChange

Information om en enskild resursändring som förutsägs av What-If åtgärd.

Name Typ Description
after

object

Den förutsagda ögonblicksbilden av resursen efter att distributionen har körts.

before

object

Ögonblicksbilden av resursen innan distributionen körs.

changeType

ChangeType

Typ av ändring som görs i resursen när distributionen körs.

delta

WhatIfPropertyChange[]

De förutsagda ändringarna av resursegenskaper.

resourceId

string

Resurs-ID

unsupportedReason

string

Förklaringen till varför resursen inte stöds av Konsekvens.

WhatIfOperationResult

Resultatet av den What-If åtgärden. Innehåller en lista över förutsagda ändringar och en URL-länk för att komma till nästa uppsättning resultat.

Name Typ Description
error

ErrorResponse

Felsvar
Fel när What-If åtgärden misslyckas.

properties.changes

WhatIfChange[]

Lista över resursändringar som förutsägs av What-If åtgärden.

status

string

Status för åtgärden What-If.

WhatIfPropertyChange

Den förutsagda ändringen av resursegenskapen.

Name Typ Description
after

object

Värdet för egenskapen efter att distributionen har körts.

before

object

Värdet för egenskapen innan distributionen körs.

children

WhatIfPropertyChange[]

Kapslade egenskapsändringar.

path

string

Sökvägen till egenskapen .

propertyChangeType

PropertyChangeType

Typ av egenskapsändring.

WhatIfResultFormat

Formatet på What-If resultat

Name Typ Description
FullResourcePayloads

string

ResourceIdOnly

string