Condividi tramite

Creare, comprendere ed eseguire il debug dei criteri di Gestione API di Azure in Visual Studio Code

SI APPLICA A: Tutti i livelli di Gestione API

Questo articolo illustra come usare l'estensione Gestione API di Azure per Visual Studio Code per creare, comprendere ed eseguire il debug dei criteri di Gestione API di Azure con l'assistenza per intelligenza artificiale di GitHub Copilot per Azure.

I criteri di Gestione API di Azure sono una sequenza di istruzioni che risolva problemi trasversali, ad esempio autenticazione, autorizzazione, limitazione, memorizzazione nella cache e trasformazione, applicate alle richieste o alle risposte api.

Prerequisiti

Restrizioni e limitazioni

  • Il debug dei criteri è attualmente supportato solo nel livello Developer di Gestione API.

  • Il debug dei criteri utilizza la sottoscrizione predefinita all-access a livello di servizio (nome visualizzato "Sottoscrizione all-access predefinita"). Per usare questa sottoscrizione, è necessario essere un proprietario del servizio.

Creare una politica per Azure usando GitHub Copilot

L'estensione Gestione API di Azure si integra con GitHub Copilot per Azure per facilitare la creazione di una bozza di criteri. Con l'assistenza per l'intelligenza artificiale, creare e modificare i criteri in modo intuitivo.

Per creare un criterio:

  1. Apri l'estensione Gestione delle API in Visual Studio Code.

  2. Selezionare l'istanza di Gestione API da usare.

  3. Selezionare l'ambito dei criteri da usare.

    • Per creare un criterio applicabile a tutte le API nell'istanza di , selezionare Criteri globali.
    • Per creare un criterio applicabile a un'API specifica, in API selezionare l'API e quindi selezionare Criteri.
    • Per creare un criterio applicabile a un'operazione API specifica, selezionare l'operazione e quindi selezionare Criteri.

  4. Aprire Chat.

  5. Nella finestra Chat immettere una richiesta in linguaggio naturale per creare un criterio. 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

  6. Copilot genera una bozza di criteri nella finestra Chat. È possibile perfezionare il prompt se si vuole che Copilot modifichi l'output.

  7. Quando si è pronti, selezionare il pulsante Copia per copiare i criteri negli Appunti oppure selezionare Applica nell'editor per inserire i criteri nella finestra dell'editor. Se si è soddisfatti della modifica nel codice XML dei criteri, selezionare Mantieni.

Suggerimento

Controllare la finestra Problemi per la spiegazione di eventuali problemi nel codice XML dei criteri.

Spiegare una politica utilizzando GitHub Copilot per Azure

Copilot può aiutare a spiegare un criterio esistente nell'istanza di Gestione API.

Per ricevere una spiegazione:

  1. Apri l'estensione Gestione delle API in Visual Studio Code.

  2. Selezionare l'istanza di Gestione API da usare.

  3. Selezionare l'ambito dei criteri da usare.

    • Per spiegare un criterio applicabile a tutte le API nell'istanza, selezionare Criteri globali.
    • Per spiegare un criterio applicabile a un'API specifica, in API selezionare l'API e quindi selezionare Criteri.
    • Per spiegare un criterio applicabile a un'operazione API specifica, selezionare l'operazione e quindi selezionare Criteri.

  4. Nella finestra dell'editor dei criteri visualizzata fare clic con il pulsante destro del mouse e scegliere Spiega.

  5. Nella finestra Chat vengono generati una panoramica e una spiegazione dei criteri nel documento XML dei criteri.

Eseguire il debug dei criteri usando l'estensione VS Code

L'estensione Gestione API di Azure per Visual Studio Code offre un'esperienza di debug che consente di scorrere la pipeline dei criteri o impostare un punto di interruzione quando si invia una richiesta al gateway.

Avviare una sessione di debug

  1. Apri l'estensione Gestione delle API in Visual Studio Code.
  2. Selezionare l'istanza di Gestione API per eseguire il debug.
  3. Selezionare l'API e l'operazione di cui eseguire il debug.
  4. Fare clic con il pulsante destro del mouse sull'operazione e selezionare Avvia debug dei criteri.

A questo punto, l'estensione inizia a stabilire una sessione di debug con il gateway di Gestione API. Controllare lo stato di avanzamento nella finestra Console di debug .

Screenshot dell'avvio di una sessione di debug dei criteri in Visual Studio Code.

Annotazioni

L'avvio di una sessione di debug consente anche la traccia delle richieste per la durata della sessione, per facilitare la diagnosi e la risoluzione dei problemi.

Inviare una richiesta di test

Quando viene stabilita la sessione di debug, l'estensione client REST apre un nuovo editor che consente di creare e inviare una richiesta HTTP di test al gateway.

L'intestazione Ocp-Apim-Debug viene aggiunta automaticamente alla richiesta. Questa intestazione è obbligatoria e il valore deve essere impostato sulla chiave di sottoscrizione a livello di servizio, all-access per attivare la funzionalità di debug nel gateway di Gestione API.

Modificare la richiesta HTTP nell'editor in base allo scenario di test. Fare quindi clic su Invia richiesta per inviare la richiesta di test al gateway di Gestione API.

Screenshot dell'invio di una richiesta di test in Visual Studio Code.

Criteri di debug

Dopo l'invio della richiesta HTTP di test, l'estensione apre la finestra di debug, che mostra i criteri effettivi di questa operazione e si arresta al primo criterio effettivo.

Screenshot della finestra di debug in Visual Studio Code.

Per seguire la pipeline dei criteri, è possibile eseguire un unico passaggio tra singoli criteri o impostare un punto di interruzione in un criterio e passare direttamente a tale criterio.

  • Nel pannello Variabili esaminare i valori delle variabili create dal sistema e create dall'utente.
  • Nel pannello Punti di interruzione visualizzare l'elenco di tutti i punti di interruzione impostati.
  • Nel pannello stack di chiamate visualizzare l'ambito dei criteri effettivo corrente.

Se si verifica un errore durante l'esecuzione dei criteri, verranno visualizzati i dettagli dell'errore nel criterio in cui si è verificato.

Uscire dalla sessione di debug facendo clic sul pulsante Arresta al termine.

Screenshot di un'eccezione dei criteri in Visual Studio Code.

Suggerimento

Per esaminare la traccia della richiesta, selezionare il valore dell'intestazione Ocp-Apim-Trace-Location fornita nella risposta HTTP.

Contenuti correlati

  • Last updated on