Erstellen, Verstehen und Debuggen von Azure-API-Verwaltungsrichtlinien in Visual Studio Code

GILT FÜR: Alle API Management-Ebenen

In diesem Artikel wird erläutert, wie Sie die Azure API Management Erweiterung für Visual Studio Code verwenden, um API-Verwaltungsrichtlinien zu erstellen, zu verstehen und zu debuggen. Die Erweiterung ist in GitHub Copilot für Azure integriert, um Richtlinien zu entwerfen und zu erläutern.

Eine Azure API Management policy ist eine Abfolge von Anweisungen, die auf API-Anforderungen oder -Antworten angewendete querschneidende Bedenken behandeln. Zu diesen Aspekten gehören Authentifizierung, Autorisierung, Einschränkung, Zwischenspeicherung und Transformation.

Voraussetzungen

Einschränkungen

  • Das Richtliniendebugging wird derzeit nur auf der Api Management Developer-Ebene unterstützt.

  • Das Richtliniendebugging verwendet das integrierte (Serviceebene) All-Access-Abonnement, das den Anzeigenamen „Integriertes All-Access-Abonnement“ aufweist. Sie müssen ein Dienstbesitzer sein, um dieses Abonnement zu verwenden.

Erstellen einer Richtlinie mit GitHub Copilot für Azure

Die Azure API Management-Erweiterung ist in GitHub Copilot für Azure integriert, damit Sie einen Entwurf einer Richtlinie erstellen können. Mit KI-Unterstützung können Sie Richtlinien auf benutzerfreundliche Weise erstellen und bearbeiten.

So erstellen Sie eine Richtlinie

  1. Öffnen Sie die API-Verwaltungserweiterung in Visual Studio Code.

  2. Wählen Sie die API-Verwaltungsinstanz aus, mit der Sie arbeiten möchten.

  3. Wählen Sie den Richtlinienbereich aus, mit dem Sie arbeiten möchten.

    • Um eine Richtlinie zu erstellen, die für alle APIs in der Instanz gilt, wählen Sie "Globale Richtlinie" aus.
    • Um eine Richtlinie zu erstellen, die für eine bestimmte API gilt, wählen Sie unter APIs die API aus, und wählen Sie dann "Richtlinie" aus.
    • Um eine Richtlinie zu erstellen, die für einen bestimmten API-Vorgang gilt, wählen Sie den Vorgang aus, und wählen Sie dann "Richtlinie" aus.

  4. Öffnen Sie "Chat".

  5. Geben Sie im Chatfenster eine Eingabeaufforderung in natürlicher Sprache ein, um eine Richtlinie zu erstellen. Beispiele

    @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 generiert einen Richtlinienentwurf im Chatfenster. Sie können die Eingabeaufforderung verfeinern, wenn Sie möchten, dass Copilot die Ausgabe ändert.

  6. Wenn Sie fertig sind, wählen Sie die Schaltfläche "Kopieren " aus, um die Richtlinie in die Zwischenablage zu kopieren, oder wählen Sie "Im Editor übernehmen" aus, um die Richtlinie in das Editorfenster einzufügen. Wenn Sie mit der Änderung im Richtlinien-XML zufrieden sind, wählen Sie "Beibehalten" aus.

Tipp

Überprüfen Sie im Fenster "Probleme " die Erläuterung aller Probleme im Richtlinien-XML.

Erläutern einer Richtlinie mithilfe von GitHub Copilot für Azure

Copilot kann eine vorhandene Richtlinie in Ihrer API-Verwaltungsinstanz erläutern.

Um eine Erläuterung zu erhalten:

  1. Öffnen Sie die API-Verwaltungserweiterung in Visual Studio Code.

  2. Wählen Sie die API-Verwaltungsinstanz aus, mit der Sie arbeiten möchten.

  3. Wählen Sie den Richtlinienbereich aus, mit dem Sie arbeiten möchten.

    • Um eine Richtlinie zu erläutern, die für alle APIs in der Instanz gilt, wählen Sie "Globale Richtlinie" aus.
    • Um eine Richtlinie zu erläutern, die für eine bestimmte API gilt, wählen Sie unter APIs die API aus, und wählen Sie dann "Richtlinie" aus.
    • Um eine Richtlinie zu erläutern, die für einen bestimmten API-Vorgang gilt, wählen Sie den Vorgang aus, und wählen Sie dann "Richtlinie" aus.

  4. Klicken Sie im daraufhin angezeigten Richtlinien-Editor-Fenster mit der rechten Maustaste, und wählen Sie dann "Erklären" aus.

  5. Eine Übersicht und Erläuterung von Richtlinien im Richtlinien-XML-Dokument werden im Chatfenster generiert.

Debuggen von Richtlinien mithilfe der VS-Codeerweiterung

Die Azure API Management-Erweiterung für Visual Studio Code bietet eine Debugerfahrung, mit der Sie die Richtlinienpipeline durchlaufen oder einen Haltepunkt festlegen können, wenn Sie eine Anforderung an das Gateway senden.

Initiieren einer Debugsitzung

  1. Öffnen Sie die API-Verwaltungserweiterung in Visual Studio Code.
  2. Wählen Sie die API-Verwaltungsinstanz aus, die sie debuggen möchten.
  3. Wählen Sie die API und den zu debuggenden Vorgang aus.
  4. Klicken Sie mit der rechten Maustaste auf den Vorgang, und wählen Sie "Richtliniendebugging starten" aus.

Die Erweiterung beginnt mit der Einrichtung einer Debugsitzung mit dem API-Verwaltungsgateway. Überprüfen Sie den Fortschritt im Fenster "Debugkonsole" .

Screenshot, wenn eine Richtliniendebuggingsitzung in Visual Studio Code initiiert wird.

Hinweis

Das Starten einer Debugsitzung ermöglicht auch die Anforderungsablaufverfolgung während der Sitzung, um Probleme zu diagnostizieren und zu lösen.

Senden einer Testanforderung

Wenn die Debugsitzung eingerichtet wird, öffnet die REST-Clienterweiterung einen neuen Editor, mit dem Sie eine HTTP-Testanforderung erstellen und an das Gateway senden können.

Der Ocp-Apim-Debug-Header wird der Anforderung automatisch hinzugefügt. Dieser Header ist erforderlich, und der Wert muss auf den Abonnementschlüssel auf Dienstebene mit allen Zugriffsberechtigungen festgelegt werden, um die Debuggingfunktionalität im API Management-Gateway zu initiieren.

Ändern Sie die HTTP-Anforderung im Editor entsprechend dem Testszenario. Wählen Sie dann "Anforderung senden" aus, um die Testanforderung an das API-Verwaltungsgateway zu senden.

Screenshot des Sendens einer Testanforderung in Visual Studio Code.

Debugrichtlinien

Nachdem die HTTP-Testanforderung gesendet wurde, öffnet die Erweiterung das Debugfenster, das die effektiven Richtlinien dieses Vorgangs anzeigt und bei der ersten effektiven Richtlinie beendet wird.

Screenshot des Debugfensters in Visual Studio Code.

Sie können die Richtlinien einzeln durchlaufen oder einen Breakpoint bei einer Richtlinie festlegen und direkt zu dieser Richtlinie wechseln, um der Richtlinienpipeline zu folgen.

  • Überprüfen Sie im Bereich "Variablen " die Werte von vom System erstellten und vom Benutzer erstellten Variablen.
  • Zeigen Sie im Bereich "Haltepunkte " die Liste aller haltepunkte an, die Sie festgelegt haben.
  • Im Bereich Aufrufliste zeigen Sie den aktuellen Gültigkeitsbereich der effektiven Richtlinie an.

Wenn während der Richtlinienausführung ein Fehler auftritt, werden die Details des Fehlers in der Richtlinie angezeigt, in der er aufgetreten ist.

Um die Debugsitzung zu beenden, wählen Sie "Beenden" aus.

Screenshot einer Richtlinien ausnahme in Visual Studio Code.

Tipp

Um die Anforderungsablaufverfolgung zu überprüfen, wählen Sie den Wert des Ocp-Apim-Trace-Location Headers aus, der in der HTTP-Antwort bereitgestellt wird.

Verwandte Inhalte

  • Last updated on