Udostępnij za pośrednictwem

API Management policy reference

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

Ta sekcja zawiera krótkie opisy i linki do artykułów referencyjnych dotyczących wszystkich zasad usługi API Management. Wskazywane są bramy usługi API Management, które obsługują poszczególne zasady. Aby uzyskać szczegółowe ustawienia zasad i przykłady, zobacz połączone artykuły referencyjne.

Więcej informacji o zasadach:

Ważne

Ograniczanie liczby wywołań według subskrypcji i Ustawianie limitu przydziału użycia według subskrypcji ma zależność od klucza subskrypcji. Klucz subskrypcji nie jest wymagany, gdy są stosowane inne zasady.

Ograniczanie szybkości i limity przydziału

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Ograniczanie liczby wywołań według subskrypcji Zapobiega skokom użycia interfejsu API przez ograniczenie liczby wywołań dla poszczególnych subskrypcji. Tak Tak Tak Tak
Ogranicz szybkość wywołań według klucza Zapobiega skokom użycia interfejsu API przez ograniczenie liczby wywołań na podstawie klucza. Tak Tak Nie Tak
Ustawianie limitu przydziału użycia według subskrypcji Umożliwia wymuszenie woluminu wywołań odnawialnych lub okresów istnienia i/lub limitu przydziału przepustowości dla poszczególnych subskrypcji. Tak Tak Tak Tak
Ustawianie limitu przydziału użycia według klucza Umożliwia wymuszenie woluminu wywołań odnawialnych lub okresów istnienia i/lub limitu przydziału przepustowości dla poszczególnych kluczy. Tak Nie. Nie. Tak
Ograniczanie współbieżności Uniemożliwia wykonywanie zamkniętych zasad przez więcej niż określoną liczbę żądań jednocześnie. Tak Tak Tak Tak
Ograniczanie użycia tokenu usługi Azure OpenAI Zapobiega skokom użycia interfejsu API usługi Azure OpenAI przez ograniczenie dużych tokenów modelu języka na klucz obliczeniowy. Tak Tak Nie. Nie.
Ograniczanie użycia tokenu interfejsu API modelu języka Zapobiega gwałtownym wzrostom użycia interfejsu API modelu języka (LLM), ograniczając tokeny LLM na klucz obliczeniowy. Tak Tak Nie. Nie.

Uwierzytelnianie i autoryzacja

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Sprawdzanie nagłówka HTTP Wymusza istnienie i/lub wartość nagłówka HTTP. Tak Tak Tak Tak
Uzyskiwanie kontekstu autoryzacji Pobiera kontekst autoryzacji określonego połączenia z dostawcą poświadczeń skonfigurowanym w wystąpieniu usługi API Management. Tak Tak Tak Nie.
Ograniczanie adresów IP wywołujących Filtry (zezwalają na/odrzucają) wywołania z określonych adresów IP i/lub zakresów adresów. Tak Tak Tak Tak
Weryfikowanie tokenu firmy Microsoft Entra Wymusza istnienie i ważność entra firmy Microsoft (dawniej o nazwie Azure Active Directory) JWT wyodrębnione z określonego nagłówka HTTP, parametru zapytania lub wartości tokenu. Tak Tak Tak Tak
Weryfikowanie JWT Wymusza istnienie i ważność JWT wyodrębnione z określonego nagłówka HTTP, parametru zapytania lub wartości tokenu. Tak Tak Tak Tak
Weryfikowanie certyfikatu klienta Wymusza, aby certyfikat przedstawiony przez klienta w wystąpieniu usługi API Management był zgodny z określonymi regułami walidacji i oświadczeniami. Tak Tak Tak Tak
Uwierzytelnianie przy użyciu warstwy Podstawowa Uwierzytelnia się przy użyciu usługi zaplecza przy użyciu uwierzytelniania podstawowego. Tak Tak Tak Tak
Uwierzytelnianie przy użyciu certyfikatu klienta Uwierzytelnia się przy użyciu usługi zaplecza przy użyciu certyfikatów klienta. Tak Tak Tak Tak
Uwierzytelnianie przy użyciu tożsamości zarządzanej Uwierzytelnia się przy użyciu usługi zaplecza przy użyciu tożsamości zarządzanej. Tak Tak Tak Tak

Walidacja zawartości

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Weryfikowanie zawartości Weryfikuje rozmiar lub zawartość treści żądania lub odpowiedzi względem co najmniej jednego schematu interfejsu API. Obsługiwane formaty schematu to JSON i XML. Tak Tak Tak Tak
Weryfikowanie żądania GraphQL Weryfikuje i autoryzuje żądanie do interfejsu API GraphQL. Tak Tak Tak Tak
Weryfikowanie żądania OData Sprawdza poprawność żądania do interfejsu API OData w celu zapewnienia zgodności ze specyfikacją OData. Tak Tak Tak Tak
Weryfikowanie parametrów Sprawdza poprawność parametrów nagłówka żądania, zapytania lub ścieżki względem schematu interfejsu API. Tak Tak Tak Tak
Weryfikowanie nagłówków Weryfikuje nagłówki odpowiedzi względem schematu interfejsu API. Tak Tak Tak Tak
Weryfikowanie kodu stanu Sprawdza poprawność kodów stanu HTTP w odpowiedziach względem schematu interfejsu API. Tak Tak Tak Tak

Routing

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Prześlij żądanie dalej Przekazuje żądanie do usługi zaplecza. Tak Tak Tak Tak
Ustaw usługę zaplecza Zmienia podstawowy adres URL usługi zaplecza żądania przychodzącego na adres URL lub zaplecze. Odwoływanie się do zasobu zaplecza umożliwia zarządzanie adresem URL bazy usługi zaplecza i innymi ustawieniami w jednym miejscu. Zaimplementuj również równoważenie obciążenia ruchu w puli usług zaplecza i reguł wyłącznika, aby chronić zaplecze przed zbyt wieloma żądaniami. Tak Tak Tak Tak
Ustawianie serwera proxy HTTP Umożliwia kierowanie przesłanych dalej żądań za pośrednictwem serwera proxy HTTP. Tak Tak Tak Tak

Buforowanie

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Pobieranie z pamięci podręcznej Wykonuje wyszukiwanie w pamięci podręcznej i zwraca prawidłową odpowiedź w pamięci podręcznej, gdy jest dostępna. Tak Tak Tak Tak
Przechowywanie w pamięci podręcznej Buforuje odpowiedź zgodnie z określoną konfiguracją kontrolki pamięci podręcznej. Tak Tak Tak Tak
Pobieranie wartości z pamięci podręcznej Pobiera buforowany element według klucza. Tak Tak Tak Tak
Przechowywanie wartości w pamięci podręcznej Przechowuje element w pamięci podręcznej według klucza. Tak Tak Tak Tak
Usuwanie wartości z pamięci podręcznej Usuwa element w pamięci podręcznej według klucza. Tak Tak Tak Tak
Uzyskiwanie buforowanych odpowiedzi żądań interfejsu API usługi Azure OpenAI Wykonuje wyszukiwanie w pamięci podręcznej interfejsu API OpenAI platformy Azure przy użyciu wyszukiwania semantycznego i zwraca prawidłową odpowiedź w pamięci podręcznej, jeśli jest dostępna. Tak Tak Tak Tak
Przechowywanie odpowiedzi żądań interfejsu API usługi Azure OpenAI do pamięci podręcznej Buforuje odpowiedź zgodnie z konfiguracją pamięci podręcznej interfejsu API OpenAI platformy Azure. Tak Tak Tak Tak
Uzyskiwanie buforowanych odpowiedzi dla dużych żądań interfejsu API modelu językowego Wykonuje wyszukiwanie w pamięci podręcznej interfejsu API modelu dużego języka przy użyciu wyszukiwania semantycznego i zwraca prawidłową odpowiedź w pamięci podręcznej, jeśli jest dostępna. Tak Tak Tak Tak
Przechowywanie odpowiedzi na żądania interfejsu API modelu dużego języka do pamięci podręcznej Buforuje odpowiedź zgodnie z konfiguracją pamięci podręcznej interfejsu API modelu języka. Tak Tak Tak Tak

Przekształcenie

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Ustawianie metody żądania Umożliwia zmianę metody HTTP dla żądania. Tak Tak Tak Tak
Ustawianie kodu stanu Zmienia kod stanu HTTP na określoną wartość. Tak Tak Tak Tak
Ustawianie zmiennej Utrwala wartość w nazwanej zmiennej kontekstowej na potrzeby późniejszego dostępu. Tak Tak Tak Tak
Ustaw treść Ustawia treść komunikatu dla żądania lub odpowiedzi. Tak Tak Tak Tak
Ustaw nagłówek HTTP Przypisuje wartość do istniejącego nagłówka odpowiedzi i/lub żądania bądź dodaje nowy nagłówek odpowiedzi i/lub żądania. Tak Tak Tak Tak
Ustaw parametr ciągu zapytania Dodaje, zastępuje wartość lub usuwa parametr ciągu zapytania żądania. Tak Tak Tak Tak
Ponownie zapisz adres URL Konwertuje publiczną postać adresu URL żądania na postać oczekiwaną przez usługę internetową. Tak Tak Tak Tak
Konwertuj format JSON na XML Konwertuje treść żądania lub odpowiedzi z formatu JSON na XML. Tak Tak Tak Tak
Konwertuj format XML na JSON Konwertuje treść żądania lub odpowiedzi z xml na JSON. Tak Tak Tak Tak
Znajdź i zamień ciąg w treści Znajduje podciąg żądania lub odpowiedzi i zamienia go na inny podciąg. Tak Tak Tak Tak
Maskuj adresy URL w zawartości Ponownie zapisuje łącza (maski) w treści odpowiedzi, aby wskazywały odpowiedni link za pośrednictwem bramy. Tak Tak Tak Tak
Przekształć format XML przy użyciu języka XSLT Stosuje przekształcenie XSL do kodu XML w treści żądania lub odpowiedzi. Tak Tak Tak Tak
Zwracana odpowiedź Przerywa wykonywanie potoku i zwraca określoną odpowiedź bezpośrednio do elementu wywołującego. Tak Tak Tak Tak
Pozorna odpowiedź Przerywa wykonywanie potoku i zwraca pozorowaną odpowiedź bezpośrednio do wywołującego. Tak Tak Tak Tak

Międzydomenowa

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Zezwalaj na wywołania między domenami Udostępnia interfejs API klientom opartym na przeglądarce Adobe Flash i Microsoft Silverlight. Tak Tak Tak Tak
CORS Dodaje obsługę współużytkowania zasobów między źródłami (CORS) do operacji lub interfejsu API, aby umożliwić wywołania między domenami od klientów opartych na przeglądarce. Tak Tak Tak Tak
JSONP Dodaje kod JSON z obsługą uzupełniania (JSONP) do operacji lub interfejsu API w celu umożliwienia wywołań między domenami z klientów opartych na przeglądarce JavaScript. Tak Tak Tak Tak

Integracja i komunikacja zewnętrzna

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Wyślij żądanie Wysyła żądanie do określonego adresu URL. Tak Tak Tak Tak
Wyślij jednokierunkowe żądanie Wysyła żądanie do określonego adresu URL bez oczekiwania na odpowiedź. Tak Tak Tak Tak
Logowanie do centrum zdarzeń Wysyła komunikaty w określonym formacie do centrum zdarzeń zdefiniowanego przez jednostkę rejestratora. Tak Tak Tak Tak
Wysyłanie żądania do usługi (Dapr) Używa środowiska uruchomieniowego języka Dapr do lokalizowania i niezawodnego komunikowania się z mikrousługą Języka Dapr. Aby dowiedzieć się więcej na temat wywołania usługi w języku Dapr, zobacz opis w tym pliku README . Nie Nie. Nie. Tak
Wysyłanie wiadomości do tematu Pub/Sub (Dapr) Używa środowiska uruchomieniowego języka Dapr do publikowania komunikatu w temacie Publikowanie/subskrybowanie. Aby dowiedzieć się więcej na temat publikowania/subskrybowania komunikatów w języku Dapr, zobacz opis w tym pliku README . Nie Nie. Nie. Tak
Powiązanie danych wyjściowych wyzwalacza (Dapr) Używa środowiska uruchomieniowego języka Dapr do wywoływania systemu zewnętrznego za pośrednictwem powiązania wyjściowego. Aby dowiedzieć się więcej o powiązaniach w języku Dapr, zobacz opis w tym pliku README . Nie Nie. Nie. Tak

Rejestrowanie

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Śledzenie Dodaje niestandardowe ślady do danych wyjściowych śledzenia żądań w konsoli testowej, telemetriach usługi Application Insights i dziennikach zasobów. Tak Tak1 Tak Tak
Emituj metryki Wysyła metryki niestandardowe do usługi Application Insights podczas wykonywania. Tak Tak Tak Tak
Emituj metryki tokenu usługi Azure OpenAI Wysyła metryki do usługi Application Insights w celu użycia dużych tokenów modelu językowego za pośrednictwem interfejsów API usługi Azure OpenAI. Tak Tak Nie Tak
Emituj metryki tokenu interfejsu API modelu dużego języka Wysyła metryki do usługi Application Insights w celu użycia dużych tokenów modelu językowego (LLM) za pośrednictwem interfejsów API LLM. Tak Tak Nie Tak

1 W bramie trace w wersji 2 zasady obecnie nie dodają danych wyjściowych śledzenia w konsoli testowej.

Narzędzia rozpoznawania języka GraphQL

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Źródło danych usługi Azure SQL na potrzeby rozpoznawania nazw Konfiguruje żądanie usługi Azure SQL i opcjonalną odpowiedź na potrzeby rozpoznawania danych dla typu obiektu i pola w schemacie GraphQL. Tak Tak Nie. Nie.
Źródło danych usługi Cosmos DB do rozpoznawania nazw Konfiguruje żądanie usługi Cosmos DB i opcjonalną odpowiedź na potrzeby rozpoznawania danych dla typu obiektu i pola w schemacie GraphQL. Tak Tak Nie. Nie.
Źródło danych HTTP dla programu resolver Konfiguruje żądanie HTTP i opcjonalnie odpowiedź HTTP w celu rozpoznania danych dla typu obiektu i pola w schemacie GraphQL. Tak Tak Tak Nie.
Publikowanie zdarzenia w subskrypcji programu GraphQL Publikuje zdarzenie w co najmniej jednej subskrypcji określonej w schemacie interfejsu API GraphQL. Skonfiguruj zasady w narzędziu rozpoznawania GraphQL dla powiązanego pola w schemacie dla innego typu operacji, takiego jak mutacja. Tak Tak Tak Nie.

Sterowanie zasadami i przepływ

Zasada opis Klasyczny Wersja 2 Zużycie Samodzielne hostowanie
Przepływ sterowania Warunkowo stosuje instrukcje zasad na podstawie wyników oceny wyrażeń logicznych. Tak Tak Tak Tak
Dołącz fragment Wstawia fragment zasad w definicji zasad. Tak Tak Tak Tak
Ponów próbę Ponawia próbę wykonania ujętych instrukcji zasad, jeśli i dopóki warunek nie zostanie spełniony. Wykonanie będzie powtarzane w określonych interwałach czasu i do określonej liczby ponownych prób. Tak Tak Tak Tak
Czekaj Przed kontynuowaniem czeka na zamknięte żądanie wysyłania, Pobierz wartość z pamięci podręcznej lub zasady przepływu sterowania. Tak Tak Tak Tak

Powiązana zawartość

Aby uzyskać więcej informacji na temat pracy z zasadami, zobacz: