Delen via

Naslaginformatie over beleid voor API Management

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

Deze sectie bevat korte beschrijvingen en koppelingen naar naslagartikelen voor alle API Management-beleidsregels. De API Management-gateways die elk beleid ondersteunen, worden aangegeven. Zie de gekoppelde naslagartikelen voor gedetailleerde beleidsinstellingen en voorbeelden.

Meer informatie over beleidsregels:

Belangrijk

Beperk de oproepsnelheid per abonnement en stel het gebruiksquotum per abonnement in, hebben een afhankelijkheid van de abonnementssleutel. Een abonnementssleutel is niet vereist wanneer andere beleidsregels worden toegepast.

Snelheidsbeperking en quota

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Gespreksfrequentie per abonnement beperken Hiermee voorkomt u pieken in het API-gebruik door de aanroepsnelheid per abonnement te beperken. Ja Ja Ja Ja
Gespreksfrequentie per sleutel beperken Hiermee voorkomt u pieken in het API-gebruik door de aanroepsnelheid per sleutel te beperken. Ja Ja No Ja
Gebruiksquotum instellen per abonnement Hiermee kunt u een volume en/of bandbreedtequotum voor een hernieuwbare of levensduur afdwingen, op basis van een abonnement. Ja Ja Ja Ja
Gebruiksquotum instellen op sleutel Hiermee kunt u een volume en/of bandbreedtequotum voor hernieuwbare of levensduur afdwingen, per sleutel. Ja No No Ja
Gelijktijdigheid beperken Hiermee voorkomt u dat ingesloten beleidsregels worden uitgevoerd door meer dan het opgegeven aantal aanvragen tegelijk. Ja Ja Ja Ja
Tokengebruik van Azure OpenAI-service beperken Hiermee voorkomt u pieken in het azure OpenAI API-gebruik door tokens voor grote taalmodellen per berekende sleutel te beperken. Ja Ja No Nr.
Het gebruik van api-token voor het grote taalmodel beperken Hiermee voorkomt u pieken in het API-gebruik van grote talen (LLM) door LLM-tokens per berekende sleutel te beperken. Ja Ja No Nr.

Verificatie en autorisatie

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
HTTP-header controleren Hiermee wordt het bestaan en/of de waarde van een HTTP-header afgedwongen. Ja Ja Ja Ja
Autorisatiecontext ophalen Hiermee haalt u de autorisatiecontext op van een opgegeven verbinding met een referentieprovider die is geconfigureerd in het API Management-exemplaar. Ja Ja Ja Nr.
Ip-adressen van bellers beperken Filters (toestaan/weigeren) aanroepen van specifieke IP-adressen en/of adresbereiken. Ja Ja Ja Ja
Microsoft Entra-token valideren Hiermee wordt het bestaan en de geldigheid van een Microsoft Entra (voorheen Azure Active Directory genoemd) JWT afgedwongen die is geëxtraheerd uit een opgegeven HTTP-header, queryparameter of tokenwaarde. Ja Ja Ja Ja
JWT valideren Hiermee wordt het bestaan en de geldigheid van een JWT afgedwongen die is geëxtraheerd uit een opgegeven HTTP-header, queryparameter of tokenwaarde. Ja Ja Ja Ja
Clientcertificaat valideren Hiermee wordt afgedwongen dat een certificaat dat door een client aan een API Management-exemplaar wordt gepresenteerd, overeenkomt met de opgegeven validatieregels en claims. Ja Ja Ja Ja
Verifiëren met Basic Verifieert met een back-endservice met behulp van basisverificatie. Ja Ja Ja Ja
Verifiëren met clientcertificaat Verifieert met een back-endservice met behulp van clientcertificaten. Ja Ja Ja Ja
Verifiëren met beheerde identiteit Verifieert met een back-endservice met behulp van een beheerde identiteit. Ja Ja Ja Ja

Inhoudsvalidatie

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Inhoud valideren Valideert de grootte of inhoud van een aanvraag- of antwoordtekst op basis van een of meer API-schema's. De ondersteunde schema-indelingen zijn JSON en XML. Ja Ja Ja Ja
GraphQL-aanvraag valideren Valideert en autoriseert een aanvraag voor een GraphQL-API. Ja Ja Ja Ja
OData-aanvraag valideren Valideert een aanvraag voor een OData-API om ervoor te zorgen dat deze voldoet aan de OData-specificatie. Ja Ja Ja Ja
Parameters valideren Valideert de aanvraagheader-, query- of padparameters op basis van het API-schema. Ja Ja Ja Ja
Kopteksten valideren Valideert de antwoordheaders op basis van het API-schema. Ja Ja Ja Ja
Statuscode valideren Valideert de HTTP-statuscodes in antwoorden op basis van het API-schema. Ja Ja Ja Ja

