Zásady API Managementu

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

Tato část obsahuje stručné popisy a odkazy na referenční články pro všechny zásady služby API Management. Jsou označené brány služby API Management, které podporují každou zásadu. Podrobné nastavení zásad a příklady najdete v odkazovaných referenčních článcích.

Další informace o zásadách:

Důležité

Omezení četnosti volání podle předplatného a nastavení kvóty využití podle předplatného má závislost na klíči předplatného. Klíč předplatného se při použití jiných zásad nevyžaduje.

Omezování rychlosti a kvóty

Zásady Popis Klasické V2 Využití V místním prostředí
Omezení četnosti volání podle předplatného Zabraňuje špičkám využití rozhraní API omezením četnosti volání na základě předplatného. Ano Ano Ano Yes
Omezení četnosti volání podle klíče Zabraňuje špičkám využití rozhraní API omezením četnosti volání na základě klíče. Ano Ano Ne Ano
Nastavení kvóty využití podle předplatného Umožňuje vynutit objem volání z obnovitelných zdrojů nebo životnosti a/nebo kvótu šířky pásma na základě předplatného. Ano Ano Ano Yes
Nastavení kvóty využití podle klíče Umožňuje vynutit objem volání z obnovitelných zdrojů nebo životnosti a/nebo kvótu šířky pásma na základě klíče. Yes No No Ano
Omezení souběžnosti Brání provádění uzavřených zásad více než zadaným počtem požadavků najednou. Ano Ano Ano Yes
Omezení využití tokenů služby Azure OpenAI Zabraňuje špičkám využití rozhraní API Azure OpenAI omezením velkých tokenů jazykového modelu na počítaný klíč. Ano Ano No Ne
Omezení využití tokenů rozhraní API pro velký jazykový model Zabraňuje špičkám využití rozhraní API pro velký jazykový model (LLM) omezením tokenů LLM na počítaný klíč. Ano Ano No Ne

Ověřování a autorizace

Zásady Popis Klasické V2 Využití V místním prostředí
Kontrola hlavičky HTTP Vynucuje existenci a/nebo hodnotu hlavičky HTTP. Ano Ano Ano Yes
Získání kontextu autorizace Získá autorizační kontext zadaného připojení k poskytovateli přihlašovacích údajů nakonfigurovaného v instanci služby API Management. Ano Ano Ano No
Omezení IP adres volajícího Filtry (povolí nebo odepře) volání z konkrétních IP adres nebo rozsahů adres. Ano Ano Ano Yes
Ověření tokenu Microsoft Entra Vynucuje existenci a platnost jazyka JWT microsoft Entra (dříve označovaného jako Azure Active Directory) extrahovaného ze zadané hlavičky HTTP, parametru dotazu nebo hodnoty tokenu. Ano Ano Ano Yes
Ověření JWT Vynucuje existenci a platnost JWT extrahovaného ze zadané hlavičky HTTP, parametru dotazu nebo hodnoty tokenu. Ano Ano Ano Yes
Ověření klientského certifikátu Vynucuje, aby certifikát předaný klientem instanci služby API Management odpovídal zadaným ověřovacím pravidlům a deklaracím identity. Ano Ano Ano Yes
Ověřování pomocí basicu Ověřuje se pomocí back-endové služby pomocí základního ověřování. Ano Ano Ano Yes
Ověřování pomocí klientského certifikátu Ověřuje se pomocí back-endové služby pomocí klientských certifikátů. Ano Ano Ano Yes
Ověřování pomocí spravované identity Ověřuje se pomocí back-endové služby pomocí spravované identity. Ano Ano Ano Yes

Ověření obsahu

Zásady Popis Klasické V2 Využití V místním prostředí
Ověření obsahu Ověřuje velikost nebo obsah textu požadavku nebo odpovědi v jednom nebo více schématech rozhraní API. Podporované formáty schématu jsou JSON a XML. Ano Ano Ano Yes
Ověření požadavku GraphQL Ověří a autorizuje požadavek na rozhraní GraphQL API. Ano Ano Ano Yes
Ověření požadavku OData Ověří požadavek na rozhraní API OData, aby se zajistila shoda se specifikací OData. Ano Ano Ano Yes
Ověření parametrů Ověří v schématu rozhraní API hlavičku požadavku, dotaz nebo parametry cesty. Ano Ano Ano Yes
Ověření hlaviček Ověří hlavičky odpovědi vůči schématu rozhraní API. Ano Ano Ano Yes
Ověření stavových kódů Ověří stavové kódy HTTP v odpovědích na schéma rozhraní API. Ano Ano Ano Yes

Směrování

Zásady Popis Klasické V2 Využití V místním prostředí
Přeposlání požadavku Předá požadavek back-endové službě. Ano Ano Ano Yes
Set backend service (Nastavit back-endovou službu) Změní základní adresu URL back-endové služby příchozího požadavku na adresu URL nebo back-end. Odkazování na back-endový prostředek umožňuje spravovat základní adresu URL back-endové služby a další nastavení na jednom místě. Implementujte také vyrovnávání zatížení provozu napříč fondem back-endových služeb a pravidel jističe, která chrání back-end před příliš mnoha požadavky. Ano Ano Ano Yes
Nastavení proxy serveru HTTP Umožňuje směrovat přesměrované požadavky přes proxy server HTTP. Ano Ano Ano Yes

Ukládání do mezipaměti

Zásady Popis Klasické V2 Využití V místním prostředí
Získání z mezipaměti Provede vyhledávání mezipaměti a vrátí platnou odpověď uloženou v mezipaměti, pokud je k dispozici. Ano Ano Ano Yes
Uložit do mezipaměti Odpověď ukládá do mezipaměti podle zadané konfigurace řízení mezipaměti. Ano Ano Ano Yes
Získání hodnoty z mezipaměti Načte položku uloženou v mezipaměti podle klíče. Ano Ano Ano Yes
Uložení hodnoty v mezipaměti Ukládá položku v mezipaměti podle klíče. Ano Ano Ano Yes
Odebrání hodnoty z mezipaměti Odebere položku v mezipaměti podle klíče. Ano Ano Ano Yes
Získání odpovědí rozhraní API Azure OpenAI uložených v mezipaměti Provede vyhledávání v mezipaměti rozhraní API Azure OpenAI pomocí sémantického vyhledávání a vrátí platnou odpověď uloženou v mezipaměti, pokud je k dispozici. Ano Ano Ano Yes
Ukládání odpovědí na požadavky rozhraní API Azure OpenAI do mezipaměti Odpověď ukládá do mezipaměti podle konfigurace mezipaměti rozhraní API Azure OpenAI. Ano Ano Ano Yes
Získání odpovědí rozhraní API pro velké jazykové modely v mezipaměti Provede vyhledávání v mezipaměti rozhraní API pro velké jazykové modely pomocí sémantického vyhledávání a vrátí platnou odpověď uloženou v mezipaměti, pokud je k dispozici. Ano Ano Ano Yes
Ukládání odpovědí na požadavky rozhraní API pro velké jazykové modely do mezipaměti Odpověď ukládá do mezipaměti podle konfigurace mezipaměti rozhraní API pro velký jazykový model. Ano Ano Ano Yes

Transformace

Zásady Popis Klasické V2 Využití V místním prostředí
Nastavení metody požadavku Umožňuje změnit metodu HTTP pro požadavek. Ano Ano Ano Yes
Nastavit stavový kód Změní stavový kód HTTP na zadanou hodnotu. Ano Ano Ano Yes
Nastavit proměnnou Zachová hodnotu v pojmenované kontextové proměnné pro pozdější přístup. Ano Ano Ano Yes
Set body (Nastavit text) Nastaví text zprávy pro požadavek nebo odpověď. Ano Ano Ano Yes
Set HTTP header (Nastavit hlavičku HTTP) Přiřadí hodnotu do existující hlavičky odpovědi a/nebo požadavku nebo přidá novou hlavičku odpovědi a/nebo požadavku. Ano Ano Ano Yes
Set query string parameter (Nastavit parametr řetězce dotazu) Přidá, nahradí hodnotu parametru řetězce dotazu požadavku nebo odstraní. Ano Ano Ano Yes
Rewrite URL (Přepsat adresu URL) Převede adresu URL požadavku z veřejného formátu do formátu očekávaného webovou službou. Ano Ano Ano Yes
Convert JSON to XML (Převést JSON na XML) Převede text požadavku nebo odpovědi z JSON na XML. Ano Ano Ano Yes
Convert XML to JSON (Převést XML na JSON) Převede text požadavku nebo odpovědi z XML na JSON. Ano Ano Ano Yes
Find and replace string in body (Vyhledat a nahradit řetězec v textu) Vyhledá dílčí řetězec v požadavku nebo odpovědi a nahradí ho jiným dílčím řetězcem. Ano Ano Ano Yes
Mask URLs in content (Maskovat adresy URL v obsahu) Přepíše odkazy (masky) v textu odpovědi tak, aby odkazoval na ekvivalentní odkaz přes bránu. Ano Ano Ano Yes
Transform XML using an XSLT (Transformovat XML pomocí XSLT) Použije transformaci XSL na XML v textu požadavku nebo odpovědi. Ano Ano Ano Yes
Návratová odpověď Přeruší spuštění kanálu a vrátí zadanou odpověď přímo volajícímu. Ano Ano Ano Yes
Napodobení odpovědi Přeruší spuštění kanálu a vrátí napodobenou odpověď přímo volajícímu. Ano Ano Ano Yes

Mezidoménové

Zásady Popis Klasické V2 Využití V místním prostředí
Povolit volání mezi doménou Zpřístupňuje rozhraní API klientům adobe Flash a Microsoft Silverlight v prohlížeči. Ano Ano Ano Yes
CORS Přidá podporu sdílení prostředků mezi zdroji (CORS) do operace nebo rozhraní API, aby umožňovala volání mezi doménami z klientů založených na prohlížeči. Ano Ano Ano Yes
JSONP Přidá JSON s podporou odsazení (JSONP) do operace nebo rozhraní API, aby bylo možné povolit volání mezi doménami z klientů založených na prohlížeči JavaScriptu. Ano Ano Ano Yes

Integrace a externí komunikace

Zásady Popis Klasické V2 Využití V místním prostředí
Odeslat požadavek Odešle požadavek na zadanou adresu URL. Ano Ano Ano Yes
Odeslání žádosti o jeden způsob Odešle požadavek na zadanou adresu URL bez čekání na odpověď. Ano Ano Ano Yes
Přihlášení k centru událostí Odesílá zprávy v zadaném formátu do centra událostí definovaného entitou Logger. Ano Ano Ano Yes
Odeslání žádosti službě (Dapr) Používá modul runtime Dapr k vyhledání a spolehlivé komunikaci s mikroslužbou Dapr. Další informace o vyvolání služby v Dapr najdete v popisu v tomto souboru README . No No No Ano
Odeslat zprávu do tématu Pub/Sub (Dapr) Pomocí modulu runtime Dapr publikuje zprávu do tématu Publikování nebo přihlášení k odběru. Další informace o zasílání zpráv o publikování a přihlášení k odběru v Dapr najdete v popisu v tomto souboru README . No No No Ano
Aktivační výstupní vazba (Dapr) Používá modul runtime Dapr k vyvolání externího systému prostřednictvím výstupní vazby. Další informace o vazbách v Dapr najdete v popisu v tomto souboru README . No No No Ano

Protokolování

Zásady Popis Klasické V2 Využití V místním prostředí
Trasování Přidá vlastní trasování do výstupu trasování požadavků v testovací konzole, telemetriích Application Insights a protokolech prostředků. Ano Ano1 Ano Yes
Generování metrik Odesílá vlastní metriky do Application Insights při spuštění. Ano Ano Ano Yes
Generování metrik tokenů Azure OpenAI Odesílá metriky do Application Insights pro spotřebu velkých tokenů jazykového modelu prostřednictvím rozhraní API služby Azure OpenAI. Ano Ano Ne Ano
Generování metrik tokenů rozhraní API pro velký jazykový model Odesílá metriky do Application Insights pro spotřebu velkých tokenů jazykového modelu (LLM) prostřednictvím rozhraní API LLM. Ano Ano Ne Ano

1 V bráně trace V2 v současné době zásady nepřidá výstup trasování v testovací konzole.

Překladače GraphQL

Zásady Popis Klasické V2 Využití V místním prostředí
Zdroj dat Azure SQL pro překladač Nakonfiguruje požadavek Azure SQL a volitelnou odpověď pro překlad dat pro typ objektu a pole ve schématu GraphQL. Ano Ano No Ne
Zdroj dat Cosmos DB pro překladač Nakonfiguruje požadavek Cosmos DB a volitelnou odpověď pro překlad dat pro typ objektu a pole ve schématu GraphQL. Ano Ano No Ne
Zdroj dat HTTP pro překladač Nakonfiguruje požadavek HTTP a volitelně odpověď HTTP pro překlad dat pro typ objektu a pole ve schématu GraphQL. Ano Ano Ano No
Publikování události do odběru GraphQL Publikuje událost do jednoho nebo více odběrů zadaných ve schématu rozhraní GraphQL API. Nakonfigurujte zásadu v překladači GraphQL pro související pole ve schématu pro jiný typ operace, jako je například mutaci. Ano Ano Ano No

Řízení a tok zásad

Zásady Popis Klasické V2 Využití V místním prostředí
Tok řízení Podmíněné použití prohlášení o zásadách na základě výsledků vyhodnocení logických výrazů. Ano Ano Ano Yes
Zahrnout fragment Vloží fragment zásady do definice zásady. Ano Ano Ano Yes
Opakovat Opakuje provádění uzavřených prohlášení zásad, pokud a dokud není splněna podmínka. Provádění se bude opakovat v zadaných časových intervalech a až do zadaného počtu opakování. Ano Ano Ano Yes
Wait (Čekání) Než budete pokračovat, počkejte na uzavřenou žádost o odeslání, získání hodnoty z mezipaměti nebo zásad toku řízení. Ano Ano Ano Yes

Související obsah

Další informace o práci se zásadami najdete v tématech: