Deployments - What If At Management Group Scope
Az üzembe helyezés által végrehajtott módosításokat adja vissza, ha azok a felügyeleti csoport hatókörében lesznek végrehajtva.
POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/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. Regex pattern: |
group
|
path | True |
string |
A felügyeleti csoport 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 |
---|---|---|---|
location | True |
string |
Az üzembehelyezési adatok tárolásának helye. |
properties | True |
Az üzembehelyezési tulajdonságok. |
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. Headers
|
|
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
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
Predict template changes at management group scope
Sample Request
POST https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGruop/providers/Microsoft.Resources/deployments/exampleDeploymentName/whatIf?api-version=2021-04-01
{
"location": "eastus",
"properties": {
"templateLink": {
"uri": "https://example.com/exampleTemplate.json"
},
"parameters": {},
"mode": "Incremental"
}
}
Sample Response
{
"status": "Succeeded",
"properties": {
"changes": [
{
"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"changeType": "Modify",
"before": {
"apiVersion": "2019-06-01",
"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"type": "Microsoft.Authorization/policyAssignments",
"name": "myPolicyAssignment",
"location": "westus2",
"properties": {
"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
"scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
"enforcementMode": "Default"
}
},
"after": {
"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"changeType": "Modify",
"before": {
"apiVersion": "2019-06-01",
"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment",
"type": "Microsoft.Authorization/policyAssignments",
"name": "myPolicyAssignment",
"location": "westus2",
"properties": {
"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
"scope": "/subscriptions/00000000-0000-0000-0000-000000000001",
"enforcementMode": "DoNotEnforce"
}
},
"delta": [
{
"path": "properties.enforcementMode",
"propertyChangeType": "Modify",
"before": "Default",
"after": "DoNotEnforce"
}
]
}
},
{
"resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
"changeType": "Create",
"after": {
"apiVersion": "2019-06-01",
"id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2",
"type": "Microsoft.Authorization/policyAssignments",
"name": "myPolicyAssignment2",
"location": "westus2",
"properties": {
"policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition",
"scope": "/subscriptions/00000000-0000-0000-0000-000000000002",
"enforcementMode": "Default"
}
}
}
]
}
}
Location: /subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/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éréshez. |
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 üzembe helyezése a sablonban nem szereplő meglévő erőforrások törlése nélkül történik. Teljes módban az erőforrások üzembe helyezése és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportban. Legyen óvatos a Teljes mód használatakor, mert előfordulhat, hogy véletlenül törli az erőforrásokat. |
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 hibaviselkedés esetén. |
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 jelölő entitás. |
Property |
A tulajdonságváltozás típusa. |
Scoped |
Üzembehelyezési lehetőség műveleti paraméterei. |
Template |
A sablonra mutató hivatkozást képviselő entitás. |
What |
Az What-If művelet által előrejelzett egyetlen erőforrás-változással kapcsolatos információk. |
What |
A What-If művelet eredménye. Az előrejelzett módosítások listáját és egy URL-hivatkozást tartalmaz a következő eredménykészlet 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 van, é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 lesz helyezve. Az erőforrás tulajdonságai megváltozhatnak, de nem feltétlenül. |
Ignore |
string |
Az erőforrás az aktuális állapotban van, é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 lesz helyezve. 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éréshez.
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 a következők: requestContent, responseContent, vagy requestContent és responseContent is, vesszővel elválasztva. Az alapértelmezett érték a none. Ennek az értéknek a beállításakor alaposan gondolja át, 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 közzéteheti az üzembehelyezési műveletek során lekért bizalmas adatokat. |
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 üzembe helyezése a sablonban nem szereplő meglévő erőforrások törlése nélkül történik. Teljes módban az erőforrások üzembe helyezése és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportban. Legyen óvatos a Teljes mód használatakor, mert előfordulhat, hogy véletlenül törli az erőforrásokat.
Name | Típus | Description |
---|---|---|
Complete |
string |
|
Incremental |
string |
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 üzembe helyezése a sablonban nem szereplő meglévő erőforrások törlése nélkül történik. Teljes módban az erőforrások üzembe helyezése és a sablonban nem szereplő meglévő erőforrások törlődnek az erőforráscsoportban. Legyen óvatos a Teljes mód használatakor, mert előfordulhat, hogy véletlenül törli az erőforrásokat. |
|
onErrorDeployment |
Az üzembe helyezés hibaviselkedés esetén. |
|
parameters |
object |
A sablon üzembehelyezési paramétereit meghatározó név- és értékpárok. 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 elemmel 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 adattí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 hiba célja. |
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 hibaviselkedés esetén.
Name | Típus | Description |
---|---|---|
deploymentName |
string |
A hibaesetben használandó ü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 jelölő entitás.
Name | Típus | Description |
---|---|---|
contentVersion |
string |
Ha szerepel benne, akkor 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. |
ScopedDeploymentWhatIf
Üzembehelyezé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. |
TemplateLink
A sablonra mutató hivatkozást képviselő entitás.
Name | Típus | Description |
---|---|---|
contentVersion |
string |
Ha szerepel benne, akkor 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 egy csatolt sablont helyezhet üzembe a szülőhöz képest egy helyen. Ha a szülősablont egy TemplateSpec elemhez csatolták, az a TemplateSpec egyik összetevőjére fog hivatkozni. Ha a szülő URI-val lett összekapcsolva, a gyermektelepítés a szülő és a relatívPath URI-k kombinációja lesz |
uri |
string |
Az üzembe helyezni kívánt sablon URI-ja. Használja az URI vagy az id tulajdonságot, de mindkettőt nem. |
WhatIfChange
Az What-If művelet által előrejelzett egyetlen erőforrás-változással kapcsolatos 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ágok előrejelzett változásai. |
|
resourceId |
string |
Erőforrás-azonosító |
unsupportedReason |
string |
Annak magyarázata, hogy a What-If miért nem támogatja az erőforrást. |
WhatIfOperationResult
A What-If művelet eredménye. Az előrejelzett módosítások listáját és egy URL-hivatkozást tartalmaz a következő eredménykészlet 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 |