Delen via

Logboekregistratie voor foutopsporing inschakelen

Als u een implementatiefout wilt oplossen, kunt u logboekregistratie voor foutopsporing inschakelen voor meer informatie. Logboekregistratie voor foutopsporing werkt voor implementaties met Bicep-bestanden of Azure Resource Manager-sjablonen (ARM-sjablonen). U kunt gegevens ophalen over de aanvraag en reactie van een implementatie om de oorzaak van een probleem te leren.

Waarschuwing

Logboekregistratie voor foutopsporing kan geheimen, zoals wachtwoorden of listKeys bewerkingen, beschikbaar maken. Schakel logboekregistratie voor foutopsporing alleen in wanneer u een implementatiefout moet oplossen. Wanneer u klaar bent met foutopsporing, moet u de geschiedenis van de foutopsporingsimplementatie verwijderen.

Logboekregistratie voor foutopsporing instellen

Gebruik Azure PowerShell om logboekregistratie voor foutopsporing in te schakelen waarmee de request en response eigenschappen worden gevuld met implementatiegegevens voor probleemoplossing. Logboekregistratie voor foutopsporing kan niet worden ingeschakeld met behulp van Azure CLI.

Logboekregistratie voor foutopsporing is alleen ingeschakeld voor de hoofd-ARM-sjabloon of bicep-bestand. Als u geneste ARM-sjablonen of Bicep-modules gebruikt, zie Geneste sjabloon debuggen.

Voor de implementatie van een resourcegroep gebruikt u New-AzResourceGroupDeployment en stelt u de DeploymentDebugLogLevel-parameter in op All, ResponseContent, of RequestContent.

Wanneer logboekregistratie voor foutopsporing is ingeschakeld, wordt een waarschuwing weergegeven dat geheimen, zoals wachtwoorden, of gevoelige listKeys bewerkingen kunnen worden geregistreerd en weergegeven wanneer u opdrachten gebruikt, zoals Get-AzResourceGroupDeploymentOperation om informatie over uitrolbewerkingen op te vragen.

New-AzResourceGroupDeployment `
  -Name exampledeployment `
  -ResourceGroupName examplegroup `
  -TemplateFile main.bicep `
  -DeploymentDebugLogLevel All

In de uitvoer van de implementatie wordt het niveau voor logboekregistratie voor foutopsporing weergegeven.

DeploymentDebugLogLevel : RequestContent, ResponseContent

De DeploymentDebugLogLevel parameter is beschikbaar voor andere implementatiebereiken: abonnement, beheergroep en tenant.

Debuginformatie ophalen

Nadat logboekregistratie voor foutopsporing is ingeschakeld, kunt u meer informatie krijgen over de implementatiebewerkingen. De Azure PowerShell-cmdlets voor implementatiebewerkingen voeren de request en response eigenschappen niet uit. U moet Azure CLI gebruiken om de informatie van deze eigenschappen op te halen.

Als u logboekregistratie voor foutopsporing niet inschakelt vanuit de implementatieopdracht, kunt u nog steeds informatie over implementatiebewerkingen ophalen. Gebruik Azure PowerShell of Azure CLI om de statuscode, statusbericht en inrichtingsstatus op te halen.

Voor een implementatie van een resourcegroep gebruikt u Get-AzResourceGroupDeploymentOperation om implementatiebewerkingen op te halen.

Get-AzResourceGroupDeploymentOperation `
  -DeploymentName exampledeployment `
  -ResourceGroupName examplegroup

U kunt een eigenschap opgeven, zoals StatusCode, StatusMessageof ProvisioningState om de uitvoer te filteren.

(Get-AzResourceGroupDeploymentOperation `
  -DeploymentName exampledeployment `
  -ResourceGroupName examplegroup).StatusCode

Zie de documentatie voor implementatiebewerkingsbereiken: abonnement, beheergroep en tenant voor meer informatie.

Fouten opsporen in geneste sjabloon

De belangrijkste ARM-sjabloon en geneste sjablonen hebben hun eigen implementatienaam en implementatiegeschiedenis. Het bicep-bestand en de belangrijkste module gebruiken ook een afzonderlijke implementatienaam en implementatiegeschiedenis.

ARM-template

Als u foutopsporingsgegevens voor een geneste ARM-sjabloon wilt vastleggen, gebruikt u de Microsoft.Resources/implementaties met de debugSetting eigenschap.

In het volgende voorbeeld ziet u een geneste sjabloon met de debugSetting om het verzoek en de respons van de implementatie te registreren.

"resources": [
  {
    "type": "Microsoft.Resources/deployments",
    "apiVersion": "2021-04-01",
    "name": "nestedTemplateDebug",
    "properties": {
      "mode": "Incremental",
      "template": {
        "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
        "contentVersion": "1.0.0.0",
        "resources": [
          {
            "type": "Microsoft.Storage/storageAccounts",
            "apiVersion": "2022-05-01",
            "name": "[variables('storageAccountName')]",
            "location": "[parameters('location')]",
            "sku": {
              "name": "[parameters('storageAccountType')]"
            },
            "kind": "StorageV2"
          }
        ]
      },
      "debugSetting": {
        "detailLevel": "requestContent, responseContent"
      }
    }
  }
],

De belangrijkste ARM-sjabloon en geneste sjablonen hebben hun eigen implementatienaam en implementatiegeschiedenis. Als u wilt dat de request en response eigenschappen informatie over probleemoplossing bevatten, moet u rekening houden met de volgende implementatiescenario's:

  • De eigenschappen request en response bevatten null waarden voor de hoofdsjabloon en geneste sjabloon wanneer DeploymentDebugLogLevel niet is ingeschakeld met de implementatieopdracht.
  • Wanneer de implementatieopdracht inschakelt, bevatten de DeploymentDebugLogLevel en request eigenschappen alleen informatie voor de hoofdsjabloon. De eigenschappen van de geneste sjabloon bevatten null waarden.
  • Wanneer een geneste sjabloon gebruikmaakt van de debugSetting en de implementatieopdracht DeploymentDebugLogLevel niet bevat, heeft alleen de geneste sjabloonimplementatie waarden voor de request en response eigenschappen. De eigenschappen van de hoofdsjabloon bevatten null waarden.
  • Als u de request en response voor de hoofdsjabloon en geneste sjabloon wilt ophalen, geeft u DeploymentDebugLogLevel op in de implementatieopdracht en gebruikt debugSetting u deze in de geneste sjabloon.

Bicep-bestand

De aanbeveling voor Bicep-bestanden is om modules te gebruiken in plaats van geneste sjablonen met Microsoft.Resources/deployments. Het statusbericht, de statuscode en de inrichtingsstatus bevatten informatie voor het belangrijkste Bicep-bestand en de module die u kunt gebruiken om problemen met de implementatie op te lossen.

Als u DeploymentDebugLogLevel inschakelt in het implementatiecommando, bevatten de eigenschappen request en response alleen informatie voor de implementatie van het hoofdbestand van Bicep.

Foutopsporingsimplementatiegeschiedenis verwijderen

Wanneer u klaar bent met foutopsporing, moet u de implementatiegeschiedenis verwijderen om te voorkomen dat iedereen die toegang heeft, gevoelige informatie ziet die mogelijk is vastgelegd. Voer de opdracht uit om de implementatiegeschiedenis te verwijderen voor elke implementatienaam die u hebt gebruikt tijdens het opsporen van fouten.

Als u de implementatiegeschiedenis van een resourcegroep wilt verwijderen, gebruikt u Remove-AzResourceGroupDeployment.

Remove-AzResourceGroupDeployment -ResourceGroupName examplegroup -Name exampledeployment

De opdracht retourneert True wanneer deze succesvol is.

Zie de documentatie voor de implementatiebereiken voor meer informatie over de implementatiegeschiedenis: abonnement, beheergroep en tenant.

Volgende stappen