Sprawdzanie nagłówka HTTP
DOTYCZY: Wszystkie warstwy usługi API Management
Użyj zasad, check-header
aby wymusić, że żądanie ma określony nagłówek HTTP. Opcjonalnie możesz sprawdzić, czy nagłówek ma określoną wartość, czy jedną z dozwolonych wartości. Jeśli sprawdzanie zakończy się niepowodzeniem, zasady zakończą przetwarzanie żądań i zwracają kod stanu HTTP i komunikat o błędzie określony przez zasady.
Uwaga
Ustaw elementy zasad i elementy podrzędne w kolejności podanej w instrukcji zasad. Dowiedz się więcej na temat ustawiania lub edytowania zasad usługi API Management.
Instrukcja zasad
<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>
Atrybuty
Atrybut | opis | Wymagani | Wartość domyślna |
---|---|---|---|
name | Nazwa nagłówka HTTP do sprawdzenia. Wyrażenia zasad są dozwolone. | Tak | Nie dotyczy |
failed-check-httpcode | Kod stanu HTTP zwracany, jeśli nagłówek nie istnieje lub ma nieprawidłową wartość. Wyrażenia zasad są dozwolone. | Tak | Nie dotyczy |
failed-check-error-message | Komunikat o błędzie zwracany w treści odpowiedzi HTTP, jeśli nagłówek nie istnieje lub ma nieprawidłową wartość. Ten komunikat musi mieć poprawnie znaki specjalne. Wyrażenia zasad są dozwolone. | Tak | Nie dotyczy |
ignoruj wielkość liter | Wartość logiczna. Jeśli ustawiono true wartość , wielkość liter jest ignorowana, gdy wartość nagłówka jest porównywana z zestawem dopuszczalnych wartości. Wyrażenia zasad są dozwolone. |
Tak | Nie dotyczy |
Elementy
Element | opis | Wymagania |
---|---|---|
wartość | Dodaj co najmniej jeden z tych elementów, aby określić dozwolone wartości nagłówka HTTP. Po określeniu wielu value elementów sprawdzanie jest uznawane za powodzenie, jeśli którakolwiek z wartości jest zgodna. |
Nie. |
Użycie
- Sekcje zasad: ruch przychodzący
- Zakresy zasad: globalny, produkt, interfejs API, operacja
- Bramy: klasyczne, v2, zużycie, self-hosted, obszar roboczy
Przykład
<check-header name="Authorization" failed-check-httpcode="401" failed-check-error-message="Not authorized" ignore-case="false">
<value>f6dc69a089844cf6b2019bae6d36fac8</value>
</check-header>
Powiązane zasady
Powiązana zawartość
Aby uzyskać więcej informacji na temat pracy z zasadami, zobacz:
- Samouczek: przekształcanie i ochrona interfejsu API
- Dokumentacja zasad dla pełnej listy instrukcji zasad i ich ustawień
- Wyrażenia zasad
- Ustawianie lub edytowanie zasad
- Ponowne używanie konfiguracji zasad
- Repozytorium fragmentów zasad
- Tworzenie zasad przy użyciu rozwiązania Microsoft Copilot na platformie Azure