check-header
SI APPLICA A: Tutti i livelli di Gestione API
Usare il criterio check-header per applicare una richiesta che presenta un'intestazione HTTP specificata. Facoltativamente, è possibile verificare se l'intestazione ha un valore specifico o uno di un intervallo di valori consentiti. Se la verifica ha esito negativo, il criterio termina l'elaborazione della richiesta e restituisce il codice di stato HTTP e il messaggio di errore specificati dai criteri.
Nota
Impostare gli elementi e gli elementi figlio del criterio nell'ordine specificato nell'istruzione del criterio. Altre informazioni su come impostare o modificare i criteri di API Management.
Istruzione del criterio
<check-header name="header name" failed-check-httpcode="code" failed-check-error-message="message" ignore-case="true | false">
<value>Value1</value>
<value>Value2</value>
</check-header>
Attributi
| Attributo | Descrizione | Richiesto | Valore predefinito |
|---|---|---|---|
| name | Il nome dell'intestazione HTTP da verificare. Le espressioni di criteri sono consentite. | Sì | N/D |
| failed-check-httpcode | Codice di stato HTTP da restituire se l'intestazione non esiste o presenta un valore non valido. Le espressioni di criteri sono consentite. | Sì | N/D |
| failed-check-error-message | Messaggio di errore da restituire nel corpo della risposta HTTP se l'intestazione non esiste o presenta un valore non valido. I caratteri speciali eventualmente contenuti in questo messaggio devono essere adeguatamente preceduti da un carattere di escape. Le espressioni di criteri sono consentite. | Sì | N/D |
| ignore-case | Booleano. Se impostato su true, il maiuscolo viene ignorato quando il valore dell'intestazione viene confrontato con il set di valori accettabili. Le espressioni di criteri sono consentite. |
Sì | N/D |
Elementi
| Elemento | Descrizione | Richiesto |
|---|---|---|
| value | Aggiungere uno o più di questi elementi per specificare i valori di intestazione HTTP consentiti. Quando vengono specificati più elementi per value, in caso di corrispondenza di uno dei valori il controllo ha esito positivo. |
No |
Utilizzo
- Sezioni del criterio: inbound
- Ambiti del criterio: globale, prodotto, API, operazione
- Gateway: classico, v2, consumo, self-hosted, area di lavoro
Esempio
<check-header name="Authorization" failed-check-httpcode="401" failed-check-error-message="Not authorized" ignore-case="false">
<value>f6dc69a089844cf6b2019bae6d36fac8</value>
</check-header>
Criteri correlati
Contenuto correlato
Per ulteriori informazioni sull'utilizzo dei criteri, vedere:
- Esercitazione: trasformare e proteggere l'API
- Informazioni di riferimento sui criteri per un elenco completo delle istruzioni dei criteri e delle relative impostazioni
- Espressioni di criteri
- Impostare o modificare criteri
- Riutilizzare le configurazioni dei criteri
- Repository dei frammenti di criteri
- Creare criteri usando Microsoft Copilot in Azure