API Management házirend-referencia
Ez a szakasz hivatkozásokat tartalmaz az összes API Management házirendre vonatkozó referenciacikkekre.
További információ a szabályzatokról:
Fontos
Korlátozza a hívások gyakoriságát előfizetés szerint , és előfizetés szerint állítsa be a használati kvótát , és függ az előfizetői azonosítótól. Más szabályzatok használatakor nincs szükség előfizetői azonosítóra.
Hozzáférés-korlátozási szabályzatok
- HTTP-fejléc ellenőrzése – A HTTP-fejléc meglétének és/vagy értékének kényszerítése.
- Engedélyezési környezet lekérése – Lekéri egy adott, a API Management-példányban konfigurált engedélyezés engedélyezési környezetét.
- Hívások számának korlátozása előfizetésenként – Az API-használat kiugróan magas számának megakadályozása a hívások számának előfizetésenkénti korlátozásával.
- Hívások számának korlátozása kulcs szerint – A hívások számának kulcsonkénti korlátozásával megakadályozza a kiugró API-használatot.
- A hívó IP-címek 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).
- Használati kvóta beállítása előfizetésenként – Lehetővé teszi egy megújítható vagy élettartamú híváskötet és/vagy sávszélességkvóta kényszerítését előfizetésenként.
- Használati kvóta beállítása kulcs szerint – Lehetővé teszi egy megújítható vagy élettartamú híváskötet és/vagy sávszélességkvóta kulcsonkénti kényszerítését.
- JWT ellenőrzése – Egy megadott HTTP-fejlécből vagy egy megadott lekérdezési paraméterből kinyert JWT meglétét és érvényességét kényszeríti ki.
- Ügyféltanúsítvány érvényesítése – Kényszeríti, hogy az ügyfél által egy API Management példánynak bemutatott tanúsítvány megfeleljen a megadott érvényesítési szabályoknak és jogcímeknek.
Speciális szabályzatok
- Vezérlési folyamat – Szabályzatutasítékok feltételes alkalmazása logikai kifejezések kiértékelése alapján.
- Kérés továbbítása – Továbbítja a kérést a háttérszolgáltatásnak.
- 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.
- Naplózás az eseményközpontba – A megadott formátumú üzeneteket küld egy Naplózó entitás által meghatározott üzenetcélnak.
- Metrikák kibocsátása – Egyéni metrikákat küld az Application Insightsnak a végrehajtáskor.
- Utánzási válasz – Megszakítja a folyamat végrehajtását, és közvetlenül a hívónak ad vissza egy utánzott választ.
- Újrapróbálkozás – Újrapróbálkozás a mellékelt szabályzatutasítók végrehajtásával, 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.
- Válasz visszaadása – Megszakítja a folyamat végrehajtását, és a megadott választ közvetlenül a hívónak adja vissza.
- Egyirányú kérés küldése – Kérést küld a megadott URL-címre anélkül, hogy választ vár.
- Kérés küldése – Kérést küld a megadott URL-címre.
- HTTP-proxy beállítása – Lehetővé teszi a továbbított kérések átirányítását HTTP-proxyn keresztül.
- Változó beállítása – Érték megőrzése elnevezett környezeti változóban későbbi hozzáféréshez.
- Kérelemmetódus beállítása – Lehetővé teszi a kérés HTTP-metódusának módosítását.
- Állapotkód beállítása – A HTTP-állapotkódot a megadott értékre módosítja.
- Nyomkövetés – Egyéni nyomkövetéseket ad hozzá az API Inspector kimenetéhez, az Application Insights telemetriai adataihoz és az erőforrásnaplókhoz.
- Várakozás – Várakozás a mellékelt küldési kérelemre, a gyorsítótár értékének lekérésére vagy a folyamatvezérlési szabályzatok végrehajtására a folytatás előtt.
Hitelesítési szabályzatok
- Hitelesítés alapszintű hitelesítéssel – Hitelesítés háttérszolgáltatással alapszintű hitelesítéssel.
- Hitelesítés ügyféltanúsítvánnyal – Hitelesítés háttérszolgáltatással ügyféltanúsítványokkal.
- Hitelesítés felügyelt identitással – Hitelesítés háttérszolgáltatással felügyelt identitással.
Gyorsítótárazási házirendek
- Lekérés a gyorsítótárból – Gyorsítótár-keresés végrehajtása és érvényes gyorsítótárazott válasz visszaadása, ha elérhető.
- Tárolás gyorsítótárba – A gyorsítótár válasza a megadott gyorsítótár-vezérlési konfigurációnak megfelelően.
- Érték lekérése a gyorsítótárból – Gyorsítótárazott elem lekérése kulcs alapján.
- Érték tárolása a gyorsítótárban – Egy elem tárolása a gyorsítótárban kulcs alapján.
- Érték eltávolítása a gyorsítótárból – Elem eltávolítása a gyorsítótárból kulcs alapján.
Tartományok közötti szabályzatok
- Tartományközi hívások engedélyezése – Elérhetővé teszi az API-t az Adobe Flash és a Microsoft Silverlight böngészőalapú ügyfelei számára.
- CORS – Támogatja a különböző eredetű erőforrások megosztását (CORS) egy művelethez vagy API-hoz, hogy lehetővé tegye a böngészőalapú ügyfelek tartományközi hívásait.
- JSONP – JSON-támogatást ad hozzá egy művelethez vagy API-hoz, hogy engedélyezze a javaScript böngészőalapú ügyfelek tartományközi hívásait.
Dapr-integrációs szabályzatok
- Kérés küldése egy szolgáltatásnak – a Dapr-futtatókörnyezet használatával megkeresi és megbízhatóan kommunikál egy Dapr-mikroszolgáltatással.
- Üzenet küldése Pub/Sub témakörbe – a Dapr-futtatókörnyezet használatával tesz közzé egy üzenetet egy közzétételi/feliratkozási témakörben.
- Kimeneti kötés aktiválása – Dapr-futtatókörnyezettel hív meg egy külső rendszert a kimeneti kötésen keresztül.
GraphQL API-szabályzatok
- GraphQL-kérés érvényesítése – Ellenőrzi és engedélyezi a GraphQL API-nak küldött kérést.
- GraphQL-feloldó beállítása – Egy GraphQL-sémában megadott objektumtípus graphQL-mezőjének adatait kéri le vagy állítja be.
Átalakítási szabályzatok
- JSON konvertálása XML-fájllá – A kérés- vagy választörzset JSON-ról XML-fájllá alakítja.
- XML konvertálása JSON-fájllá – A kérés- vagy választörzset XML-ről JSON-ra alakítja.
- Sztring keresése és cseréje a törzsben – Megkeresi a kérések vagy válaszok sztringrészleteit, és egy másik karakterláncrészre cseréli.
- Url-címek maszkolása a tartalomban – Újraírások (maszkok) hivatkozások a válasz törzsében, hogy az átjárón keresztül az azzal egyenértékű hivatkozásra mutasson.
- Háttérszolgáltatás beállítása – Módosítja a háttérszolgáltatást egy bejövő kéréshez.
- Törzs beállítása – Beállítja a bejövő és kimenő kérések üzenettörzsét.
- HTTP-fejléc beállítása – Érték hozzárendelése egy meglévő válaszhoz és/vagy kérésfejléchez, vagy új válasz és/vagy kérésfejléc hozzáadása.
- Lekérdezési sztring paraméterének beállítása – Hozzáadja, lecseréli vagy törli a kérelem lekérdezési sztring paraméterét.
- URL-cím átírása – Átalakítja a kérés URL-címét a nyilvános űrlapjáról a webszolgáltatás által várt űrlapra.
- XML átalakítása XSLT használatával – XSL-átalakítást alkalmaz AZ XML-re a kérelem vagy a válasz törzsében.
Érvényesítési szabályzatok
- Tartalom ellenőrzése – Ellenőrzi egy kérés vagy válasz törzsének méretét vagy JSON-sémáját az API-sémával.
- Paraméterek érvényesítése – Ellenőrzi a kérelem fejlécének, lekérdezésének vagy elérési útjának paramétereit az API-sémában.
- Fejlécek érvényesítése – Ellenőrzi a válaszfejléceket az API-sémában.
- Állapotkód érvényesítése – Ellenőrzi a HTTP-állapotkódokat az API-sémára adott válaszokban.
Következő lépések
A szabályzatok használatával kapcsolatos további információkért lásd: