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 |
---|---|---|---|---|
deployment
|
path | True |
string |
Az üzembe helyezés neve. Reguláris kifejezési minta: |
resource
|
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: |
subscription
|
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 |
Az üzembehelyezési tulajdonságok. |
|
location |
string |
Az üzembehelyezési adatok tárolásának helye. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
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
|
|
Other Status Codes |
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 |
---|---|
Change |
Az erőforráson az üzembe helyezés végrehajtásakor végrehajtandó módosítás típusa. |
Cloud |
Hibaválasz egy erőforrás-kezelési kérelemhez. |
Debug |
A hibakeresési beállítás. |
Deployment |
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. |
Deployment |
Üzembe helyezési lehetőség műveleti paraméterei. |
Deployment |
Üzembe helyezési lehetőség tulajdonságai. |
Deployment |
Üzembe helyezési What-If műveleti beállítások. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
Hibaválasz |
Expression |
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. |
Expression |
A paraméterek, változók és függvények beágyazott sablonban való kiértékeléséhez használandó hatókör. |
On |
Üzembe helyezés hiba működés közben. |
On |
Az üzembe helyezés hibaviselkedési típuson. Lehetséges értékek: LastSuccessful és SpecificDeployment. |
Parameters |
Az üzembehelyezési paraméterekre mutató hivatkozást képviselő entitás. |
Property |
A tulajdonságváltozás típusa. |
Template |
A sablonra mutató hivatkozást képviselő entitás. |
What |
A What-If művelet által előrejelzett egyetlen erőforrás-változásra vonatkozó információk. |
What |
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. |
What |
Az erőforrástulajdonság előrejelzett változása. |
What |
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 |
Hibaválasz |
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 |
Az üzembehelyezési tulajdonságok. |
DeploymentWhatIfProperties
Üzembe helyezési lehetőség tulajdonságai.
Name | Típus | Description |
---|---|---|
debugSetting |
Az üzembe helyezés hibakeresési beállítása. |
|
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 |
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 |
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 |
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 |
A sablon URI-ja. Használja a templateLink tulajdonságot vagy a sablontulajdonságot, de mindkettőt nem. |
|
whatIfSettings |
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 |
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 |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
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 |
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 |
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 |
ParametersLink
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. |
TemplateLink
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 |
Az erőforráson az üzembe helyezés végrehajtásakor végrehajtandó módosítás típusa. |
|
delta |
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 |
Hibaválasz |
|
properties.changes |
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 |
A beágyazott tulajdonság megváltozik. |
|
path |
string |
A tulajdonság elérési útja. |
propertyChangeType |
A tulajdonságváltozás típusa. |
WhatIfResultFormat
A What-If eredmények formátuma
Name | Típus | Description |
---|---|---|
FullResourcePayloads |
string |
|
ResourceIdOnly |
string |