Brama interfejsu API w usłudze Azure API Management

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule opisano role i funkcje składnika bramy usługi API Management. Porównuje również bramy, które można wdrożyć.

Powiązane informacje:

Rola bramy sieciowej

Brama API Management (nazywana także płaszczyzną danych lub środowiskiem uruchomieniowym) jest składnikiem usługi odpowiedzialnym za proxyowanie żądań API, stosowanie zasad i zbieranie danych telemetrycznych.

W szczególności brama:

Note

Wszystkie żądania do bramy usługi API Management, w tym żądania odrzucone przez konfiguracje zasad, są liczone do skonfigurowanych limitów szybkości, przydziałów i limitów rozliczeniowych, jeśli warstwa usługi je stosuje.

Bramy zarządzane i samodzielnie hostowane

Usługa API Management oferuje zarówno bramy zarządzane, jak i własne:

  • Managed — Managed Gateway jest domyślnym komponentem bramy, który Azure wdraża dla każdego wystąpienia API Management w każdym poziomie usługi. Możesz również skojarzyć autonomiczną bramę zarządzaną z obszarem roboczym w wystąpieniu usługi API Management w wybranych warstwach usług. Korzystając z bramy zarządzanej, cały ruch interfejsów API przepływa przez platformę Azure niezależnie od tego, gdzie są hostowane zaplecza implementujące interfejsy API.

    Note

    Ze względu na różnice w podstawowej architekturze usługi bramy dostępne w różnych warstwach usługi API Management mają pewne różnice w możliwościach. Aby uzyskać szczegółowe informacje, zobacz sekcję Porównanie funkcji: Bramy zarządzane i samodzielnie hostowane.

  • Self-hostedSamodzielnie hostowana brama to opcjonalna, konteneryzowana wersja domyślnej bramy zarządzanej, dostępna w wybranych poziomach usług. Jest to przydatne w scenariuszach hybrydowych i wielochmurowych, w których wymagane jest uruchamianie bram poza platformą Azure w tych samych środowiskach, w których są hostowane zaplecza interfejsu API. Brama hostowana samodzielnie umożliwia klientom korzystanie z infrastruktury IT typu hybrydowego do zarządzania interfejsami API hostowanymi lokalnie i w różnych chmurach publicznych za pomocą jednej usługi zarządzania API w Azure.

    • Brama hostowana samodzielnie jest spakowana jako kontener platformy Docker oparty na systemie Linux i jest często wdrażana na platformie Kubernetes, w tym w usługach Azure Kubernetes Service i Kubernetes z obsługą usługi Azure Arc.

    • Każda brama samodzielnie hostowana jest skojarzona z zasobem bramy w wystąpieniu API Management hostowanym w chmurze, z którego otrzymuje aktualizacje konfiguracji i zgłasza stan.

Porównanie funkcji: bramy zarządzane i własne

Poniższe tabele porównują funkcje dostępne w następujących bramach usługi API Management:

  • Klasyczny — brama zarządzana dostępna w warstwach usługi Developer, Basic, Standard i Premium (wcześniej pogrupowana jako warstwy dedykowane )
  • V2 — brama zarządzana dostępna w warstwach Podstawowa v2, Standardowa v2 i Premium v2
  • Użycie — brama zarządzana dostępna w warstwie Zużycie
  • Self-hosted — opcjonalna brama zainstalowana na własnym serwerze, dostępna w wybranych warstwach usług
  • Obszar roboczy - zarządzana brama dostępna w obszarze roboczym na wybranych poziomach usług

Note

  • Niektóre funkcje zarządzanych i samodzielnie hostowanych bram są obsługiwane tylko w niektórych warstwach usług lub w niektórych środowiskach wdrożeniowych dla samodzielnie hostowanych bram.
  • Aby wyświetlić bieżące obsługiwane funkcje bramy hostowanej samodzielnie, upewnij się, że uaktualniono do najnowszej głównej wersji obrazu kontenera.
  • Zobacz również ograniczenia bramy hostowanej samodzielnie.

Infrastruktura

Obsługa funkcji Classic V2 Zużycie Self-hosted Workspace
Niestandardowe domeny ✔️ ✔️ ✔️ ✔️
Wbudowana pamięć podręczna ✔️ ✔️ ✔️
Zewnętrzna pamięć podręczna zgodna z usługą Redis ✔️ ✔️ ✔️ ✔️
Wstrzykiwanie sieci wirtualnej Deweloper, Premium Premium, wersja 2 ✔️1,2 ✔️
Przychodzące prywatne punkty końcowe ✔️ Standardowa v2, Premium v2
Integracja wychodzącej sieci wirtualnej Standardowa v2, Premium v2 ✔️
Strefy dostępności Premium Premium, wersja 2 ✔️1
Wdrażanie w wielu regionach Premium ✔️1
Root certyfikaty CA do weryfikacji certyfikatów ✔️ ✔️6 ✔️3
Certyfikaty domeny zarządzanej ✔️ ✔️
Ustawienia protokołu TLS ✔️ ✔️ ✔️ ✔️
HTTP/2 (klient-brama) ✔️4 ✔️4 ✔️
HTTP/2 (Brama do zaplecza) ✔️7 ✔️5
Wykrywanie zagrożeń w Defenderze dla interfejsów API ✔️ ✔️

1 Zależy od sposobu wdrażania bramy, ale odpowiada za to klient.
2 Łączność z własnym punktem końcowym konfiguracji bramy w wersji 2 wymaga rozpoznawania NAZW DNS nazwy hosta punktu końcowego.
3 certyfikaty główne urzędu certyfikacji dla bramy hostowanej samodzielnie są zarządzane oddzielnie dla każdej bramy.
4 Należy włączyć protokół klienta.
5 . Skonfiguruj przy użyciu zasad żądania przesyłania dalej .
6 Skonfiguruj szczegóły certyfikatu urzędu certyfikacji dla uwierzytelniania certyfikatu backendowego w ustawieniach zaplecza.
7 W wersji próbnej dla wystąpień warstwy klasycznej utworzonych od stycznia 2026 r. Skontaktuj się z pomocą techniczną, aby włączyć tę funkcję dla istniejących wystąpień warstwy klasycznej.

Interfejsy API dla zaplecza

Obsługa funkcji Classic V2 Zużycie Self-hosted Workspace
Specyfikacja interfejsu OpenAPI ✔️ ✔️ ✔️ ✔️ ✔️
Specyfikacja WSDL ✔️ ✔️ ✔️ ✔️ ✔️
Specyfikacja WADL ✔️ ✔️ ✔️ ✔️ ✔️
Aplikacja logiki ✔️ ✔️ ✔️ ✔️ ✔️
App Service ✔️ ✔️ ✔️ ✔️ ✔️
Aplikacja funkcjonalna ✔️ ✔️ ✔️ ✔️ ✔️
Aplikacja kontenera ✔️ ✔️ ✔️ ✔️ ✔️
Service Fabric Deweloper, Premium
Pass-through GraphQL ✔️ ✔️ ✔️ ✔️ ✔️
Syntetyczny grafQL ✔️ ✔️ ✔️1 ✔️1
Przekazywanie protokołu WebSocket ✔️ ✔️ ✔️ ✔️
Przekazywanie gRPC ✔️1 ✔️
OData ✔️ ✔️ ✔️ ✔️ ✔️
Azure OpenAI w modelach firmy Microsoft Foundry oraz w LLMs ✔️ ✔️ ✔️ ✔️ ✔️
Serwer MCP typu pass-through ✔️ ✔️ ✔️
Eksportowanie interfejsu API REST jako serwera MCP ✔️ ✔️ ✔️
Agent A2A ✔️
Wyłącznik w zapleczu serwerowym ✔️ ✔️ ✔️ ✔️
Pula serwerów ze zrównoważonym obciążeniem ✔️ ✔️ ✔️ ✔️ ✔️

1 W wersji zapoznawczej dla wystąpień warstwy klasycznej utworzonych od stycznia 2026 r. Skontaktuj się z pomocą techniczną, aby włączyć tę funkcję dla istniejących wystąpień warstwy klasycznej.

Policies

Bramy zarządzane i samodzielnie hostowane obsługują wszystkie dostępne zasady w definicjach zasad z następującymi wyjątkami. Zobacz dokumentację zasad, aby uzyskać szczegółowe informacje o poszczególnych zasadach.

Obsługa funkcji Classic V2 Zużycie Self-hosted1 Workspace
Integracja Dapr ✔️
Integracja z usługą Service Bus (wersja zapoznawcza) ✔️ ✔️ ✔️
Narzędzia rozpoznawania języka GraphQL i walidacja języka GraphQL ✔️ ✔️ ✔️
Pobierz kontekst autoryzacji ✔️ ✔️ ✔️
Uwierzytelnianie przy użyciu tożsamości zarządzanej ✔️ ✔️ ✔️ ✔️
Buforowanie semantyczne usług Azure OpenAI oraz LLM ✔️ ✔️ ✔️
Limity i ograniczenia przepustowości ✔️ ✔️ ✔️2 ✔️3 ✔️

1 Skonfigurowane zasady, które nie są obsługiwane przez samodzielnie hostowaną bramę, są pomijane podczas wykonywania polityk.
2 Limit szybkości według klucza, limitu przydziału według klucza i zasad limitu tokenów sztucznej inteligencji nie jest dostępny w warstwie Zużycie.
3 Liczniki limitów przepustowości w bramie samodzielnie hostowanej można skonfigurować do synchronizowania lokalnie (między wystąpieniami bramy w obrębie węzłów klastra), na przykład za pomocą wdrożenia Helm Chart dla platformy Kubernetes lub szablonów wdrożeniowych portalu Azure. Jednak wartości limitów szybkości nie są synchronizowane z innymi zasobami bramy skonfigurowanymi w wystąpieniu usługi API Management, w tym z bramą zarządzaną w chmurze. Dowiedz się więcej

Monitoring

Aby uzyskać szczegółowe informacje na temat opcji monitorowania, zobacz Obserwowanie w usłudze Azure API Management.

Obsługa funkcji Classic V2 Zużycie Self-hosted Workspace
Analiza interfejsu API ✔️ ✔️1
Application Insights ✔️ ✔️ ✔️ ✔️2 ✔️
Rejestrowanie za pośrednictwem usługi Event Hubs ✔️ ✔️ ✔️ ✔️ ✔️
Metryki w usłudze Azure Monitor ✔️ ✔️ ✔️ ✔️
OpenTelemetry Collector ✔️
Dzienniki żądań w usługach Azure Monitor i Log Analytics ✔️ ✔️ 3
Lokalne metryki i dzienniki ✔️
Śledzenie żądań ✔️ ✔️ ✔️ ✔️ ✔️

1 Warstwy wersji v2 obsługują analizę opartą na usłudze Azure Monitor.
2 Brama używa wbudowanego buforu pamięci usługi Azure Application Insights i nie zapewnia gwarancji dostarczania.
3 Brama hostowana samodzielnie nie wysyła obecnie dzienników zasobów (dzienników diagnostycznych) do usługi Azure Monitor. Opcjonalnie wyślij metryki do usługi Azure Monitor lub skonfiguruj i utrwalaj dzienniki lokalnie, gdzie wdrożono bramę, którą sam wdrożyłeś.

Uwierzytelnianie i autoryzacja

Bramy zarządzane i samodzielnie hostowane obsługują wszystkie dostępne opcje uwierzytelniania i autoryzacji API z następującymi wyjątkami.

Obsługa funkcji Classic V2 Zużycie Self-hosted Workspace
Menedżer poświadczeń ✔️ ✔️ ✔️

Przepustowość i skalowanie bramy

Important

Przepływność zależy od wielu czynników, w tym liczby i szybkości współbieżnych połączeń klienckich, rodzaju i liczby skonfigurowanych zasad, rozmiarów ładunków, wydajności interfejsu API zaplecza i innych czynników. Przepływność bramy hostowanej samodzielnie zależy również od pojemności obliczeniowej (procesora CPU i pamięci) hosta, na którym działa. Aby dokładnie określić oczekiwaną przepływność, przeprowadź testowanie obciążenia bramy przy użyciu przewidywanych warunków produkcyjnych.

Brama zarządzana

Aby uzyskać szacowaną maksymalną przepływność bramy w warstwach usługi API Management, zobacz Cennik usługi API Management.

Important

Użyj wartości przepływności tylko dla informacji. Nie polegaj na nich na planowaniu pojemności i budżetu. Aby uzyskać szczegółowe informacje, zobacz Cennik usługi API Management.

  • Poziomy klasyczne

    • Skaluj pojemność bramy, dodając lub usuwając jednostki skalowania, lub podwyższ poziom usług. (Skalowanie nie jest dostępne w warstwie Deweloper).
    • W warstwach Podstawowa, Standardowa i Premium opcjonalnie skonfiguruj automatyczne skalowanie usługi Azure Monitor.
    • W warstwie Premium można opcjonalnie dodać i rozdzielić pojemność bramy w wielu regionach.
  • Poziomy v2

  • Poziom zużycia

    • Wystąpienia usługi API Management w warstwie Zużycie są skalowane automatycznie w zależności od ruchu.

Brama hostowana lokalnie

Brama obszaru roboczego

Zwiększaj pojemność przez dodawanie i usuwanie jednostek skali w bramie obszaru roboczego.

Limity środowiska uruchomieniowego bramy

W poniższej tabeli wymieniono limity, które mają zastosowanie do bramy usługi API Management w przypadku obsługi żądań i odpowiedzi interfejsu API.

Limit czasu działania Classic V2 Zużycie
Równoczesne połączenia zaplecza1 na autorytet HTTP 20482 na jednostkę 2,048 Unlimited
Rozmiar odpowiedzi w pamięci podręcznej 2 MiB 2 MiB 2 MiB
Rozmiar dokumentu zasad 512 KiB 512 KiB 16 KiB
Rozmiar ładunku żądania Unlimited 1 GiB 1 GiB
Rozmiar buforowanego ładunku 500 MiB 2 MiB 2 MiB
Rozmiar ładunku żądania/odpowiedzi w dziennikach diagnostycznych 8 192 bajtów 8 192 bajtów 8 192 bajtów
Rozmiar adresu URL żądania3 Unlimited 16 384 bajtów 16 384 bajtów
Długość segmentu ścieżki adresu URL 1024 znaki 1024 znaki 1024 znaki
Długość nazwanej wartości 4096 znaków 4096 znaków 4096 znaków
Rozmiar treści żądania lub odpowiedzi w zasadach weryfikacji zawartości 100 KiB 100 KiB 100 KiB
Rozmiar schematu interfejsu API używanego przez zasady walidacji 4 MB 4 MB 4 MB
Łączny czas trwania żądania Unlimited 30 sekund 30 sekund
Aktywne połączenia protokołu WebSocket na jednostkę4 5,000 5,000 N/A

1 Połączenia są gromadzone w pulach i ponownie wykorzystywane, chyba że są jawnie zamknięte przez serwer.
2 Limit wynosi 1024 w warstwie Deweloper.
3 zawiera do 2048-bajtowy długi ciąg zapytania.
4 Maksymalnie 60 000 połączeń na wystąpienie usługi.

Punkt końcowy sprawdzania kondycji bramy sieciowej

We wszystkich warstwach z wyjątkiem warstwy Zużycie usługa Azure API Management udostępnia wbudowany punkt końcowy sprawdzania kondycji bramy w ścieżce /status-0123456789abcdef. Skontaktuj się z tym punktem końcowym, aby upewnić się, że brama interfejsu API jest dostępna i działa prawidłowo. Nie testuje interfejsów API zaplecza, tylko samej bramy.

Żądanie do punktu końcowego zwraca 200 OK odpowiedź HTTP, gdy brama jest sprawna; niepowodzenia wskazują problemy z siecią lub bramą.

  • Platforma Azure używa tego punktu końcowego wewnętrznie do ciągłego monitorowania realizacji SLA i walidacji kondycji bramy.
  • Klienci mogą integrować żądania do tego punktu końcowego z własnymi narzędziami monitorowania i sondami.
  • Punkt końcowy jest dostępny dla bram zarządzanych (w tym bram regionalnych we wdrożeniach w wielu regionach), bram zainstalowanych lokalnie i bram obszarów roboczych.

Wskazówka

Po zintegrowaniu usługi Azure Application Insights z usługą API Management możesz opcjonalnie włączyć monitorowanie dostępności bramy. To ustawienie cyklicznie sprawdza punkt kontrolny sprawdzania kondycji bramy i raportuje wyniki na karcie Dostępność w usłudze Application Insights.

Dowiedz się więcej o: