Azure API Management-beleid maken, begrijpen en fouten opsporen in Visual Studio Code

Van toepassing op: Alle API Management-lagen

In dit artikel wordt uitgelegd hoe u de Azure API Management-extensie voor Visual Studio Code gebruikt voor het maken, begrijpen en opsporen van fouten in API Management-beleid. De extensie kan worden geïntegreerd met GitHub Copilot voor Azure om beleid op te stellen en uit te leggen.

Een Azure API Management beleid is een reeks instructies die betrekking hebben op kruislingse problemen die worden toegepast op API-aanvragen of -antwoorden. Deze aandachtspunten omvatten verificatie, autorisatie, limitering, caching en transformatie.

Vereisten

• Visual Studio Code.

• De nieuwste versie van Azure API Management Extension voor Visual Studio Code.

• De volgende extensies zijn nodig voor de opgegeven scenario's:

  • GitHub Copilot voor Azure-extensie om beleidsregels te maken en uit te leggen
  • REST-clientextensie voor beleidsopsporing

• Een API Management-exemplaar. Zie Maak een nieuw Azure API Management-exemplaar als u er een wilt maken.

• Importeer een API in uw API Management-exemplaar. Zie Gebruik de API Management-extensie voor Visual Studio Code voor het importeren en beheren van API's.

Beperkingen en limieten

• Beleidsopsporing wordt momenteel alleen ondersteund in de API Management Developer-laag.

• Beleidsopsporing maakt gebruik van het ingebouwde (serviceniveau) all-access-abonnement, met de weergavenaam Ingebouwd abonnement voor alle toegang. U moet een service-eigenaar zijn om dit abonnement te kunnen gebruiken.

Een beleid maken met GitHub Copilot voor Azure

De Azure API Management-extensie kan worden geïntegreerd met GitHub Copilot voor Azure om u te helpen bij het maken van een concept van een beleid. Met AI-hulp kunt u beleid op een gebruiksvriendelijke manier maken en bewerken.

Een beleid maken:

1. Open de API Management-extensie in Visual Studio Code.

2. Selecteer het API Management-exemplaar waarmee u wilt werken.

3. Selecteer het beleidsbereik waarmee u wilt werken.

   • Als u een beleid wilt maken dat van toepassing is op alle API's in het exemplaar, selecteert u Globaal beleid.
   • Als u een beleid wilt maken dat van toepassing is op een specifieke API, selecteert u de API onder API's en selecteert u Beleid.
   • Als u een beleid wilt maken dat van toepassing is op een specifieke API-bewerking, selecteert u de bewerking en selecteert u Vervolgens Beleid.

4. Open Chat.

5. Voer in het chatvenster een prompt in natuurlijke taal in om een beleid te maken. Examples:

   @azure I want to limit requests to 100 calls per minute
   

   @azure Create a policy that sets the backend URL to https://mybackend.contoso.com and adds a custom header to the request
   

   Copilot genereert een beleidsconcept in het chatvenster. U kunt de prompt verfijnen als u wilt dat Copilot de uitvoer wijzigt.

6. Wanneer u klaar bent, selecteert u de knop Kopiëren om het beleid naar het klembord te kopiëren of selecteert u Toepassen in Editor om het beleid in te voegen in het editorvenster. Als u tevreden bent met de wijziging in de BELEIDS-XML, selecteert u Behouden.

Een beleid uitleggen met GitHub Copilot voor Azure

Copilot kan helpen bij het uitleggen van een bestaand beleid in uw API Management-exemplaar.

Een uitleg ontvangen:

1. Open de API Management-extensie in Visual Studio Code.

2. Selecteer het API Management-exemplaar waarmee u wilt werken.

3. Selecteer het beleidsbereik waarmee u wilt werken.

   • Als u een beleid wilt uitleggen dat van toepassing is op alle API's in het exemplaar, selecteert u Globaal beleid.
   • Als u een beleid wilt uitleggen dat van toepassing is op een specifieke API, selecteert u onder API's de API en selecteert u Vervolgens Beleid.
   • Als u een beleid wilt uitleggen dat van toepassing is op een specifieke API-bewerking, selecteert u de bewerking en vervolgens Beleid.

4. Klik in het venster van de beleidseditor dat wordt weergegeven met de rechtermuisknop en selecteer Uitleg.

5. Een overzicht en uitleg van beleidsregels in het XML-document voor beleid worden gegenereerd in het chatvenster.

Fouten opsporen in beleidsregels met behulp van de VS Code-extensie

De Azure API Management-extensie voor Visual Studio Code biedt een foutopsporingservaring waarmee u de beleidspijplijn kunt doorlopen of een onderbrekingspunt kunt instellen wanneer u een aanvraag naar de gateway verzendt.

Een foutopsporingssessie starten

1. Open de API Management-extensie in Visual Studio Code.
2. Selecteer het API Management-exemplaar om fouten op te sporen.
3. Selecteer de API en de bewerking om fouten op te sporen.
4. Klik met de rechtermuisknop op de bewerking en selecteer Foutopsporing voor beleid starten.

De extensie begint met het tot stand brengen van een foutopsporingssessie met de API Management-gateway. Controleer de voortgang in het venster Foutopsporingsconsole .

Een testaanvraag verzenden

Wanneer de foutopsporingssessie tot stand is gebracht, opent de REST Client-extensie een nieuwe editor waarmee u een HTTP-testaanvraag naar de gateway kunt maken en verzenden.

De header Ocp-Apim-Debug wordt automatisch toegevoegd aan de aanvraag. Deze header is vereist en de waarde moet worden ingesteld op de abonnementssleutel op serviceniveau voor alle toegang om de functionaliteit voor foutopsporing in de API Management-gateway te activeren.

Wijzig de HTTP-aanvraag in de editor volgens uw testscenario. Selecteer vervolgens Aanvraag verzenden om de testaanvraag naar de API Management-gateway te verzenden.

Fouten opsporen in beleid

Nadat de HTTP-testaanvraag is verzonden, opent de extensie het foutopsporingsvenster, waarin het effectieve beleid van deze bewerking wordt weergegeven en stopt bij het eerste effectieve beleid.

Als u de 'policy pipeline' wilt volgen, kunt u afzonderlijke beleidsregels stap voor stap doorlopen of een breakpoint instellen bij een beleid en direct naar dat beleid springen.

• Inspecteer in het deelvenster Variabelen de waarden van door het systeem gemaakte en door de gebruiker gemaakte variabelen.
• Bekijk in het deelvenster Onderbrekingspunten de lijst met alle onderbrekingspunten die u hebt ingesteld.
• Bekijk in het deelvenster Oproepstack het huidige effectieve beleidsbereik.

Als er een fout optreedt tijdens het uitvoeren van het beleid, ziet u de details van de fout in het beleid waar deze is opgetreden.

Als u de foutopsporingssessie wilt afsluiten, selecteert u Stoppen.

Verwante inhoud

• Meer informatie over de extensie API Management voor Visual Studio Code
• Problemen melden in de GitHub-opslagplaats