Skapa, förstå och felsöka Azure API Management-principer i Visual Studio Code

GÄLLER FÖR: Alla API Management-nivåer

Den här artikeln beskriver hur du använder Azure API Management-tillägget för Visual Studio Code för att skapa, förstå och felsöka API Management-principer. Tillägget integreras med GitHub Copilot för Azure för att hjälpa till att utarbeta och förklara principer.

En Azure API Management policy är en sekvens med instruktioner som hanterar övergripande problem som tillämpas på API-begäranden eller svar. Dessa problem omfattar autentisering, auktorisering, begränsning, cachelagring och transformering.

Förutsättningar

Villkor och begränsningar

  • Principfelsökning stöds för närvarande endast på API Management Developer-nivån.

  • Policyfelsökning använder den inbyggda (tjänstnivå) prenumerationen med fullständig åtkomst, som har visningsnamnet Inbyggd prenumeration med fullständig åtkomst. Du måste vara tjänstägare för att kunna använda den här prenumerationen.

Skapa en princip med GitHub Copilot för Azure

Azure API Management-tillägget integreras med GitHub Copilot för Azure för att hjälpa dig att skapa ett utkast till en princip. Med AI-hjälp skapar och redigerar du principer på ett användarvänligt sätt.

För att skapa en policy:

  1. Öppna API Management-tillägget i Visual Studio Code.

  2. Välj den API Management-instans som du vill arbeta med.

  3. Välj det principomfång som du vill arbeta med.

    • Om du vill skapa en princip som gäller för alla API:er i instansen väljer du Global princip.
    • Om du vill skapa en princip som gäller för ett specifikt API väljer du API:et under API:er och väljer sedan Princip.
    • Om du vill skapa en princip som gäller för en specifik API-åtgärd väljer du åtgärden och väljer sedan Princip.

  4. Öppna Chatt.

  5. I chattfönstret anger du en uppmaning på naturligt språk för att skapa en princip. 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 genererar ett principutkast i chattfönstret. Du kan förfina kommandotolken om du vill att Copilot ska ändra utdata.

  6. När du är klar väljer du knappen Kopiera för att kopiera principen till Urklipp eller väljer Använd i Redigeraren för att infoga principen i redigeringsfönstret. Om du är nöjd med ändringen i princip-XML väljer du Behåll.

Tips

I fönstret Problem finns en förklaring av eventuella problem i princip-XML:en.

Förklara en princip med GitHub Copilot för Azure

Copilot kan hjälpa till att förklara en befintlig princip i din API Management-instans.

För att få en förklaring:

  1. Öppna API Management-tillägget i Visual Studio Code.

  2. Välj den API Management-instans som du vill arbeta med.

  3. Välj det principomfång som du vill arbeta med.

    • Om du vill förklara en princip som gäller för alla API:er i instansen väljer du Global princip.
    • Om du vill förklara en princip som gäller för ett specifikt API väljer du API:et under API:er och väljer sedan Princip.
    • Om du vill förklara en princip som gäller för en specifik API-åtgärd väljer du åtgärden och väljer sedan Princip.

  4. I fönstret principredigerare som visas högerklickar du och väljer sedan Förklara.

  5. En översikt och förklaring av principer i princip-XML-dokumentet genereras i chattfönstret.

Felsök regler med VS Code-tillägget

Azure API Management-tillägget för Visual Studio Code ger en felsökningsupplevelse som gör att du kan gå igenom princippipelinen eller ange en brytpunkt när du skickar en begäran till gatewayen.

Initiera en felsökningssession

  1. Öppna API Management-tillägget i Visual Studio Code.
  2. Välj den API Management-instans som ska felsökas.
  3. Välj DET API och den åtgärd som ska felsökas.
  4. Högerklicka på åtgärden och välj Starta principfelsökning.

Tillägget börjar upprätta en felsökningssession med API Management-gatewayen. Kontrollera förloppet i felsökningskonsolfönstret .

Skärmbild om du initierar en principfelsökningssession i Visual Studio Code.

Anmärkning

Om du startar en felsökningssession kan du även spåra begäranden under sessionen för att hjälpa dig att diagnostisera och lösa problem.

Skicka en testbegäran

När felsökningssessionen har upprättats öppnar REST-klienttillägget en ny redigerare som gör att du kan skapa och skicka en HTTP-testbegäran till gatewayen.

Ocp-Apim-Debug-huvudet läggs automatiskt till i begäran. Detta header krävs och värdet måste anges till en prenumerationsnyckel med tjänstnivå och full åtkomst för att aktivera felsökningsfunktionen i API Management-gatewayen.

Ändra HTTP-begäran i redigeraren enligt ditt testscenario. Välj sedan Skicka begäran för att skicka testbegäran till API Management-gatewayen.

Skärmbild av att skicka en testbegäran i Visual Studio Code.

Felsökningsprinciper

När HTTP-testbegäran har skickats öppnar tillägget felsökningsfönstret, som visar de effektiva principerna för den här åtgärden och stoppas vid den första effektiva principen.

Skärmbild av felsökningsfönstret i Visual Studio Code.

Om du vill följa princippipelinen kan du steg för steg gå igenom enskilda principer eller ange en brytpunkt i en princip och gå direkt till den principen.

  • I panelen Variabler kontrollerar du värdena för systemskapade och användarskapade variabler.
  • I panelen Brytpunkter visar du listan över alla brytpunkter som du har angett.
  • I panelen Samtalsstack visar du det aktuella gällande principomfånget.

Om det uppstår ett fel under policykörning visas detaljerna av felet vid den policy där det inträffade.

Om du vill avsluta felsökningssessionen väljer du Stoppa.

Skärmbild av ett principfel i Visual Studio Code.

Tips

Om du vill granska spårningen av begäran väljer du värdet för Ocp-Apim-Trace-Location rubriken som anges i HTTP-svaret.

Relaterat innehåll

  • Last updated on