ARM template deployment what-if operation (Wat-als-bewerking bij het implementeren van ARM-sjablonen)

Artikel
09/28/2021
8 minuten om te lezen

Voordat u een Azure Resource Manager (ARM-sjabloon) implementeert, kunt u een voorbeeld bekijken van de wijzigingen die zullen plaatsvinden. Azure Resource Manager biedt de what-if-bewerking om u te laten zien hoe resources veranderen als u de sjabloon implementeert. Met de 'wat-als'-bewerking worden er geen wijzigingen doorgevoerd voor bestaande resources. In plaats daarvan worden de wijzigingen voorspeld, mocht de opgegeven sjabloon worden geïmplementeerd.

U kunt de what-if-bewerking gebruiken met Azure PowerShell-, Azure CLI- of REST API bewerkingen. Wat-als wordt ondersteund voor implementaties op resourcegroep-, abonnements-, beheergroep- en tenantniveau.

Microsoft Learn

Zie Preview azure deployment changes by using what-if on Microsoft Learn (Preview azure deployment changes by using what-if on Microsoft Learn (Preview azure deployment changes by using what-if on Microsoft Learn.

De Azure PowerShell installeren

Als u what-if wilt gebruiken in PowerShell, moet u versie 4.2 of hoger van de Az-module hebben.

Als u de module wilt installeren, gebruikt u:

Install-Module -Name Az -Force

Zie Install Azure PowerShell voor meer informatie over het installeren Azure PowerShell.

Azure CLI-module installeren

Als u what-if wilt gebruiken in Azure CLI, moet u Azure CLI 2.14.0 of hoger hebben. Installeer indien nodig de meest recente versie van Azure CLI.

Resultaten bekijken

Wanneer u what-if gebruikt in PowerShell of Azure CLI, bevat de uitvoer resultaten met kleurcode die u helpen de verschillende typen wijzigingen te zien.

Resource Manager-sjabloonimplementatie what-if-bewerking fullresourcepayload en wijzigingstypen

De tekstuitvoer is:

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.

Notitie

De what-if-bewerking kan de verwijzingsfunctie niet oplossen. Telkens wanneer u een eigenschap in stelt op een sjabloonexpressie die de referentiefunctie bevat, verandert de eigenschap in what-if-rapporten. Dit gedrag teert omdat what-if de huidige waarde van de eigenschap (zoals of voor een Booleaanse waarde) vergelijkt met de niet-opgeloste true false sjabloonexpressie. Deze waarden komen natuurlijk niet overeen. Wanneer u de sjabloon implementeert, verandert de eigenschap alleen wanneer de sjabloonexpressie wordt omgeslagen in een andere waarde.

What-if-opdrachten

Azure PowerShell

Als u een voorbeeld van wijzigingen wilt bekijken voordat u een sjabloon implementeert, gebruikt u New-AzResourceGroupDeployment of New-AzSubscriptionDeployment. Voeg de -Whatif schakelparameter toe aan de implementatieopdracht.

New-AzResourceGroupDeployment -Whatif voor resourcegroepimplementaties
New-AzSubscriptionDeployment -Whatif en New-AzDeployment -Whatif voor implementaties op abonnementsniveau

U kunt de -Confirm schakelparameter gebruiken om een voorbeeld van de wijzigingen te bekijken en wordt gevraagd om door te gaan met de implementatie.

New-AzResourceGroupDeployment -Confirm voor resourcegroepimplementaties
New-AzSubscriptionDeployment -Confirm en New-AzDeployment -Confirm voor implementaties op abonnementsniveau

De voorgaande opdrachten retourneren een tekstsamenvatting die u handmatig kunt inspecteren. Gebruik Get-AzResourceGroupDeploymentWhatIfResult of Get-AzSubscriptionDeploymentWhatIfResultom een object op te halen dat u programmatisch kunt inspecteren op wijzigingen.

$results = Get-AzResourceGroupDeploymentWhatIfResult voor resourcegroepimplementaties
$results = Get-AzSubscriptionDeploymentWhatIfResult of $results = Get-AzDeploymentWhatIfResult voor implementaties op abonnementsniveau

Azure CLI

Als u een voorbeeld van wijzigingen wilt bekijken voordat u een sjabloon implementeert, gebruikt u:

az deployment group what-if voor resourcegroepimplementaties
az deployment sub what-if voor implementaties op abonnementsniveau
az deployment mg what-if voor implementaties van beheergroep
az deployment tenant what-if voor tenantimplementaties

U kunt de switch (of de korte vorm ) gebruiken om een voorbeeld van de wijzigingen te bekijken en wordt gevraagd om door te --confirm-with-what-if -c gaan met de implementatie. Voeg deze schakelknop toe aan:

Gebruik bijvoorbeeld az deployment group create --confirm-with-what-if of voor -c implementaties van resourcegroep.

De voorgaande opdrachten retourneren een tekstsamenvatting die u handmatig kunt inspecteren. Gebruik de schakelknop om een JSON-object op te halen dat u programmatisch kunt controleren op --no-pretty-print wijzigingen. Gebruik bijvoorbeeld voor az deployment group what-if --no-pretty-print implementaties van resourcegroep.

Als u de resultaten zonder kleuren wilt retourneren, opent u uw Azure CLI-configuratiebestand. Stel no_color in op ja.

Azure REST API

Gebruik REST API voor meer informatie:

Implementaties: What If voor resourcegroepimplementaties
Implementaties: What If op abonnementsbereik voor abonnementsimplementaties
Implementaties : What If het bereik van beheergroep voor implementaties van beheergroep
Implementaties: What If tenantbereik voor tenantimplementaties.

Wijzigingstypen

De what-if-bewerking bevat zes verschillende typen wijzigingen:

Maken: de resource bestaat momenteel niet, maar is gedefinieerd in de sjabloon. De resource wordt gemaakt.
Verwijderen: dit wijzigingstype is alleen van toepassing wanneer de volledige modus voor implementatie wordt gebruikt. De resource bestaat, maar wordt niet gedefinieerd in de sjabloon. Met de volledige modus wordt de resource verwijderd. Alleen resources die ondersteuning bieden voor het verwijderen van de volledige modus zijn opgenomen in dit wijzigingstype.
Negeren: de resource bestaat wel, maar is niet gedefinieerd in de sjabloon. De resource wordt niet geïmplementeerd of gewijzigd.
NoChange: de resource bestaat en wordt gedefinieerd in de sjabloon. De resource wordt opnieuw geïmplementeerd, maar de eigenschappen van de resource worden niet gewijzigd. Dit wijzigingstype wordt geretourneerd wanneer ResultFormat is ingesteld op FullResourcePayloads . Dit is de standaardwaarde.
Wijzigen: de resource bestaat en wordt gedefinieerd in de sjabloon. De resource wordt opnieuw geïmplementeerd en de eigenschappen van de resource worden gewijzigd. Dit wijzigingstype wordt geretourneerd wanneer ResultFormat is ingesteld op FullResourcePayloads . Dit is de standaardwaarde.
Implementeren: de resource bestaat en wordt gedefinieerd in de sjabloon. De resource wordt opnieuw geïmplementeerd. De eigenschappen van de resource worden mogelijk wel of niet gewijzigd. De bewerking retourneert dit wijzigingstype wanneer er niet genoeg informatie is om te bepalen of eigenschappen worden gewijzigd. U ziet deze voorwaarde alleen wanneer ResultFormat is ingesteld op ResourceIdOnly .

Resultaatopmaak

U kunt het detailniveau bepalen dat wordt geretourneerd over de voorspelde wijzigingen. U hebt hiervoor twee opties:

FullResourcePayloads: retourneert een lijst met resources die worden gewijzigd en details over de eigenschappen die worden gewijzigd
ResourceIdOnly: retourneert een lijst met resources die worden gewijzigd

De standaardwaarde is FullResourcePayloads.

Gebruik voor PowerShell-implementatieopdrachten de -WhatIfResultFormat parameter . Gebruik in de programmatische objectopdrachten de ResultFormat parameter .

Gebruik voor Azure CLI de --result-format parameter .

De volgende resultaten tonen de twee verschillende uitvoerindelingen:

Volledige nettoladingen van resources

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.

Alleen resource-id

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.

What-if-bewerking uitvoeren

Omgeving instellen

Om te zien hoe what-if werkt, gaan we een aantal tests uitvoeren. Implementeer eerst een sjabloon die een virtueel netwerk maakt. U gebruikt dit virtuele netwerk om te testen hoe wijzigingen worden gerapporteerd door what-if.

PowerShell
Azure-CLI

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"

az group create \
  --name ExampleGroup \
  --location "Central US"
az deployment group create \
  --resource-group ExampleGroup \
  --template-uri "https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/what-if/what-if-before.json"

Testaanpassingen

Nadat de implementatie is voltooid, kunt u de what-if-bewerking testen. Deze keer implementeert u een sjabloon die het virtuele netwerk wijzigt. Er ontbreekt een van de oorspronkelijke tags, er is een subnet verwijderd en het adres voorvoegsel is gewijzigd.

PowerShell
Azure-CLI

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"

az deployment group what-if \
  --resource-group ExampleGroup \
  --template-uri "https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/what-if/what-if-after.json"

De wat-als-uitvoer lijkt op het volgende:

Resource Manager wat-als-bewerkingsuitvoer voor sjabloonimplementatie

De tekstuitvoer is:

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.

Boven aan de uitvoer ziet u dat kleuren zijn gedefinieerd om het type wijzigingen aan te geven.

Onderaan de uitvoer ziet u dat de tag Eigenaar is verwijderd. Het adres voorvoegsel is gewijzigd van 10.0.0.0/16 in 10.0.0.0/15. Het subnet subnet001 is verwijderd. Onthoud dat deze wijzigingen niet zijn geïmplementeerd. U ziet een voorbeeld van de wijzigingen die zullen plaatsvinden als u de sjabloon implementeert.

Sommige eigenschappen die als verwijderd worden vermeld, worden niet daadwerkelijk gewijzigd. Eigenschappen kunnen onjuist worden gerapporteerd als verwijderd wanneer ze niet in de sjabloon staan, maar worden tijdens de implementatie automatisch ingesteld als standaardwaarden. Dit resultaat wordt beschouwd als 'ruis' in het what-if-antwoord. Voor de uiteindelijk geïmplementeerde resource worden de waarden voor de eigenschappen ingesteld. Naarmate de what-if-bewerking zich verder ontwikkelde, worden deze eigenschappen uit het resultaat gefilterd.

Programmatisch what-if-resultaten evalueren

Laten we nu programmatisch de what-if-resultaten evalueren door de opdracht in te stellen op een variabele.

PowerShell
Azure-CLI

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

U kunt een samenvatting van elke wijziging bekijken.

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

results=$(az deployment group what-if --resource-group ExampleGroup --template-uri "https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/what-if/what-if-after.json" --no-pretty-print)

Verwijdering bevestigen

De what-if-bewerking ondersteunt het gebruik van de implementatiemodus. Wanneer de modus Volledig is ingesteld, worden resources die niet in de sjabloon staan, verwijderd. In het volgende voorbeeld wordt een sjabloon geïmplementeerd waarin geen resources zijn gedefinieerd in de volledige modus.

Als u de wijzigingen wilt bekijken voordat u een sjabloon implementeert, gebruikt u de parameter confirm switch met de implementatieopdracht. Als de wijzigingen zijn zoals verwacht, reageert u dat u wilt dat de implementatie wordt voltooid.

PowerShell
Azure-CLI

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"

az deployment group create \
  --resource-group ExampleGroup \
  --mode Complete \
  --confirm-with-what-if \
  --template-uri "https://raw.githubusercontent.com/Azure/azure-docs-json-samples/master/azure-resource-manager/what-if/azuredeploy.json"

Omdat er geen resources zijn gedefinieerd in de sjabloon en de implementatiemodus is ingesteld om te worden voltooid, wordt het virtuele netwerk verwijderd.

Resource Manager implementatie van sjabloon-what-if-bewerkingsuitvoer is voltooid

De tekstuitvoer is:

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&quot;
      location:        &quot;centralus&quot;
      name:            &quot;vnet-001&quot;
      tags.CostCenter: &quot;12345&quot;
      tags.Owner:      &quot;Team A&quot;
      type:            &quot;Microsoft.Network/virtualNetworks&quot;

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 &quot;Y"):

U ziet de verwachte wijzigingen en u kunt bevestigen dat u de implementatie wilt uitvoeren.

SDK's

U kunt de what-if-bewerking gebruiken via de Azure SDK's.

Gebruik what-if voorPython.
Gebruik voor Java DeploymentWhatIf-klasse.
Gebruik voor .NET DeploymentWhatIf Class.

Volgende stappen

Zie ARM-sjablonen testen met What-If in een pijplijn voor het gebruik van de what-if-bewerking in een pijplijn.
Als u onjuiste resultaten ziet van de what-if-bewerking, meldt u de problemen op https://aka.ms/whatifissues .
Zie Preview-wijzigingen Microsoft Learn Azure-resources valideren met behulp van what-if en de ARM-sjabloontesttoolkitvoor een Microsoft Learn over het gebruik van what if.

ARM template deployment what-if operation (Wat-als-bewerking bij het implementeren van ARM-sjablonen)

Beoordeel uw ervaring

Microsoft Learn

De Azure PowerShell installeren

Azure CLI-module installeren

Resultaten bekijken

What-if-opdrachten

Azure PowerShell

Azure CLI

Azure REST API

Wijzigingstypen

Resultaatopmaak

What-if-bewerking uitvoeren

Omgeving instellen

Testaanpassingen

Programmatisch what-if-resultaten evalueren

Verwijdering bevestigen

SDK's

Volgende stappen