Routering

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Aanvraag doorsturen Stuurt de aanvraag door naar de back-endservice. Ja Ja Ja Ja
Back-endservice instellen Hiermee wijzigt u de basis-URL van de back-endservice van een binnenkomende aanvraag in een URL of een back-end. Als u naar een back-endresource verwijst, kunt u de basis-URL van de back-endservice en andere instellingen op één plaats beheren. Implementeer ook taakverdeling van verkeer in een pool met back-endservices en circuitonderbrekerregels om de back-end te beschermen tegen te veel aanvragen. Ja Ja Ja Ja
HTTP-proxy instellen Hiermee kunt u doorgestuurde aanvragen routeren via een HTTP-proxy. Ja Ja Ja Ja

Caching

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Ophalen uit cache Voert cachezoekacties uit en retourneert een geldig antwoord in de cache wanneer deze beschikbaar is. Ja Ja Ja Ja
Opslaan in cache Reactie van caches op basis van de opgegeven configuratie van cachebeheer. Ja Ja Ja Ja
Waarde ophalen uit cache Hiermee wordt een item in de cache opgehaald op basis van de sleutel. Ja Ja Ja Ja
Waarde opslaan in cache Slaat een item op in de cache op sleutel. Ja Ja Ja Ja
Waarde uit cache verwijderen Hiermee verwijdert u een item in de cache op sleutel. Ja Ja Ja Ja
Antwoorden in de cache ophalen van Azure OpenAI API-aanvragen Voert zoekopdrachten uit in de Azure OpenAI API-cache met behulp van semantische zoekopdrachten en retourneert een geldig antwoord in de cache wanneer deze beschikbaar is. Ja Ja Ja Ja
Reacties opslaan van Azure OpenAI API-aanvragen voor cache Cacheantwoorden volgens de azure OpenAI API-cacheconfiguratie. Ja Ja Ja Ja
Antwoorden in de cache ophalen van API-aanvragen voor grote taalmodellen Voert zoekopdrachten uit in de API-cache van het grote taalmodel met behulp van semantische zoekopdrachten en retourneert een geldig antwoord in de cache wanneer deze beschikbaar is. Ja Ja Ja Ja
Antwoorden opslaan van API-aanvragen voor grote talen voor het opslaan in de cache Slaat reactie in de cache op volgens de configuratie van de API-cache voor het grote taalmodel. Ja Ja Ja Ja

Transformatie

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Aanvraagmethode instellen Hiermee kunt u de HTTP-methode voor een aanvraag wijzigen. Ja Ja Ja Ja
Statuscode instellen Hiermee wijzigt u de HTTP-statuscode in de opgegeven waarde. Ja Ja Ja Ja
Variabele instellen Behoudt een waarde in een benoemde contextvariabele voor latere toegang. Ja Ja Ja Ja
Hoofdtekst instellen Hiermee stelt u de berichttekst in voor een aanvraag of antwoord. Ja Ja Ja Ja
HTTP-header instellen Hiermee wordt een waarde toegewezen aan een bestaande respons- en/of aanvraagheader of een nieuwe respons- en/of aanvraagheader toegevoegd. Ja Ja Ja Ja
Parameter querytekenreeks instellen Hiermee wordt de waarde van de querytekenreeksparameter voor aanvragen toegevoegd, vervangen of verwijderd. Ja Ja Ja Ja
URL opnieuw genereren Hiermee wordt een aanvraag-URL geconverteerd van de openbare in de door de webservice verwachte vorm. Ja Ja Ja Ja
JSON converteren naar XML Converteert de aanvraag- of antwoordtekst van JSON naar XML. Ja Ja Ja Ja
XML converteren naar JSON Converteert de aanvraag- of antwoordtekst van XML naar JSON. Ja Ja Ja Ja
Tekenreeks in hoofdtekst zoeken en vervangen Hiermee wordt een subtekenreeks voor een aanvraag of antwoord opgezocht en vervangen door een andere subtekenreeks. Ja Ja Ja Ja
URL's in inhoud maskeren Herschrijft koppelingen (maskers) in de hoofdtekst van het antwoord, zodat deze verwijzen naar de equivalente koppeling via de gateway. Ja Ja Ja Ja
XML transformeren met behulp van een XSLT Hiermee past u een XSL-transformatie toe op XML in de aanvraag- of antwoordtekst. Ja Ja Ja Ja
Antwoord retourneren Hiermee wordt de uitvoering van de pijplijn afgebroken en wordt het opgegeven antwoord rechtstreeks aan de aanroeper geretourneerd. Ja Ja Ja Ja
Gesimuleerd antwoord Hiermee wordt de uitvoering van de pijplijn afgebroken en wordt een gesimuleerd antwoord rechtstreeks naar de aanroeper geretourneerd. Ja Ja Ja Ja

Meerdere domeinen

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Aanroepen tussen domeinen toestaan Maakt de API toegankelijk via Adobe Flash- en Microsoft Silverlight-browserclients. Ja Ja Ja Ja
CORS Hiermee voegt u CORS-ondersteuning (Cross-Origin Resource Sharing) toe aan een bewerking of API om aanroepen tussen domeinen van browserclients toe te staan. Ja Ja Ja Ja
JSONP Voegt JSON met opvullingsondersteuning (JSONP) toe aan een bewerking of een API om aanroepen tussen domeinen toe te staan van javaScript-browserclients. Ja Ja Ja Ja

Integratie en externe communicatie

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Aanvraag verzenden Hiermee wordt een aanvraag verzonden naar de opgegeven URL. Ja Ja Ja Ja
Aanvraag voor één manier verzenden Hiermee wordt een aanvraag naar de opgegeven URL verzonden zonder te wachten op een antwoord. Ja Ja Ja Ja
Aanmelden bij Event Hub Hiermee worden berichten in de opgegeven indeling verzonden naar een Event Hub die is gedefinieerd door een Logger-entiteit. Ja Ja Ja Ja
Aanvraag verzenden naar een service (Dapr) Gebruikt Dapr-runtime om betrouwbaar te communiceren met een Dapr-microservice. Zie de beschrijving in dit README-bestand voor meer informatie over service-aanroep in Dapr. Nee Nee No Ja
Bericht verzenden naar pub-/subonderwerp (Dapr) Gebruikt Dapr-runtime om een bericht te publiceren naar een publiceren/abonneren-onderwerp. Zie de beschrijving in dit README-bestand voor meer informatie over publiceren/abonneren in Dapr. Nee Nee No Ja
Uitvoerbinding activeren (Dapr) Gebruikt Dapr-runtime om een extern systeem aan te roepen via uitvoerbinding. Zie de beschrijving in dit README-bestand voor meer informatie over bindingen in Dapr. Nee Nee No Ja

Logboekregistratie

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Trace Voegt aangepaste traceringen toe aan de uitvoer van aanvraagtracering in de testconsole, Application Insights-telemetrieën en resourcelogboeken. Ja Ja1 Ja Ja
Metrische gegevens verzenden Verzendt aangepaste metrische gegevens naar Application Insights tijdens de uitvoering. Ja Ja Ja Ja
Metrische gegevens van Azure OpenAI-token verzenden Hiermee worden metrische gegevens verzonden naar Application Insights voor gebruik van tokens voor grote taalmodellen via Azure OpenAI-service-API's. Ja Ja No Ja
Metrische api-tokengegevens voor grote talenmodel verzenden Hiermee worden metrische gegevens verzonden naar Application Insights voor gebruik van LLM-tokens (Large Language Model) via LLM-API's. Ja Ja No Ja

1 In de V2-gateway voegt het trace beleid momenteel geen traceringsuitvoer toe in de testconsole.

GraphQL-resolvers

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Azure SQL-gegevensbron voor resolver Hiermee configureert u de Azure SQL-aanvraag en optionele reactie om gegevens voor een objecttype en veld in een GraphQL-schema op te lossen. Ja Ja No Nr.
Cosmos DB-gegevensbron voor resolver Hiermee configureert u de Cosmos DB-aanvraag en optionele reactie om gegevens voor een objecttype en veld in een GraphQL-schema op te lossen. Ja Ja No Nr.
HTTP-gegevensbron voor resolver Hiermee configureert u de HTTP-aanvraag en eventueel het HTTP-antwoord om gegevens voor een objecttype en veld in een GraphQL-schema op te lossen. Ja Ja Ja Nr.
Gebeurtenis publiceren naar GraphQL-abonnement Hiermee publiceert u een gebeurtenis naar een of meer abonnementen die zijn opgegeven in een GraphQL API-schema. Configureer het beleid in een GraphQL-resolver voor een gerelateerd veld in het schema voor een ander bewerkingstype, zoals een mutatie. Ja Ja Ja Nr.

Beleidsbeheer en -stroom

Beleid Beschrijving Klassiek V2 Verbruik Zelfgehost
Controlestroom Beleidsinstructies voorwaardelijk toepassen op basis van de resultaten van de evaluatie van Boole-expressies. Ja Ja Ja Ja
Fragment opnemen Hiermee voegt u een beleidsfragment in de beleidsdefinitie in. Ja Ja Ja Ja
Opnieuw proberen Voert de uitvoering van de ingesloten beleidsinstructies opnieuw uit, indien en totdat aan de voorwaarde wordt voldaan. De uitvoering wordt herhaald met de opgegeven tijdsintervallen en tot het opgegeven aantal nieuwe pogingen. Ja Ja Ja Ja
Wait Wacht op ingesloten verzendaanvraag, Waarde ophalen uit cache of Stroombeleid beheren voordat u doorgaat. Ja Ja Ja Ja

Gerelateerde inhoud

Zie voor meer informatie over het werken met beleid: