API Management házirend-referencia

  • Cikk

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

Ez a szakasz rövid leírásokat és hivatkozásokat tartalmaz az összes API Management-szabályzatra vonatkozó hivatkozási cikkekhez. Az egyes szabályzatokat támogató API Management-átjárók jelennek meg. Részletes szabályzatbeállításokat és példákat a csatolt referenciacikkekben talál.

További információ a szabályzatokról:

Fontos

Korlátozza a hívási arányt előfizetések szerint, és a használati kvótát előfizetés szerint állítsa be, és függ az előfizetési kulcstól. Más szabályzatok alkalmazásakor nincs szükség előfizetési kulcsra.

Sebességkorlátozás és kvóták

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Hívássebesség korlátozása előfizetés szerint Az API-kihasználtság növekedésének megakadályozása a hívási sebesség előfizetésenkénti korlátozásával. Igen Igen Igen Igen
Hívás sebességének korlátozása kulcs szerint Az API-kihasználtság növekedésének megakadályozása a hívási sebesség kulcsonkénti korlátozásával. Igen Igen Nem Igen
Használati kvóta beállítása előfizetés szerint Lehetővé teszi a megújítható vagy élettartamú hívások mennyiségére és/vagy sávszélességére vonatkozó kvótát előfizetésenként. Igen Igen Igen Igen
Használati kvóta beállítása kulcs szerint Lehetővé teszi, hogy kulcsonként kényszerítsen ki egy megújítható vagy élettartamú hívásmennyiséget és/vagy sávszélesség-kvótát. Igen Nem Nem Igen
Egyidejűség korlátozása Megakadályozza, hogy a zárt szabályzatok egyszerre a megadott számú kérésnél többet hajtanak végre. Igen Igen Igen Igen

Hitelesítés és engedélyezés

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
HTTP-fejléc ellenőrzése A HTTP-fejléc meglétét és/vagy értékét kényszeríti ki. Igen Igen Igen Igen
Engedélyezési környezet lekérése Lekéri az API Management-példányban konfigurált hitelesítőadat-szolgáltatóhoz való megadott kapcsolat engedélyezési környezetét. Igen Igen Igen Nem
A hívó IP-címének korlátozása Adott IP-címekről és/vagy címtartományokból érkező hívások szűrése (engedélyezése/letiltása). Igen Igen Igen Igen
Microsoft Entra-jogkivonat érvényesítése A megadott HTTP-fejlécből, lekérdezési paraméterből vagy tokenértékből kinyert Microsoft Entra (korábbi nevén Azure Active Directory) JWT meglétét és érvényességét kényszeríti ki. Igen Igen Igen Igen
JWT ellenőrzése Egy megadott HTTP-fejlécből, lekérdezési paraméterből vagy tokenértékből kinyert JWT meglétét és érvényességét kényszeríti ki. Igen Igen Igen Igen
Ügyféltanúsítvány ellenőrzése Kényszeríti, hogy az ügyfél által egy API Management-példánynak bemutatott tanúsítvány egyezzen a megadott érvényesítési szabályokkal és jogcímekkel. Igen Igen Igen Igen
Hitelesítés alapszintű használatával Hitelesítés háttérszolgáltatással alapszintű hitelesítéssel. Igen Igen Igen Igen
Hitelesítés ügyféltanúsítvánnyal Hitelesítés háttérszolgáltatással ügyféltanúsítványokkal. Igen Igen Igen Igen
Hitelesítés felügyelt identitással Felügyelt identitással hitelesít egy háttérszolgáltatással. Igen Igen Igen Igen

Tartalomérvényesítés

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Tartalom ellenőrzése Egy kérelem- vagy választörzs méretét vagy tartalmát ellenőrzi egy vagy több API-sémán. A támogatott sémaformátumok a JSON és az XML. Igen Igen Igen Igen
GraphQL-kérés érvényesítése Ellenőrzi és engedélyezi a GraphQL API-ra irányuló kéréseket. Igen Igen Igen Igen
OData-kérelem ellenőrzése Az OData API-nak küldött kérés ellenőrzése az OData-specifikációnak való megfelelés biztosítása érdekében. Igen Igen Igen Igen
Paraméterek érvényesítése Ellenőrzi a kérelem fejlécét, lekérdezését vagy elérési útját az API-sémán. Igen Igen Igen Igen
Fejlécek ellenőrzése Ellenőrzi a válaszfejléceket az API-sémán. Igen Igen Igen Igen
Állapotkód ellenőrzése Ellenőrzi a HTTP-állapotkódokat az API-sémára adott válaszokban. Igen Igen Igen Igen

Útválasztás

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Kérelem továbbítása Továbbítja a kérést a háttérszolgáltatásnak. Igen Igen Igen Igen
Set backend service (Háttérszolgáltatás beállítása) Egy bejövő kérés háttérszolgáltatás-alap URL-címét URL-címre vagy háttérrendszerre módosítja. A háttérerőforrásra való hivatkozással egyetlen helyen kezelheti a háttérszolgáltatás alap URL-címét és egyéb beállításait. Emellett a háttérszolgáltatások és az áramkör-megszakító szabályok készletében a forgalom terheléselosztását is implementálhatja, hogy a háttérrendszer túl sok kéréstől védve legyen. Igen Igen Igen Igen
HTTP-proxy beállítása Lehetővé teszi a továbbított kérések HTTP-proxyn keresztüli átirányítását. Igen Igen Igen Igen

Gyorsítótárazás

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Get from cache Gyorsítótárkeresést végez, és érvényes gyorsítótárazott választ ad vissza, ha elérhető. Igen Igen Igen Igen
Tároló gyorsítótárazásához A gyorsítótárak válasza a megadott gyorsítótár-vezérlési konfigurációnak megfelelően. Igen Igen Igen Igen
Érték lekérése a gyorsítótárból Lekéri a gyorsítótárazott elemet kulccsal. Igen Igen Igen Igen
Érték tárolása a gyorsítótárban Egy elemet kulcs szerint tárol a gyorsítótárban. Igen Igen Igen Igen
Érték eltávolítása a gyorsítótárból Eltávolít egy elemet a gyorsítótárból kulccsal. Igen Igen Igen Igen

Átalakítás

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Kérelemmetódus beállítása Lehetővé teszi egy kérés HTTP-metódusának módosítását. Igen Igen Igen Igen
Állapotkód beállítása A HTTP-állapotkódot a megadott értékre módosítja. Igen Igen Igen Igen
Változó beállítása Egy elnevezett környezeti változóban megőrzi az értéket a későbbi hozzáféréshez. Igen Igen Igen Igen
Set body (Törzs beállítása) Beállítja az üzenet törzsét egy kéréshez vagy válaszhoz. Igen Igen Igen Igen
Set HTTP header (HTTP-fejléc beállítása) Értéket rendel egy meglévő válaszhoz és/vagy kérelemfejléchez, vagy új választ és/vagy kérelemfejlécet ad hozzá. Igen Igen Igen Igen
Set query string parameter (Lekérdezésisztring-paraméter beállítása) A kérelem lekérdezési sztringparaméterének hozzáadása, cseréje vagy törlése. Igen Igen Igen Igen
Rewrite URL (URL-átírás) Egy kérés URL-címét nyilvános formáról a webszolgáltatás által kért formára alakítja. Igen Igen Igen Igen
Convert JSON to XML (JSON–XML átalakítás) A JSON-ból XML-be konvertálja a kérelem- vagy választörzset. Igen Igen Igen Igen
Convert XML to JSON (XML–JSON átalakítás) A kérelem- vagy választörzset XML-ről JSON-ra konvertálja. Igen Igen Igen Igen
Find and replace string in body (Sztring keresése és cseréje a szövegtörzsben) Megkeresi egy kérés vagy válasz sztringrészletét, és egy másik sztringrészletre cseréli. Igen Igen Igen Igen
Mask URLs in content (URL-címek maszkolása a tartalomban) Átírja a válasz törzsében lévő hivatkozásokat (maszkokat), hogy az átjárón keresztül az ezzel egyenértékű hivatkozásra mutasson. Igen Igen Igen Igen
Transform XML using an XSLT (XML átalakítása XSLT-vel) XSL-átalakítást alkalmaz XML-vé a kérelem- vagy választörzsben. Igen Igen Igen Igen
Válasz visszaküldése Megszakítja a folyamat végrehajtását, és a megadott választ közvetlenül a hívónak adja vissza. Igen Igen Igen Igen
Mock válasz Megszakítja a folyamat végrehajtását, és közvetlenül a hívónak ad vissza egy szimulált választ. Igen Igen Igen Igen

Tartományközi

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Tartományközi hívások engedélyezése Az API-t elérhetővé teszi az Adobe Flash és a Microsoft Silverlight böngészőalapú ügyfelei számára. Igen Igen Igen Igen
CORS Több forrásból származó erőforrás-megosztási (CORS-) támogatást ad hozzá egy művelethez vagy API-hoz, hogy engedélyezve legyen a böngészőalapú ügyfelek tartományközi hívásai. Igen Igen Igen Igen
JSONP A JSON-t a padding (JSONP) támogatásával adja hozzá egy művelethez vagy EGY API-hoz, hogy engedélyezze a tartományközi hívásokat JavaScript böngészőalapú ügyfelektől. Igen Igen Igen Igen

Integráció és külső kommunikáció

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Kérés küldése Kérést küld a megadott URL-címre. Igen Igen Igen Igen
Egyirányú kérés küldése Kérést küld a megadott URL-címre válasz nélkül. Igen Igen Igen Igen
Bejelentkezés az eseményközpontba A megadott formátumban küld üzeneteket egy Logger-entitás által meghatározott eseményközpontnak. Igen Igen Igen Igen
Kérés küldése szolgáltatásnak (Dapr) Dapr-futtatókörnyezetet használ egy Dapr-mikroszolgáltatás megkereséséhez és megbízható kommunikációjához. A Dapr szolgáltatáshívásával kapcsolatos további információkért tekintse meg ebben a README-fájlban található leírást. Nem Nem Nem Igen
Üzenet küldése pub/altémakörbe (Dapr) A Dapr-futtatókörnyezet használatával közzétehet egy üzenetet egy közzétételi/feliratkozási témakörben. Ha többet szeretne megtudni a Daprben történő közzétételről/feliratkozásról, tekintse meg ebben a README-fájlban található leírást. Nem Nem Nem Igen
Trigger kimeneti kötése (Dapr) A Dapr-futtatókörnyezettel külső rendszert hívhat meg kimeneti kötéssel. A Dapr kötéseiről további információt ebben a README-fájlban talál. Nem Nem Nem Igen

Naplózás

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Nyomkövetés Egyéni nyomkövetéseket ad hozzá a kérelemkövetési kimenethez a tesztkonzolon, az alkalmazás Elemzések telemetriai adatokban és az erőforrásnaplókban. Igen Igen1 Igen Igen
Metrikák kibocsátása Egyéni metrikákat küld az Alkalmazás Elemzések a végrehajtáskor. Igen Igen Igen Igen

1 A V2-átjáróban a trace szabályzat jelenleg nem ad nyomkövetési kimenetet a tesztkonzolon.

GraphQL-feloldók

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Azure SQL-adatforrás a feloldóhoz Konfigurálja az Azure SQL-kérést és az opcionális választ egy GraphQL-sémában lévő objektumtípus és mező adatainak feloldásához. Igen Igen Nem Nem
Cosmos DB-adatforrás a feloldóhoz Konfigurálja a Cosmos DB-kérést és az opcionális választ egy GraphQL-séma objektumtípusának és mezőjének adatainak feloldásához. Igen Igen Nem Nem
HTTP-adatforrás a feloldóhoz Konfigurálja a HTTP-kérést és opcionálisan a HTTP-választ egy GraphQL-séma objektumtípusának és mezőjének adatainak feloldásához. Igen Igen Igen Nem
Esemény közzététele GraphQL-előfizetésben Esemény közzététele egy GraphQL API-sémában megadott egy vagy több előfizetésben. Konfigurálja a szabályzatot egy GraphQL-feloldóban a séma egy kapcsolódó mezőjéhez egy másik művelettípushoz, például egy mutációhoz. Igen Igen Igen Nem

Szabályzatvezérlés és -folyamat

Házirend Leírás Klasszikus 2. verzió Felhasználás Saját hosztolású
Átvitelvezérlés A logikai kifejezések kiértékelésének eredményei alapján feltételesen alkalmazza a házirend-utasításokat. Igen Igen Igen Igen
Töredék belefoglalása Szabályzattöredék beszúrása a szabályzatdefinícióba. Igen Igen Igen Igen
Retry Újrapróbálkozza a mellékelt szabályzatutasítók végrehajtását, ha és amíg a feltétel teljesül. A végrehajtás a megadott időközönként és a megadott újrapróbálkozási számig ismétlődik. Igen Igen Igen Igen
Várakozás Megvárja a zárt küldési kérést, az érték lekérését a gyorsítótárból vagy a vezérlőfolyamat-szabályzatokat a folytatás előtt. Igen Igen Igen Igen

Kapcsolódó tartalom

A szabályzatok használatával kapcsolatos további információkért lásd: