Brána rozhraní API ve službě Azure API Management
PLATÍ PRO: Všechny úrovně služby API Management
Tento článek obsahuje informace o rolích a funkcích komponenty brány služby API Management a porovnává brány, které můžete nasadit.
Související informace:
Přehled scénářů, komponent a konceptů služby API Management najdete v tématu Co je Azure API Management?
Další informace o úrovních a funkcích služby API Management najdete tady:
- Úrovně služby API Management
- Porovnání úrovní služby Azure API Management na základě funkcí
Role brány
Brána služby API Management (označovaná také jako rovina dat nebo modul runtime) je komponenta služby, která zodpovídá za požadavky rozhraní API proxy, uplatňování zásad a shromažďování telemetrie.
Konkrétně brána:
- Funguje jako fasáda do back-endových služeb tím, že přijímá volání rozhraní API a směruje je do příslušných back-endů.
- Ověřuje klíče rozhraní API a další přihlašovací údaje, jako jsou tokeny JWT a certifikáty prezentované s požadavky.
- Vynucuje kvóty využití a omezení četnosti.
- Volitelně transformuje požadavky a odpovědi uvedené v prohlášeních o zásadách.
- Pokud je nakonfigurovaná, ukládá odpovědi do mezipaměti, aby se zlepšila latence odpovědí a minimalizovala se zatížení back-endových služeb.
- Generuje protokoly, metriky a trasování pro monitorování, vytváření sestav a řešení potíží.
Poznámka:
Všechny požadavky na bránu služby API Management, včetně těch, které konfigurace zásad odmítly, se počítají do nakonfigurovaných limitů sazby, kvót a fakturačních limitů, pokud jsou použity na úrovni služby.
Spravované a hostované v místním prostředí
API Management nabízí spravované i hostované brány:
Spravovaná brána je výchozí komponenta brány nasazená v Azure pro každou instanci služby API Management v každé úrovni služby. Se spravovanou bránou prochází veškerý provoz rozhraní API přes Azure bez ohledu na to, kde se hostují back-endy implementované rozhraní API.
Poznámka:
Vzhledem k rozdílům v základní architektuře služby mají brány poskytované v různých úrovních služby API Management určité rozdíly v možnostech. Podrobnosti najdete v části Porovnání funkcí: Spravované a hostované brány.
V místním prostředí je brána v místním prostředí volitelná kontejnerizovaná verze výchozí spravované brány, která je dostupná ve vybraných úrovních služby. Je užitečné pro hybridní a multicloudové scénáře, kdy je potřeba spouštět brány z Azure ve stejných prostředích, kde jsou hostované back-endy rozhraní API. Brána v místním prostředí umožňuje zákazníkům s hybridní IT infrastrukturou spravovat rozhraní API hostovaná místně i napříč cloudy z jedné služby API Management v Azure.
Brána v místním prostředí je zabalená jako kontejner Dockeru založený na Linuxu a běžně se nasazuje do Kubernetes, včetně Azure Kubernetes Service a Kubernetes s podporou Azure Arc.
Každá brána v místním prostředí je přidružená k prostředku brány v cloudové instanci služby API Management, ze které přijímá aktualizace konfigurace a komunikuje se stavem.
Důležité
Podpora místních imagí kontejnerů služby Azure API Management verze 0 a verze 1 končí 1. října 2023 spolu s odpovídajícím konfiguračním rozhraním API v1. Pomocí našeho průvodce migrací můžete používat místní bránu verze 2.0.0 nebo vyšší s rozhraním CONFIGURATION API v2. Další informace najdete v naší dokumentaci k vyřazení
Porovnání funkcí: Spravované a hostované brány
Následující tabulky porovnávají funkce dostupné v následujících branách služby API Management:
- Classic – spravovaná brána dostupná v úrovních služby Developer, Basic, Standard a Premium (dříve seskupené jako vyhrazené úrovně)
- V2 – spravovaná brána dostupná na úrovních Basic v2 a Standard v2
- Consumption – spravovaná brána dostupná ve vrstvě Consumption
- V místním prostředí – volitelná brána v místním prostředí dostupná ve vybraných úrovních služby
Poznámka:
- Některé funkce spravovaných a hostovaných bran se podporují jenom v určitých úrovních služby nebo v určitých prostředích nasazení pro brány v místním prostředí.
- U aktuálních podporovaných funkcí brány v místním prostředí se ujistěte, že jste upgradovali na nejnovější hlavní verzi image kontejneru brány v místním prostředí.
- Viz také omezení brány v místním prostředí.
Infrastruktura
| Podpora funkcí | Klasické | V2 | Využití | V místním prostředí |
|---|---|---|---|---|
| Vlastní domény | ✔️ | ✔️ | ✔️ | ✔️ |
| Integrovaná mezipaměť | ✔️ | ✔️ | ❌ | ❌ |
| Externí mezipaměť kompatibilní s Redisem | ✔️ | ✔️ | ✔️ | ✔️ |
| Injektáž virtuální sítě | Vývojář, Premium | ❌ | ❌ | ✔️1,2 |
| Příchozí privátní koncové body | Vývojář, Basic, Standard, Premium | ❌ | ❌ | ❌ |
| Integrace odchozí virtuální sítě | ❌ | Standard V2 | ❌ | ❌ |
| Zóny dostupnosti | Premium | ❌ | ❌ | ✔️1 |
| Nasazení ve více oblastech | Premium | ❌ | ❌ | ✔️1 |
| Kořenové certifikáty certifikační autority pro ověření certifikátu | ✔️ | ✔️ | ❌ | ✔️3 |
| Kořenové certifikáty certifikační autority pro ověření certifikátu | ✔️ | ✔️ | ❌ | ✔️3 |
| Spravované certifikáty domény | Vývojář, Basic, Standard, Premium | ❌ | ✔️ | ❌ |
| Nastavení protokolu TLS | ✔️ | ✔️ | ✔️ | ✔️ |
| HTTP/2 (klient-brána) | ✔️4 | ✔️4 | ❌ | ✔️ |
| HTTP/2 (gateway-to-back-end) | ❌ | ❌ | ❌ | ✔️ |
| Detekce hrozeb rozhraní API s využitím Defenderu pro rozhraní API | ✔️ | ✔️ | ❌ | ❌ |
1 Závisí na tom, jak se brána nasadí, ale zodpovídá za zákazníka.
2 Připojení ivity koncového bodu konfigurace brány v2 v2 vyžaduje překlad DNS názvu hostitele koncového bodu.
3Kořenové certifikáty certifikační autority pro bránu v místním prostředí se spravují samostatně na bránu.
4 Klientský protokol musí být povolený.
Back-endová rozhraní API
| Podpora funkcí | Klasické | V2 | Využití | V místním prostředí |
|---|---|---|---|---|
| Specifikace OpenAPI | ✔️ | ✔️ | ✔️ | ✔️ |
| Specifikace WSDL | ✔️ | ✔️ | ✔️ | ✔️ |
| Specifikace WADL | ✔️ | ✔️ | ✔️ | ✔️ |
| Aplikace logiky | ✔️ | ✔️ | ✔️ | ✔️ |
| App Service | ✔️ | ✔️ | ✔️ | ✔️ |
| Function App | ✔️ | ✔️ | ✔️ | ✔️ |
| Kontejnerová aplikace | ✔️ | ✔️ | ✔️ | ✔️ |
| Service Fabric | Vývojář, Premium | ❌ | ❌ | ❌ |
| Průchozí grafQL | ✔️ | ✔️ | ✔️ | ✔️ |
| Syntetická funkce GraphQL | ✔️ | ✔️ | ✔️1 | ✔️1 |
| Průchozí sada WebSocket | ✔️ | ✔️ | ❌ | ✔️ |
| Průchozí gRPC (Preview) | ❌ | ❌ | ❌ | ✔️ |
| OData (Preview) | ✔️ | ✔️ | ✔️ | ✔️ |
| Průchozí grafQL | ✔️ | ✔️ | ✔️ | ✔️ |
| Azure OpenAI | ✔️ | ✔️ | ✔️ | ✔️ |
| Jistič v back-endu (Preview) | ✔️ | ✔️ | ❌ | ✔️ |
| Back-endový fond s vyrovnáváním zatížení (Preview) | ✔️ | ✔️ | ✔️ | ✔️ |
1 Syntetická předplatná GraphQL (Preview) se nepodporují.
Zásady
Spravované brány a brány v místním prostředí podporují všechny dostupné zásady v definicích zásad s následujícími výjimkami.
| Podpora funkcí | Klasické | V2 | Využití | Hostované1 |
|---|---|---|---|---|
| Integrace Dapr | ❌ | ❌ | ❌ | ✔️ |
| Překladače GraphQL a ověřování GraphQL | ✔️ | ✔️ | ✔️ | ❌ |
| Získání kontextu autorizace | ✔️ | ✔️ | ✔️ | ❌ |
| Kvóta a omezení rychlosti | ✔️ | ✔️2 | ✔️3 | ✔️4 |
1 Nakonfigurované zásady, které brána v místním prostředí nepodporuje, se během provádění zásad přeskočí.
2 Kvóta podle zásad klíčů není na úrovních v2 dostupná.
2 Omezení rychlosti podle klíče a kvóty podle zásad klíčů není na úrovni Consumption k dispozici.
3 Počty omezení rychlosti v bráně v místním prostředí je možné nakonfigurovat tak, aby se synchronizovaly místně (mezi instancemi bran napříč uzly clusteru), například prostřednictvím nasazení chartu Helm pro Kubernetes nebo pomocí šablon nasazení webu Azure Portal. Počty omezení rychlosti se ale nesynchronizují s jinými prostředky brány nakonfigurovanými v instanci služby API Management, včetně spravované brány v cloudu. Další informace
Sledování
Podrobnosti o možnostech monitorování najdete v tématu Pozorovatelnost ve službě Azure API Management.
| Podpora funkcí | Klasické | V2 | Využití | V místním prostředí |
|---|---|---|---|---|
| Analýza rozhraní API | ✔️ | ✔️1 | ❌ | ❌ |
| Application Insights | ✔️ | ✔️ | ✔️ | ✔️ |
| Protokolování prostřednictvím služby Event Hubs | ✔️ | ✔️ | ✔️ | ✔️ |
| Metriky ve službě Azure Monitor | ✔️ | ✔️ | ✔️ | ✔️ |
| Kolekce OpenTelemetry | ❌ | ❌ | ❌ | ✔️ |
| Vyžádání protokolů ve službě Azure Monitor a Log Analytics | ✔️ | ✔️ | ❌ | ❌2 |
| Místní metriky a protokoly | ❌ | ❌ | ❌ | ✔️ |
| Trasování požadavků | ✔️ | ❌3 | ✔️ | ✔️ |
1 Vrstvy v2 podporují analýzy založené na službě Azure Monitor.
2 Brána v místním prostředí v současné době do služby Azure Monitor neodesílá protokoly prostředků (diagnostické protokoly). Volitelně můžete posílat metriky do služby Azure Monitor nebo nakonfigurovat a zachovat protokoly místně , kde je nasazená brána v místním prostředí.
3 Trasování je momentálně nedostupné na úrovních v2.
Ověřování a autorizace
Spravované brány a brány v místním prostředí podporují všechny dostupné možnosti ověřování a autorizace rozhraní API s následujícími výjimkami.
| Podpora funkcí | Klasické | V2 | Využití | V místním prostředí |
|---|---|---|---|---|
| Správce přihlašovacích údajů | ✔️ | ✔️ | ✔️ | ❌ |
Propustnost a škálování brány
Důležité
Propustnost je ovlivněna počtem a rychlostí souběžných klientských připojení, druhem a počtem nakonfigurovaných zásad, velikostí datových částí, výkonem back-endového rozhraní API a dalšími faktory. Propustnost brány v místním prostředí závisí také na výpočetní kapacitě (procesoru a paměti) hostitele, na kterém běží. Proveďte zátěžové testování brány s využitím očekávaných produkčních podmínek, abyste přesně určili očekávanou propustnost.
Spravovaná brána
Odhadovanou maximální propustnost brány na úrovních služby API Management najdete v tématu Ceny služby API Management.
Důležité
Údaje o propustnosti jsou uvedeny pouze pro informace a nesmí se spoléhat na plánování kapacity a rozpočtu. Podrobnosti najdete na stránce s cenami služby API Management.
Klasické úrovně
- Kapacitu brány můžete škálovat přidáním a odebráním jednotek škálování nebo upgradem úrovně služby. (Škálování není dostupné na úrovni Developer.)
- Na úrovních Basic, Standard a Premium volitelně nakonfigurujte automatické škálování služby Azure Monitor.
- Na úrovni Premium volitelně přidejte a distribuujte kapacitu brány napříč několika oblastmi.
úrovně v2
- Kapacitu brány můžete škálovat přidáním a odebráním jednotek škálování nebo upgradem úrovně služby.
Úroveň Consumption
- Instance služby API Management na úrovni Consumption se automaticky škálují v závislosti na provozu.
Brána v místním prostředí
- V prostředích, jako je Kubernetes, přidejte několik replik brány pro zpracování očekávaného využití.
- Volitelně můžete nakonfigurovat automatické škálování tak, aby splňovalo požadavky na provoz.
Související obsah
- Další informace o službě API Management v hybridním a multicloudovém světě
- Další informace o používání metriky kapacity pro rozhodování o škálování
- Informace o možnostech pozorovatelnosti ve službě API Management