Megosztás a következőn keresztül:


Deployments - What If

Az üzembe helyezés által végrehajtott módosításokat adja vissza, ha azok az erőforráscsoport hatókörében lesznek végrehajtva.

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

URI-paraméterek

Name In Kötelező Típus Description
deploymentName
path True

string

Az üzembe helyezés neve.

Reguláris kifejezési minta: ^[-\w\._\(\)]+$

resourceGroupName
path True

string

Annak az erőforráscsoportnak a neve, amelybe a sablont üzembe helyezi. A név megkülönbözteti a kis- és nagybetűket.

Reguláris kifejezési minta: ^[-\w\._\(\)]+$

subscriptionId
path True

string

A Microsoft Azure-előfizetés azonosítója.

api-version
query True

string

A művelethez használandó API-verzió.

Kérelem törzse

Name Kötelező Típus Description
properties True

DeploymentWhatIfProperties

Az üzembehelyezési tulajdonságok.

location

string

Az üzembehelyezési adatok tárolásának helye.

Válaszok

Name Típus Description
200 OK

WhatIfOperationResult

OK – What-If művelet állapotát adja vissza

202 Accepted

Elfogadva – A Hely fejlécben található URL-címet adja vissza a hosszú ideig futó művelet állapotának lekérdezéséhez.

Fejlécek

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

CloudError

Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

Predict template changes at resource group scope

Mintakérelem

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

Mintaválasz

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

Definíciók

Name Description
ChangeType

Az erőforráson az üzembe helyezés végrehajtásakor végrehajtandó módosítás típusa.

CloudError

Hibaválasz egy erőforrás-kezelési kérelemhez.

DebugSetting

A hibakeresési beállítás.

DeploymentMode

Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő erőforráscsoportban lévő meglévő erőforrások törlődnek. Legyen óvatos a Teljes mód használata során, mivel előfordulhat, hogy véletlenül törli az erőforrásokat.

DeploymentWhatIf

Üzembe helyezési lehetőség műveleti paraméterei.

DeploymentWhatIfProperties

Üzembe helyezési lehetőség tulajdonságai.

DeploymentWhatIfSettings

Üzembe helyezési What-If műveleti beállítások.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

ErrorResponse

Hibaválasz

ExpressionEvaluationOptions

Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e.

ExpressionEvaluationOptionsScopeType

A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.

OnErrorDeployment

Üzembe helyezés hiba működés közben.

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

ParametersLink

Az üzembehelyezési paraméterekre mutató hivatkozást képviselő entitás.

PropertyChangeType

A tulajdonságváltozás típusa.

TemplateLink

A sablonra mutató hivatkozást képviselő entitás.

WhatIfChange

A What-If művelet által előrejelzett egyetlen erőforrás-változásra vonatkozó információk.

WhatIfOperationResult

A What-If művelet eredménye. Tartalmazza az előrejelzett változások listáját és egy URL-hivatkozást a következő eredményhalmaz eléréséhez.

WhatIfPropertyChange

Az erőforrástulajdonság előrejelzett változása.

WhatIfResultFormat

A What-If eredmények formátuma

ChangeType

Az erőforráson az üzembe helyezés végrehajtásakor végrehajtandó módosítás típusa.

Name Típus Description
Create

string

Az erőforrás nem létezik az aktuális állapotban, de a kívánt állapotban van. Az erőforrás az üzembe helyezés végrehajtásakor jön létre.

Delete

string

Az erőforrás az aktuális állapotban létezik, és hiányzik a kívánt állapotból. Az erőforrás az üzembe helyezés végrehajtásakor törlődik.

Deploy

string

Az erőforrás az aktuális állapotban és a kívánt állapotban van, és az üzembe helyezés végrehajtásakor újra üzembe helyezi. Az erőforrás tulajdonságai megváltozhatnak, de nem feltétlenül.

Ignore

string

Az erőforrás az aktuális állapotban létezik, és hiányzik a kívánt állapotból. Az erőforrás nem lesz üzembe helyezve vagy módosítva az üzembe helyezés végrehajtásakor.

Modify

string

Az erőforrás az aktuális állapotban és a kívánt állapotban van, és az üzembe helyezés végrehajtásakor újra üzembe lesz helyezve. Az erőforrás tulajdonságai megváltoznak.

NoChange

string

Az erőforrás az aktuális állapotban és a kívánt állapotban van, és az üzembe helyezés végrehajtásakor újra üzembe helyezi. Az erőforrás tulajdonságai nem változnak.

Unsupported

string

A What-If nem támogatja az erőforrást.

CloudError

Hibaválasz egy erőforrás-kezelési kérelemhez.

Name Típus Description
error

ErrorResponse

Hibaválasz
Az összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

DebugSetting

A hibakeresési beállítás.

Name Típus Description
detailLevel

string

Megadja a hibakereséshez naplózandó információk típusát. Az engedélyezett értékek: requestContent, responseContent vagy requestContent és responseContent vesszővel elválasztva. Az alapértelmezett érték a none. Az érték beállításakor gondosan vegye figyelembe, hogy milyen típusú információkat ad át az üzembe helyezés során. A kéréssel vagy válaszsal kapcsolatos információk naplózásával potenciálisan bizalmas adatokat tehet közzé, amelyeket az üzembehelyezési műveletek során kérnek le.

DeploymentMode

Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő erőforráscsoportban lévő meglévő erőforrások törlődnek. Legyen óvatos a Teljes mód használata során, mivel előfordulhat, hogy véletlenül törli az erőforrásokat.

Name Típus Description
Complete

string

Incremental

string

DeploymentWhatIf

Üzembe helyezési lehetőség műveleti paraméterei.

Name Típus Description
location

string

Az üzembehelyezési adatok tárolásának helye.

properties

DeploymentWhatIfProperties

Az üzembehelyezési tulajdonságok.

DeploymentWhatIfProperties

Üzembe helyezési lehetőség tulajdonságai.

Name Típus Description
debugSetting

DebugSetting

Az üzembe helyezés hibakeresési beállítása.

expressionEvaluationOptions

ExpressionEvaluationOptions

Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e. Csak beágyazott sablonokra alkalmazható. Ha nincs megadva, az alapértelmezett érték külső.

mode

DeploymentMode

Az erőforrások üzembe helyezéséhez használt mód. Ez az érték növekményes vagy befejezett lehet. Növekményes módban az erőforrások a sablonban nem szereplő meglévő erőforrások törlése nélkül lesznek üzembe helyezve. Teljes módban az erőforrások üzembe lesznek helyezve, és a sablonban nem szereplő erőforráscsoportban lévő meglévő erőforrások törlődnek. Legyen óvatos a Teljes mód használata során, mivel előfordulhat, hogy véletlenül törli az erőforrásokat.

onErrorDeployment

OnErrorDeployment

A hiba működésével kapcsolatos üzembe helyezés.

parameters

object

Név- és értékpárok, amelyek meghatározzák a sablon üzembehelyezési paramétereit. Ezt az elemet akkor használja, ha közvetlenül a kérelemben szeretné megadni a paraméterértékeket, nem pedig egy meglévő paraméterfájlra mutató hivatkozást. Használja a parametersLink tulajdonságot vagy a parameters tulajdonságot, de mindkettőt nem. Ez lehet JObject vagy jól formázott JSON-sztring.

parametersLink

ParametersLink

A paraméterfájl URI-ja. Ezzel az elemel hivatkozhat egy meglévő paraméterfájlra. Használja a parametersLink tulajdonságot vagy a parameters tulajdonságot, de mindkettőt nem.

template

object

A sablon tartalma. Ezt az elemet akkor használja, ha a sablon szintaxisát közvetlenül a kérelemben szeretné átadni, nem pedig egy meglévő sablonra mutató hivatkozást. Ez lehet JObject vagy jól formázott JSON-sztring. Használja a templateLink tulajdonságot vagy a sablontulajdonságot, de mindkettőt nem.

templateLink

TemplateLink

A sablon URI-ja. Használja a templateLink tulajdonságot vagy a sablontulajdonságot, de mindkettőt nem.

whatIfSettings

DeploymentWhatIfSettings

Nem kötelező What-If műveleti beállítások.

DeploymentWhatIfSettings

Üzembe helyezési What-If műveleti beállítások.

Name Típus Description
resultFormat

WhatIfResultFormat

A What-If eredmények formátuma

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name Típus Description
info

object

A további információk.

type

string

A további információtípus.

ErrorResponse

Hibaválasz

Name Típus Description
additionalInfo

ErrorAdditionalInfo[]

A hiba további információi.

code

string

A hibakód.

details

ErrorResponse[]

A hiba részletei.

message

string

A hibaüzenet.

target

string

A hibacél.

ExpressionEvaluationOptions

Meghatározza, hogy a sablonkifejezések kiértékelése a szülősablon vagy a beágyazott sablon hatókörén belül történik-e.

Name Típus Description
scope

ExpressionEvaluationOptionsScopeType

A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.

ExpressionEvaluationOptionsScopeType

A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör.

Name Típus Description
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Üzembe helyezés hiba működés közben.

Name Típus Description
deploymentName

string

A hibaesetben használni kívánt üzembe helyezés.

type

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

OnErrorDeploymentType

Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment.

Name Típus Description
LastSuccessful

string

SpecificDeployment

string

Az üzembehelyezési paraméterekre mutató hivatkozást képviselő entitás.

Name Típus Description
contentVersion

string

Ha szerepel a fájlban, meg kell egyeznie a sablon ContentVersion elemével.

uri

string

A paraméterfájl URI-ja.

PropertyChangeType

A tulajdonságváltozás típusa.

Name Típus Description
Array

string

A tulajdonság egy tömb, és beágyazott módosításokat tartalmaz.

Create

string

A tulajdonság nem létezik az aktuális állapotban, de a kívánt állapotban van. A tulajdonság az üzembe helyezés végrehajtásakor jön létre.

Delete

string

A tulajdonság az aktuális állapotban van, és hiányzik a kívánt állapotból. Az üzembe helyezés végrehajtásakor a rendszer törli.

Modify

string

A tulajdonság a jelenlegi és a kívánt állapotban is létezik, és különbözik. A tulajdonság értéke az üzembe helyezés végrehajtásakor megváltozik.

NoEffect

string

A tulajdonság nem lesz beállítva vagy frissítve.

A sablonra mutató hivatkozást képviselő entitás.

Name Típus Description
contentVersion

string

Ha szerepel a fájlban, meg kell egyeznie a sablon ContentVersion elemével.

id

string

Egy sablonspecifikáció erőforrás-azonosítója. Használja az id vagy az uri tulajdonságot, de mindkettőt nem.

queryString

string

A templateLink URI-val használandó lekérdezési sztring (például SAS-jogkivonat).

relativePath

string

A relativePath tulajdonság használatával a szülőhöz viszonyított helyen helyezhet üzembe csatolt sablont. Ha a szülősablon egy TemplateSpec elemhez lett csatolva, az a TemplateSpec elemére fog hivatkozni. Ha a szülő URI-val lett összekapcsolva, a gyermek üzembe helyezése a szülő és a relatívPath URI-k kombinációja lesz

uri

string

Az üzembe helyezendő sablon URI-ja. Használja az uri vagy az id tulajdonságot, de mindkettőt nem.

WhatIfChange

A What-If művelet által előrejelzett egyetlen erőforrás-változásra vonatkozó információk.

Name Típus Description
after

object

Az erőforrás előrejelzett pillanatképe az üzembe helyezés végrehajtása után.

before

object

Az erőforrás pillanatképe az üzembe helyezés végrehajtása előtt.

changeType

ChangeType

Az erőforráson az üzembe helyezés végrehajtásakor végrehajtandó módosítás típusa.

delta

WhatIfPropertyChange[]

Az erőforrás tulajdonságainak előrejelzett változásai.

resourceId

string

Erőforrás-azonosító

unsupportedReason

string

Annak magyarázata, hogy miért nem támogatja az erőforrást a What-If.

WhatIfOperationResult

A What-If művelet eredménye. Tartalmazza az előrejelzett változások listáját és egy URL-hivatkozást a következő eredményhalmaz eléréséhez.

Name Típus Description
error

ErrorResponse

Hibaválasz
Hiba What-If művelet meghiúsulásakor.

properties.changes

WhatIfChange[]

A What-If művelet által előrejelzett erőforrásváltozások listája.

status

string

A What-If művelet állapota.

WhatIfPropertyChange

Az erőforrástulajdonság előrejelzett változása.

Name Típus Description
after

object

A tulajdonság értéke az üzembe helyezés végrehajtása után.

before

object

A tulajdonság értéke az üzembe helyezés végrehajtása előtt.

children

WhatIfPropertyChange[]

A beágyazott tulajdonság megváltozik.

path

string

A tulajdonság elérési útja.

propertyChangeType

PropertyChangeType

A tulajdonságváltozás típusa.

WhatIfResultFormat

A What-If eredmények formátuma

Name Típus Description
FullResourcePayloads

string

ResourceIdOnly

string