Condividi tramite

Informazioni di riferimento per i criteri di Gestione API di Azure

  • Articolo

SI APPLICA A: tutti i livelli di Gestione API

In questa sezione vengono forniti brevi descrizioni e collegamenti ad articoli di riferimento per tutti i criteri di Gestione API. Sono indicati i gateway di Gestione API che supportano ogni criterio. Per informazioni dettagliate sulle impostazioni dei criteri e per esempi, vedere gli articoli di riferimento indicati nei collegamenti.

Ulteriori informazioni sui criteri:

Importante

Limitare la frequenza delle chiamate per sottoscrizione e Impostare la quota di utilizzo per sottoscrizione hanno una dipendenza dalla chiave di sottoscrizione. Una chiave di sottoscrizione non è necessaria quando vengono applicati altri criteri.

Limitazione della frequenza e quote

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Limita frequenza delle chiamate per sottoscrizione Impedisce picchi di utilizzo dell'API limitando la frequenza delle chiamate per ogni sottoscrizione. Sì Sì Sì Sì Sì
Limitare la frequenza delle chiamate per chiave Impedisce picchi di utilizzo delle API limitando la frequenza delle chiamata per ogni singola chiave. Sì Sì No Sì Sì
Imposta quota di utilizzo per sottoscrizione Consente di imporre una quota rinnovabile o permanente per il volume di chiamate e/o per la larghezza di banda per ogni sottoscrizione. Sì Sì Sì Sì Sì
Impostare la quota per chiave Consente di imporre una quota rinnovabile o permanente per il volume di chiamate e/o per la larghezza di banda per ogni chiave. Sì No No Sì Sì
Limitare la concorrenza Impedisce ai criteri racchiusi di eseguire un numero maggiore di richieste in qualsiasi momento rispetto a quello specificato. Sì Sì Sì Sì Sì
Limitare l'utilizzo dei token del Servizio OpenAI di Azure Impedisce picchi di utilizzo dell'API OpenAI di Azure limitando i token del modello linguistico di grandi dimensioni per ogni chiave calcolata. Sì Sì No No Sì
Limitare l'utilizzo dei token API del modello linguistico di grandi dimensioni Impedisce picchi di utilizzo delle API LLM (Large Language Model) limitando i token LLM per ogni chiave calcolata. Sì Sì No No Sì

Autenticazione e autorizzazione

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
check-header Impone l'esistenza e/o la specifica di un valore per un'intestazione HTTP. Sì Sì Sì Sì Sì
Ottieni codice di autorizzazione Ottiene il contesto di autorizzazione di una connessione specificata per un provider di credenziali configurato nell'istanza di Gestione API. Sì Sì Sì No No
ip-filter Filtra (consente/rifiuta) le chiamate da indirizzi e/o intervalli di indirizzi IP specifici. Sì Sì Sì Sì Sì
Convalidare il token Microsoft Entra Impone l'esistenza e la validità di un token JWT di Microsoft Entra (in precedenza Azure Active Directory) estratto da un'intestazione HTTP, da un parametro di query o da un valore di token specificati. Sì Sì Sì Sì Sì
validate-JWT Impone l'esistenza e la validità di un token JWT estratto da un'intestazione HTTP, da un parametro di query o da un valore di token specificati. Sì Sì Sì Sì Sì
Convalidare il certificato client Impone che un certificato presentato da un client a un'istanza di Gestione API corrisponda alle regole di convalida e alle attestazioni specificate. Sì Sì Sì Sì Sì
authentication-basic Esegue l'autenticazione con un servizio back-end usando l'autenticazione di base. Sì Sì Sì Sì Sì
authentication-certificate Esegue l'autenticazione con un servizio back-end usando certificati client. Sì Sì Sì Sì Sì
Eseguire l'autenticazione con un'identità gestita Eseguire l'autenticazione con un servizio back-end usando un'identità gestita. Sì Sì Sì Sì No

Convalida del contenuto

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Convalidare il contenuto Convalida le dimensioni o il contenuto del corpo di una richiesta o di una risposta rispetto a uno o più schemi API. I formati di schema supportati sono JSON e XML. Sì Sì Sì Sì Sì
Convalidare la richiesta GraphQL Convalida e autorizza una richiesta a un'API GraphQL. Sì Sì Sì Sì No
Convalidare la richiesta OData Convalida una richiesta a un'API OData per garantire la conformità con la specifica OData. Sì Sì Sì Sì Sì
Convalidare i parametri Convalida i parametri di intestazione della richiesta, della query o del percorso rispetto allo schema API. Sì Sì Sì Sì Sì
Convalidare le intestazioni Convalida le intestazioni della risposta rispetto allo schema API. Sì Sì Sì Sì Sì
Convalidare il codice di stato Convalida i codici di stato HTTP nelle risposte rispetto allo schema API. Sì Sì Sì Sì Sì

Definizione dei percorsi di trasferimento

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Inoltra richiesta Inoltra la richiesta al servizio back-end. Sì Sì Sì Sì Sì
Set backend service (Imposta servizio back-end) Cambia l'URL di base del servizio back-end per una richiesta in ingresso in un URL o un back-end. Se si fa riferimento a una risorsa back-end, è possibile gestire l'URL di base del servizio back-end e altre impostazioni in un'unica posizione. Implementare anche il bilanciamento del carico del traffico in un pool di servizi back-end e le regole dell'interruttore per proteggere il back-end da un numero eccessivo di richieste. Sì Sì Sì Sì Sì
Impostare il proxy HTTP Consente di indirizzare le richieste inoltrate tramite un proxy HTTP. Sì Sì Sì Sì Sì

Memorizzazione nella cache

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Recupera dalla cache Esegue una ricerca nella cache e restituisce una risposta valida memorizzata nella cache, se disponibile. Sì Sì Sì Sì Sì
cache-lookup Memorizza la risposta nella cache in base alla configurazione di controllo della cache specificata. Sì Sì Sì Sì Sì
Recuperare il valore dalla cache Recupera un elemento memorizzato nella cache in base alla chiave. Sì Sì Sì Sì Sì
Archiviare il valore nella cache Archivia un elemento nella cache in base alla chiave. Sì Sì Sì Sì Sì
Rimuovere il valore dalla cache Rimuove un elemento nella cache in base alla chiave. Sì Sì Sì Sì Sì
Ottenere le risposte memorizzate nella cache delle richieste dell'API OpenAI di Azure Esegue la ricerca nella cache dell'API OpenAI di Azure usando la ricerca semantica e restituisce una risposta memorizzata nella cache valida quando disponibile. Sì Sì Sì Sì No
Archiviare le risposte delle richieste dell'API OpenAI di Azure da memorizzare nella cache Memorizza nella cache la risposta in base alla configurazione della cache dell'API OpenAI di Azure. Sì Sì Sì Sì No
Ottenere risposte memorizzate nella cache di richieste API del modello linguistico di grandi dimensioni Esegue la ricerca nella cache dell'API del modello linguistico di grandi dimensioni usando la ricerca semantica e restituisce una risposta memorizzata nella cache valida quando disponibile. Sì Sì Sì Sì No
Archiviare le risposte delle richieste api del modello linguistico di grandi dimensioni nella cache Memorizza nella cache la risposta in base alla configurazione della cache dell'API del modello linguistico di grandi dimensioni. Sì Sì Sì Sì No

Trasformazione

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Impostare il metodo di richiesta Consente di modificare il metodo HTTP per una richiesta. Sì Sì Sì Sì Sì
Impostare il codice di stato Modifica il codice di stato HTTP nel valore specificato. Sì Sì Sì Sì Sì
set-variable Salva in modo permanente un valore in una variabile di contesto denominata per consentire di accedervi in un secondo momento. Sì Sì Sì Sì Sì
Set body (Imposta corpo) Imposta il corpo del messaggio per una richiesta o una risposta. Sì Sì Sì Sì Sì
Set HTTP header (Imposta intestazione HTTP) Assegna un valore a un'intestazione di risposta e/o richiesta esistente oppure aggiunge una nuova intestazione di risposta e/o richiesta. Sì Sì Sì Sì Sì
Set query string parameter (Imposta parametro di stringa della query) Aggiunge o elimina il parametro della stringa di query della richiesta o ne sostituisce il valore. Sì Sì Sì Sì Sì
Rewrite URL (Riscrivi URL) Converte un URL di richiesta dal formato pubblico al formato previsto dal servizio Web. Sì Sì Sì Sì Sì
Convert JSON to XML (Converti da JSON a XML) Converte il corpo della richiesta o della risposta da JSON a XML. Sì Sì Sì Sì Sì
Convert XML to JSON (Converti da XML a JSON) Converte il corpo della richiesta o della risposta da XML a JSON. Sì Sì Sì Sì Sì
Find and replace string in body (Trova e sostituisci stringa nel corpo) Trova una sottostringa di richiesta o risposta e la sostituisce con una substring diversa. Sì Sì Sì Sì Sì
Mask URLs in content (Maschera URL nel contenuto) Riscrive (maschera) i collegamenti nel corpo della risposta in modo che puntino al collegamento equivalente tramite il gateway. Sì Sì Sì Sì Sì
Transform XML using an XSLT (Trasforma XML usando XSLT) Applica una trasformazione XSL all'XML nel corpo della richiesta o della risposta. Sì Sì Sì Sì Sì
Restituire la risposta Interrompe l'esecuzione della pipeline e restituisce la risposta specificata direttamente al chiamante. Sì Sì Sì Sì Sì
Simulare la risposta Interrompe l'esecuzione della pipeline e restituisce una risposta fittizia direttamente al chiamante. Sì Sì Sì Sì Sì

Tra domini

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Permetti chiamate tra i domini Rende l'API accessibile da client Adobe Flash e Microsoft Silverlight basati su browser. Sì Sì Sì Sì Sì
CORS Aggiunge il supporto per Condivisione risorse tra le origini (CORS) a un'operazione o a un'API per permettere le chiamate tra domini da client basati su browser. Sì Sì Sì Sì Sì
JSONP Aggiunge il supporto per JSON con riempimento (JSONP) a un'operazione o a un'API per permettere le chiamate tra domini da client JavaScript basati su browser. Sì Sì Sì Sì Sì

Integrazione e comunicazione esterna

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Inviare la richiesta Invia una richiesta all'URL specificato. Sì Sì Sì Sì Sì
Inviare la richiesta unidirezionale Invia una richiesta all'URL specificato senza attendere una risposta. Sì Sì Sì Sì Sì
Registrare nell'hub eventi Invia messaggi nel formato specificato a un hub eventi definito da un'entità Logger. Sì Sì Sì Sì Sì
Inviare la richiesta a un servizio (Dapr) Usa il runtime Dapr per individuare e comunicare in modo affidabile con un microservizio Dapr. Per altre informazioni sulla chiamata al servizio in Dapr, vedere la descrizione in questo file README. No No No Sì No
Inviare il messaggio all'argomento di pubblicazione e sottoscrizione (Dapr) Usa il runtime Dapr per pubblicare un messaggio in un argomento di pubblicazione e sottoscrizione. Per altre informazioni sulla messaggistica di pubblicazione e sottoscrizione, vedere la descrizione in questo file README. No No No Sì No
Attivare l'associazione di output (Dapr) Usa il runtime Dapr per richiamare un sistema esterno tramite l'associazione di output. Per altre informazioni sulle associazioni in Dapr, vedere la descrizione in questo file README. No No No Sì No

Registrazione

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Traccia Aggiunge tracce personalizzate nell'output di traccia della richiesta nella console di test, nelle telemetrie di Application Insights e nei log delle risorse. Sì Sì1 Sì Sì Sì
Generare le metriche Invia metriche personalizzate ad Application Insights in fase di esecuzione. Sì Sì Sì Sì Sì
Generare le metriche dei token OpenAI di Azure Invia ad Application Insights le metriche relative al consumo dei token del modello linguistico di grandi dimensioni tramite le API del servizio OpenAI di Azure. Sì Sì No Sì Sì
Generare metriche del token API del modello linguistico di grandi dimensioni Invia metriche ad Application Insights per l'utilizzo di token LLM (Large Language Model) tramite le API LLM. Sì Sì No Sì Sì

1 Nel gateway V2 il criterio trace attualmente non aggiunge l'output di traccia nella console di test.

Resolver GraphQL

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Origine dati di Azure SQL per il resolver Configura la richiesta di Azure SQL e la risposta facoltativa per risolvere i dati per un tipo di oggetto e un campo in uno schema GraphQL. Sì Sì No No No
Origine dati di Cosmos DB per il resolver Configura la richiesta di Cosmos DB e la risposta facoltativa per risolvere i dati per un tipo di oggetto e un campo in uno schema GraphQL. Sì Sì No No No
Origine dati HTTP per il resolver Consente di configurare la richiesta HTTP e, facoltativamente, la risposta HTTP per risolvere i dati relativi a un tipo di oggetto e un campo in uno schema GraphQL. Sì Sì Sì No No
Pubblicare l'evento nella sottoscrizione GraphQL Pubblica un evento in una o più sottoscrizioni specificate in uno schema dell'API GraphQL. Configura i criteri in un resolver GraphQL per un campo correlato nello schema per un altro tipo di operazione, ad esempio una mutazione. Sì Sì Sì No No

Controllo e flusso dei criteri

Criterio Descrizione Classico V2 Consumo Self-hosted Area di lavoro
Flusso di controllo Applica in modo condizionale istruzioni dei criteri in base ai risultati della valutazione delle espressioni booleane. Sì Sì Sì Sì Sì
Includere il frammento Inserisce un frammento di criterio nella definizione del criterio. Sì Sì Sì Sì Sì
Riprova Ripete l'esecuzione delle istruzioni dei criteri, se e fino a quando non viene soddisfatta la condizione. L'esecuzione verrà ripetuta a specifici intervalli di tempo e per il numero di tentativi indicato. Sì Sì Sì Sì Sì
Wait. Attende il completamento dei criteri inclusi per l'invio della richiesta, il recupero del valore dalla cache o il flusso di controllo prima di procedere. Sì Sì Sì Sì Sì

Contenuto correlato

Per ulteriori informazioni sull'utilizzo dei criteri, vedere: