ARM-sablon üzembe helyezése what-if művelettel

  • Cikk

Az Azure Resource Manager-sablon (ARM-sablon) üzembe helyezése előtt megtekintheti a módosítások előnézetét. Az Azure Resource Manager biztosítja a lehetőségelemzési műveletet, hogy lássa, hogyan változnak az erőforrások a sablon üzembe helyezésekor. A what-if művelet nem módosít meglévő erőforrásokat. Ehelyett előre jelzi a megadott sablon üzembe helyezésével járó változásokat.

A what-if műveletet Azure PowerShell, Azure CLI- vagy REST API-műveletekkel is használhatja. A lehetőség az erőforráscsoport, az előfizetés, a felügyeleti csoport és a bérlői szintű üzemelő példányok esetében támogatott.

Képzési források

A lehetőségekkel kapcsolatos további információkért és gyakorlati útmutatásért lásd: Az Azure üzembehelyezési változásainak előnézete a what-if használatával.

Szükséges engedélyek

Bicep-fájl vagy ARM-sablon üzembe helyezéséhez írási joggal kell rendelkeznie az üzembe helyezett erőforrásokhoz, és hozzá kell férnie a Microsoft.Resources/deployments erőforrástípus összes műveletéhez. Egy virtuális gép üzembe helyezéséhez például szüksége van Microsoft.Compute/virtualMachines/write az engedélyekre és Microsoft.Resources/deployments/* az engedélyekre. A lehetőségelemzési műveletnek ugyanazok az engedélykövetelményei vannak.

A szerepkörök és engedélyek listáját megtalálja a Beépített Azure-szerepkörök című cikkben.

Lehetőségkorlátok

A lehetőség kibontja a beágyazott sablonokat, amíg el nem éri ezeket a korlátokat:

  • 500 beágyazott sablon.
  • 800 erőforráscsoport egy erőforráscsoport-alapú üzembe helyezésben.
  • A beágyazott sablonok kibontásához 5 perc szükséges.

Az egyik korlát elérésekor a fennmaradó erőforrások változástípusaFigyelmen kívül hagyás értékre van állítva.

Azure PowerShell modul telepítése

A PowerShellben a what-if használatához az Az modul 4.2-es vagy újabb verziójával kell rendelkeznie.

A modul telepítéséhez használja a következőt:

Install-Module -Name Az -Force

A modulok telepítésével kapcsolatos további információkért lásd: Azure PowerShell telepítése.

Az Azure CLI-modul telepítése

A lehetőség azure CLI-ben való használatához rendelkeznie kell az Azure CLI 2.14.0-s vagy újabb verziójával. Ha szükséges, telepítse az Azure CLI legújabb verzióját.

Eredmények megtekintése

Ha a PowerShellben vagy az Azure CLI-ben használja a what-if függvényt, a kimenet színkódolt eredményeket tartalmaz, amelyek segítenek a különböző típusú módosítások megtekintésében.

Képernyőkép Resource Manager sablon üzembe helyezésének lehetőségműveletéről teljes erőforrás-hasznos adatokkal és változástípusokkal.

A szöveges kimenet a következő:

Resource and property changes are indicated with these symbols:
  - Delete
  + Create
  ~ Modify

The deployment will update the following scope:

Scope: /subscriptions/./resourceGroups/ExampleGroup

  ~ Microsoft.Network/virtualNetworks/vnet-001 [2018-10-01]
    - tags.Owner: "Team A"
    ~ properties.addressSpace.addressPrefixes: [
      - 0: "10.0.0.0/16"
      + 0: "10.0.0.0/15"
      ]
    ~ properties.subnets: [
      - 0:

          name:                     "subnet001"
          properties.addressPrefix: "10.0.0.0/24"

      ]

Resource changes: 1 to modify.

Megjegyzés

A lehetőségelemzési művelet nem tudja feloldani a referenciafüggvényt. Minden alkalommal, amikor egy tulajdonságot sablonkifejezésre állít be, amely tartalmazza a referenciafüggvényt, a lehetőségjelentések a tulajdonságot módosítják. Ez a viselkedés azért fordul elő, mert a what-if függvény összehasonlítja a tulajdonság aktuális értékét (például true egy false logikai értéket) a megoldatlan sablonkifejezéssel. Nyilvánvaló, hogy ezek az értékek nem egyeznek. A sablon üzembe helyezésekor a tulajdonság csak akkor változik, ha a sablonkifejezés egy másik értékre oldódik fel.

What-if parancsok

Azure PowerShell

Ha sablon üzembe helyezése előtt szeretné megtekinteni a módosításokat, használja a New-AzResourceGroupDeployment vagy a New-AzSubscriptionDeployment parancsot. Adja hozzá a -Whatif kapcsolóparamétert az üzembe helyezési parancshoz.

  • New-AzResourceGroupDeployment -Whatif erőforráscsoport-üzemelő példányokhoz

  • New-AzSubscriptionDeployment -Whatif és New-AzDeployment -Whatif előfizetési szintű üzemelő példányok esetén

A kapcsolóparaméterrel -Confirm megtekintheti a módosításokat, és a rendszer kérni fogja, hogy folytassa az üzembe helyezést.

  • New-AzResourceGroupDeployment -Confirm erőforráscsoport-üzemelő példányokhoz
  • New-AzSubscriptionDeployment -Confirm és New-AzDeployment -Confirm előfizetési szintű üzemelő példányok esetén

Az előző parancsok szöveges összegzést adnak vissza, amelyet manuálisan is megvizsgálhat. Ha olyan objektumot szeretne lekérni, amelyet programozott módon vizsgálhat meg a módosításokhoz, használja a Get-AzResourceGroupDeploymentWhatIfResult vagy a Get-AzSubscriptionDeploymentWhatIfResult parancsot.

  • $results = Get-AzResourceGroupDeploymentWhatIfResult erőforráscsoport-üzemelő példányokhoz
  • $results = Get-AzSubscriptionDeploymentWhatIfResult vagy $results = Get-AzDeploymentWhatIfResult előfizetési szintű üzemelő példányokhoz

Azure CLI

Ha sablon üzembe helyezése előtt szeretné megtekinteni a módosításokat, használja a következőt:

--confirm-with-what-if A kapcsolóval (vagy annak rövid űrlapjával-c) megtekintheti a módosításokat, és a rendszer kérni fogja, hogy folytassa az üzembe helyezést. Adja hozzá ezt a kapcsolót a következőhöz:

Használhatja például vagy az deployment group create --confirm-with-what-if-c erőforráscsoport-üzemelő példányokhoz.

Az előző parancsok szöveges összegzést adnak vissza, amelyet manuálisan is megvizsgálhat. Ha olyan JSON-objektumot szeretne lekérni, amelyet programozott módon vizsgálhat meg, használja a kapcsolót --no-pretty-print . Használja például az deployment group what-if --no-pretty-print erőforráscsoport-üzemelő példányokhoz.

Ha színek nélkül szeretné visszaadni az eredményeket, nyissa meg az Azure CLI konfigurációs fájlját. Állítsa no_colorigen értékre.

Azure REST API

A REST API-hoz használja a következőt:

Változástípusok

A what-if művelet hét különböző típusú módosítást sorol fel:

  • Létrehozás: Az erőforrás jelenleg nem létezik, de a sablonban van definiálva. Az erőforrás létre lesz hozva.
  • Törlés: Ez a módosítástípus csak akkor érvényes, ha teljes módot használ az üzembe helyezéshez. Az erőforrás létezik, de nincs definiálva a sablonban. Teljes mód esetén az erőforrás törölve lesz. Ebben a változástípusban csak azokat az erőforrásokat tartalmazza, amelyek támogatják a teljes mód törlését .
  • Figyelmen kívül hagyás: Az erőforrás létezik, de nincs definiálva a sablonban. Az erőforrás nem lesz üzembe helyezve vagy módosítva. Amikor eléri a beágyazott sablonok kibontásának korlátait, ez a változástípus jelenik meg. Lásd: Lehetőségkorlátok.
  • NoChange: Az erőforrás létezik, és a sablonban van definiálva. Az erőforrás újra üzembe lesz helyezve, de az erőforrás tulajdonságai nem változnak. Ez a változástípus akkor lesz visszaadva, ha a ResultFormat értékre van állítva FullResourcePayloads, amely az alapértelmezett érték.
  • NoEffect: A tulajdonság készen áll, és a szolgáltatás figyelmen kívül hagyja. A tulajdonság például mindig úgy van beállítva, sku.tier hogy egyezzen sku.name a Microsoft.ServiceBus névtérben.
  • Módosítás: Az erőforrás létezik, és a sablonban van definiálva. Az erőforrás újra üzembe lesz helyezve és az erőforrás tulajdonságai megváltoznak. Ez a változástípus akkor lesz visszaadva, ha a ResultFormat értékre van állítva FullResourcePayloads, amely az alapértelmezett érték.
  • Üzembe helyezés: Az erőforrás létezik, és a sablonban van definiálva. Az erőforrás újra üzembe lesz helyezve. Az erőforrás tulajdonságai megváltozhatnak, de nem feltétlenül. A művelet akkor adja vissza ezt a változástípust, ha nem rendelkezik elég információval a tulajdonságok esetleges megváltozásának meghatározásához. Ez a feltétel csak akkor jelenik meg, ha a ResultFormat értéke ResourceIdOnly.

Az eredmény formátuma

Ön szabályozza az előrejelzett változásokról visszaadott részletességi szintet. Erre két lehetősége van:

  • FullResourcePayloads – a módosító erőforrások listáját és a módosító tulajdonságok részleteit adja vissza
  • ResourceIdOnly – a módosító erőforrások listáját adja vissza

Az alapértelmezett érték a FullResourcePayloads.

A PowerShell üzembehelyezési parancsaihoz használja a paramétert -WhatIfResultFormat . A programozott objektumparancsokban használja a paramétert ResultFormat .

Az Azure CLI-hez használja a paramétert --result-format .

Az alábbi eredmények a két különböző kimeneti formátumot mutatják:

  • Teljes erőforrás-hasznos adatok

    Resource and property changes are indicated with these symbols:
  - Delete
  + Create
  ~ Modify

The deployment will update the following scope:

Scope: /subscriptions/./resourceGroups/ExampleGroup

  ~ Microsoft.Network/virtualNetworks/vnet-001 [2018-10-01]
    - tags.Owner: "Team A"
    ~ properties.addressSpace.addressPrefixes: [
      - 0: "10.0.0.0/16"
      + 0: "10.0.0.0/15"
      ]
    ~ properties.subnets: [
      - 0:
        name:                     "subnet001"
        properties.addressPrefix: "10.0.0.0/24"

      ]

Resource changes: 1 to modify.

  • Csak erőforrás-azonosító

    Resource and property changes are indicated with this symbol:
  ! Deploy

The deployment will update the following scope:

Scope: /subscriptions/./resourceGroups/ExampleGroup

  ! Microsoft.Network/virtualNetworks/vnet-001

Resource changes: 1 to deploy.

Lehetőségelemzési művelet futtatása

Környezet beállítása

Ha meg szeretné tudni, hogyan működik a lehetőség, futtassunk néhány tesztet. Először helyezzen üzembe egy virtuális hálózatot létrehozó sablont. Ezzel a virtuális hálózattal tesztelheti, hogy a what-if hogyan jelenti a módosításokat.

New-AzResourceGroup `
  -Name ExampleGroup `
  -Location centralus
New-AzResourceGroupDeployment `
  -ResourceGroupName ExampleGroup `
  -TemplateUri "https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/what-if/what-if-before.json"

Tesztmódosítás

Az üzembe helyezés befejezése után készen áll a lehetőségelemzési művelet tesztelésére. Ezúttal üzembe helyez egy sablont, amely módosítja a virtuális hálózatot. Hiányzik egy eredeti címke, egy alhálózat el lett távolítva, és a címelőtag megváltozott.

New-AzResourceGroupDeployment `
  -Whatif `
  -ResourceGroupName ExampleGroup `
  -TemplateUri "https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/what-if/what-if-after.json"

A what-if kimenete a következőhöz hasonló:

Képernyőkép Resource Manager sablon üzembe helyezési lehetőségének kimenetéről, amelyen a módosítások láthatók.

A szöveges kimenet a következő:

Resource and property changes are indicated with these symbols:
  - Delete
  + Create
  ~ Modify

The deployment will update the following scope:

Scope: /subscriptions/./resourceGroups/ExampleGroup

  ~ Microsoft.Network/virtualNetworks/vnet-001 [2018-10-01]
    - tags.Owner: "Team A"
    ~ properties.addressSpace.addressPrefixes: [
      - 0: "10.0.0.0/16"
      + 0: "10.0.0.0/15"
      ]
    ~ properties.subnets: [
      - 0:

        name:                     "subnet001"
        properties.addressPrefix: "10.0.0.0/24"

      ]

Resource changes: 1 to modify.

Figyelje meg a kimenet tetején, hogy a színek a változások típusának jelzésére vannak definiálva.

A kimenet alján látható, hogy a Tulajdonos címke törölve lett. A címelőtag 10.0.0.0/16-ról 10.0.0.0/15-ösre változott. Az alhálózat001 nevű alhálózat törölve lett. Ne feledje, hogy ezek a módosítások nem lettek üzembe helyezve. A sablon üzembe helyezésekor megjelenő módosítások előnézete jelenik meg.

A töröltként felsorolt tulajdonságok némelyike valójában nem változik. A tulajdonságok helytelenül jelenthetők töröltként, ha nincsenek a sablonban, de az üzembe helyezés során automatikusan alapértelmezett értékként vannak beállítva. Ezt az eredményt "zajnak" tekintjük a what-if válaszban. A végső üzembe helyezett erőforrásban meg lesznek adva a tulajdonságok értékei. A lehetőségelemzési művelet érleltével ezek a tulajdonságok ki lesznek szűrve az eredményből.

A lehetőségelemzési eredmények programozott kiértékelése

Most a parancs változóra állításával programozott módon értékeljük ki a lehetőségelemzés eredményeit.

$results = Get-AzResourceGroupDeploymentWhatIfResult `
  -ResourceGroupName ExampleGroup `
  -TemplateUri "https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/what-if/what-if-after.json"

Az egyes módosítások összegzése látható.

foreach ($change in $results.Changes)
{
  $change.Delta
}

Törlés megerősítése

A lehetőségelemzési művelet támogatja az üzembe helyezési mód használatát. Ha befejezett módra van állítva, a sablonban nem szereplő erőforrások törlődnek. Az alábbi példa egy olyan sablont helyez üzembe, amely nem rendelkezik teljes módban definiált erőforrásokkal .

A változásoknak a sablon üzembe helyezése előtti áttekintéséhez használja a jóváhagyást kérő confirm kapcsolót az üzembe helyezési parancsban. Ha a módosítások a várt módon történnek, válaszoljon arra, hogy befejezze az üzembe helyezést.

New-AzResourceGroupDeployment `
  -ResourceGroupName ExampleGroup `
  -Mode Complete `
  -Confirm `
  -TemplateUri "https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/what-if/azuredeploy.json"

Mivel nincs definiálva erőforrás a sablonban, és az üzembe helyezési mód befejezettre van állítva, a virtuális hálózat törlődik.

Képernyőkép Resource Manager sablon üzembe helyezési lehetőségének kimenetéről üzembe helyezési módban.

A szöveges kimenet a következő:

Resource and property changes are indicated with this symbol:
  - Delete

The deployment will update the following scope:

Scope: /subscriptions/./resourceGroups/ExampleGroup

  - Microsoft.Network/virtualNetworks/vnet-001

      id:
"/subscriptions/./resourceGroups/ExampleGroup/providers/Microsoft.Network/virtualNet
works/vnet-001"
      location:        "centralus"
      name:            "vnet-001"
      tags.CostCenter: "12345"
      tags.Owner:      "Team A"
      type:            "Microsoft.Network/virtualNetworks"

Resource changes: 1 to delete.

Are you sure you want to execute the deployment?
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"):

Láthatja a várt módosításokat, és ellenőrizheti, hogy futtatni szeretné-e az üzembe helyezést.

SDK-k

A lehetőségelemzési műveletet az Azure SDK-kon keresztül használhatja.

Következő lépések