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. Vengono indicati i gateway Gestione API che supportano ogni criterio. Per informazioni dettagliate sulle impostazioni dei criteri e sugli esempi, vedere gli articoli di riferimento collegati.

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
Limita frequenza delle chiamate per sottoscrizione Impedisce picchi di utilizzo dell'API limitando la frequenza delle chiamate, in base alla sottoscrizione. Sì Sì Sì Sì
Limitare la frequenza delle chiamate in base alla chiave Impedisce picchi di utilizzo dell'API limitando la frequenza delle chiamate, in base alla chiave. Sì Sì No Sì
Imposta quota di utilizzo per sottoscrizione Consente di applicare un volume di chiamate rinnovabile o di durata e/o una quota di larghezza di banda, per ogni sottoscrizione. Sì Sì Sì Sì
Impostare la quota di utilizzo per chiave Consente di applicare un volume di chiamate rinnovabile o di durata e/o una quota di larghezza di banda per ogni chiave. Sì No No Sì
Limitare la concorrenza Impedisce l'esecuzione di criteri racchiusi da più del numero specificato di richieste alla volta. Sì Sì Sì Sì

Autenticazione e autorizzazione

Criterio Descrizione Classico V2 Consumo Self-hosted
check-header Applica l'esistenza e/o il valore di un'intestazione HTTP. Sì Sì Sì Sì
Ottieni codice di autorizzazione Ottiene il contesto di autorizzazione di una connessione specificata a un provider di credenziali configurato nell'istanza di Gestione API. Sì Sì Sì No
ip-filter Filtri (consente/nega) chiamate da indirizzi IP e/o intervalli di indirizzi specifici. Sì Sì Sì Sì
Convalidare il token Microsoft Entra Applica l'esistenza e la validità di un token JWT Microsoft Entra (denominato in precedenza Azure Active Directory) estratto da un'intestazione HTTP, un parametro di query o un valore del token specificato. Sì Sì Sì Sì
validate-JWT Applica l'esistenza e la validità di un token JWT estratto da un'intestazione HTTP, un parametro di query o un valore del token specificato. 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ì
authentication-basic Esegue l'autenticazione con un servizio back-end usando l'autenticazione di base. Sì Sì Sì Sì
authentication-certificate Esegue l'autenticazione con un servizio back-end usando i certificati client. Sì Sì Sì Sì
Eseguire l'autenticazione con l'identità gestita Esegue l'autenticazione con un servizio back-end usando un'identità gestita. Sì Sì Sì Sì

Convalida del contenuto

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

Definizione dei percorsi di trasferimento

Criterio Descrizione Classico V2 Consumo Self-hosted
Inoltra richiesta Inoltra la richiesta al servizio back-end. Sì Sì Sì Sì
Set backend service (Imposta servizio back-end) Modifica l'URL di base del servizio back-end di una richiesta in ingresso in un URL o in un back-end. Fare riferimento a una risorsa back-end consente di 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 regole di interruttore per proteggere il back-end da troppe richieste. Sì Sì Sì Sì
Impostare il proxy HTTP Consente di instradare le richieste inoltrate tramite un proxy HTTP. Sì Sì Sì Sì

Memorizzazione nella cache

Criterio Descrizione Classico V2 Consumo Self-hosted
Recupera dalla cache Esegue la ricerca della cache e restituisce una risposta memorizzata nella cache valida, se disponibile. Sì Sì Sì Sì
cache-lookup Memorizza nella cache la risposta in base alla configurazione del controllo cache specificata. Sì Sì Sì Sì
Ottenere valore dalla cache Recupera un elemento memorizzato nella cache in base alla chiave. Sì Sì Sì Sì
Archiviare il valore nella cache Archivia un elemento nella cache in base alla chiave. Sì Sì Sì Sì
Rimuovere il valore dalla cache Rimuove un elemento nella cache in base alla chiave. Sì Sì Sì Sì

Trasformazione

Criterio Descrizione Classico V2 Consumo Self-hosted
Impostare il metodo di richiesta Consente di modificare il metodo HTTP per una richiesta. Sì Sì Sì Sì
Impostare il codice di stato Modifica il codice di stato HTTP con il valore specificato. Sì Sì Sì Sì
set-variable Rende persistente un valore in una variabile di contesto denominata per un accesso successivo. Sì Sì Sì Sì
Set body (Imposta corpo) Imposta il corpo del messaggio per una richiesta o una risposta. 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ì
Set query string parameter (Imposta parametro di stringa della query) Aggiunge, sostituisce il valore di o elimina il parametro della stringa di query della richiesta. 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ì
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ì
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ì
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ì
Mask URLs in content (Maschera URL nel contenuto) Riscrive i collegamenti (maschere) nel corpo della risposta in modo che puntino al collegamento equivalente tramite il gateway. Sì Sì Sì Sì
Transform XML using an XSLT (Trasforma XML usando XSLT) Applica una trasformazione XSL a XML nel corpo della richiesta o della risposta. Sì Sì Sì Sì
Risposta restituita Interrompe l'esecuzione della pipeline e restituisce la risposta specificata direttamente al chiamante. Sì Sì Sì Sì
Risposta fittizia Interrompe l'esecuzione della pipeline e restituisce una risposta fittizia direttamente al chiamante. Sì Sì Sì Sì

Tra domini

Criterio Descrizione Classico V2 Consumo Self-hosted
Permetti chiamate tra i domini Rende l'API accessibile dai client basati su browser Adobe Flash e Microsoft Silverlight. Sì Sì Sì Sì
CORS Aggiunge il supporto CORS (Cross-Origin Resource Sharing) a un'operazione o a un'API per consentire chiamate tra domini dai client basati su browser. Sì Sì Sì Sì
JSONP Aggiunge JSON con supporto JSON (JSONP) a un'operazione o a un'API per consentire chiamate tra domini dai client basati su browser JavaScript. Sì Sì Sì Sì

Integrazione e comunicazione esterna

Criterio Descrizione Classico V2 Consumo Self-hosted
Invia richiesta Invia una richiesta all'URL specificato. Sì Sì Sì Sì
Inviare una richiesta unidirezionale Invia una richiesta all'URL specificato senza attendere una risposta. Sì Sì Sì Sì
Accedere all'hub eventi Invia messaggi nel formato specificato a un hub eventi definito da un'entità Logger. Sì Sì Sì Sì
Inviare una 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ì
Inviare un messaggio all'argomento Pub/Sub (Dapr) Usa il runtime Dapr per pubblicare un messaggio in un argomento Publish/Subscribe. Per altre informazioni sulla messaggistica di pubblicazione e sottoscrizione, vedere la descrizione in questo file README. No No No Sì
Associazione di output trigger (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ì

Registrazione

Criterio Descrizione Classico V2 Consumo Self-hosted
Traccia Aggiunge tracce personalizzate nell'output di traccia delle richieste nella console di test, nelle telemetrie di Application Insights e nei log delle risorse. Sì Sì1 Sì Sì
Generare metriche Invia metriche personalizzate ad Application Insights durante l'esecuzione. Sì Sì Sì Sì

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

Resolver GraphQL

Criterio Descrizione Classico V2 Consumo Self-hosted
Origine dati SQL di Azure per resolver Configura la richiesta SQL di Azure e la risposta facoltativa per risolvere i dati per un tipo di oggetto e un campo in uno schema GraphQL. Sì Sì No No
Origine dati cosmos DB per 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
Origine dati HTTP per resolver Configura la richiesta HTTP e, facoltativamente, la risposta HTTP per risolvere i dati per un tipo di oggetto e un campo in uno schema GraphQL. Sì Sì Sì No
Pubblicare un 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

Controllo e flusso dei criteri

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

Contenuto correlato

Per ulteriori informazioni sull'utilizzo dei criteri, vedere: