Principreferens för API Management
Det här avsnittet innehåller länkar till referensartiklar för alla API Management-principer.
Mer information om principer:
- Principöversikt
- Ange eller redigera principer
- Principuttryck
- Skapa principer med Hjälp av Microsoft Copilot för Azure
Viktigt!
Begränsa samtalsfrekvensen per prenumeration och Ange användningskvot per prenumeration har ett beroende av prenumerationsnyckeln. En prenumerationsnyckel krävs inte när andra principer tillämpas.
Principer för begränsning av åtkomst
- Kontrollera HTTP-huvudet – Framtvingar existens och/eller värde för ett HTTP-huvud.
- Hämta auktoriseringskontext – Hämtar auktoriseringskontexten för en angiven anslutning till en autentiseringsprovider som konfigurerats i API Management-instansen.
- Begränsa samtalsfrekvensen per prenumeration – Förhindrar API-användningstoppar genom att begränsa samtalsfrekvensen per prenumeration.
- Begränsa anropsfrekvensen per nyckel – Förhindrar API-användningstoppar genom att begränsa anropsfrekvensen per nyckel.
- Begränsa anropar-IP-adresser – Filter (tillåter/nekar) anrop från specifika IP-adresser och/eller adressintervall.
- Ange användningskvot per prenumeration – Gör att du kan framtvinga en kvot för samtal med förnybar eller livslängd och/eller bandbredd per prenumeration.
- Ange användningskvot efter nyckel – Gör att du kan framtvinga en kvot för anrop för förnyelse eller livslängd och/eller bandbredd per nyckel.
- Verifiera Microsoft Entra-token – Framtvingar existens och giltighet för en Microsoft Entra JWT som extraherats från antingen ett angivet HTTP-huvud, en frågeparameter eller ett tokenvärde.
- Verifiera JWT – Framtvingar existens och giltighet för en JWT som extraherats från antingen ett angivet HTTP-huvud, en frågeparameter eller ett tokenvärde.
- Verifiera klientcertifikat – Framtvingar att ett certifikat som presenteras av en klient till en API Management-instans matchar angivna verifieringsregler och anspråk.
Avancerade principer
- Kontrollflöde – Tillämpar principinstruktioner villkorligt baserat på resultatet av utvärderingen av booleska uttryck.
- Generera mått – Skickar anpassade mått till Application Insights vid körning.
- Vidarebefordra begäran – Vidarebefordrar begäran till serverdelstjänsten.
- Inkludera fragment – Infogar ett principfragment i principdefinitionen.
- Begränsa samtidighet – förhindrar att slutna principer körs med fler än det angivna antalet begäranden åt gången.
- Logga till händelsehubben – Skickar meddelanden i det angivna formatet till en händelsehubb som definierats av en Logger-entitet.
- Simulerat svar – Avbryter pipelinekörningen och returnerar ett simulerat svar direkt till anroparen.
- Försök igen – Kör om körningen av de omslutna principinstruktionerna, om och tills villkoret uppfylls. Körningen upprepas med de angivna tidsintervallen och upp till det angivna antalet återförsök.
- Retursvar – Avbryter pipelinekörningen och returnerar det angivna svaret direkt till anroparen.
- Skicka en enkelriktad begäran – Skickar en begäran till den angivna URL:en utan att vänta på ett svar.
- Skicka begäran – Skickar en begäran till den angivna URL:en.
- Ange HTTP-proxy – Gör att du kan dirigera vidarebefordrade begäranden via en HTTP-proxy.
- Ange begärandemetod – Gör att du kan ändra HTTP-metoden för en begäran.
- Ange statuskod – Ändrar HTTP-statuskoden till det angivna värdet.
- Ange variabel – Bevarar ett värde i en namngiven kontextvariabel för senare åtkomst.
- Trace – Lägger till anpassade spårningar i begärandespårningsutdata i testkonsolen, Application Insights-telemetrier och resursloggar.
- Vänta – Väntar på att omslutna send-begäran, Hämta värde från cacheminnet eller Kontrollflödesprinciper ska slutföras innan du fortsätter.
Autentiseringsprinciper
- Autentisera med Basic – autentisera med en serverdelstjänst med grundläggande autentisering.
- Autentisera med klientcertifikat – Autentisera med en serverdelstjänst med hjälp av klientcertifikat.
- Autentisera med hanterad identitet – Autentisera med en serverdelstjänst med hjälp av en hanterad identitet.
Cachelagringsprinciper
- Hämta från cache – Utför cachesökning och returnera ett giltigt cachelagrat svar när det är tillgängligt.
- Lagra till cache – Cachelagrar svar enligt den angivna cachekontrollkonfigurationen.
- Hämta värde från cache – Hämta ett cachelagrat objekt efter nyckel.
- Lagra värdet i cachen – Lagra ett objekt i cacheminnet efter nyckel.
- Ta bort värdet från cachen – Ta bort ett objekt i cacheminnet efter nyckel.
Principer mellan domäner
- Tillåt korsdomänanrop – Gör API:et tillgängligt från Adobe Flash- och Microsoft Silverlight-webbläsarbaserade klienter.
- CORS – Lägger till cors-stöd (cross-origin resource sharing) till en åtgärd eller ett API för att tillåta korsdomänanrop från webbläsarbaserade klienter.
- JSONP – Lägger till JSON med stöd för utfyllnad (JSONP) till en åtgärd eller ett API för att tillåta korsdomänanrop från JavaScript-webbläsarbaserade klienter.
Dapr-integreringsprinciper
- Skicka begäran till en tjänst: Använder Dapr-körning för att hitta och kommunicera på ett tillförlitligt sätt med en Dapr-mikrotjänst. Mer information om tjänstanrop i Dapr finns i beskrivningen i den här README-filen .
- Skicka meddelande till Pub/Sub-ämne: Använder Dapr-körning för att publicera ett meddelande till ett publicera/prenumerera-ämne. Mer information om att publicera/prenumerera på meddelanden i Dapr finns i beskrivningen i den här README-filen .
- Utdatabindning för utlösare: Använder Dapr-körning för att anropa ett externt system via utdatabindning. Mer information om bindningar i Dapr finns i beskrivningen i den här README-filen .
GraphQL-matchningsprinciper
- Azure SQL-datakälla för matchare – Konfigurerar Azure SQL-begäran och valfritt svar för att matcha data för en objekttyp och ett fält i ett GraphQL-schema.
- Cosmos DB-datakälla för matchare – Konfigurerar Cosmos DB-begäran och valfritt svar för att matcha data för en objekttyp och ett fält i ett GraphQL-schema.
- HTTP-datakälla för matchare – Konfigurerar HTTP-begäran och eventuellt HTTP-svaret för att matcha data för en objekttyp och ett fält i ett GraphQL-schema.
- Publicera händelse till GraphQL-prenumeration – Publicerar en händelse till en eller flera prenumerationer som anges i ett GraphQL API-schema. Konfigurera principen i en GraphQL-matchare för ett relaterat fält i schemat för en annan åtgärdstyp, till exempel en mutation.
Transformeringsprinciper
- Konvertera JSON till XML – konverterar begärande- eller svarstext från JSON till XML.
- Konvertera XML till JSON – konverterar begärande- eller svarstext från XML till JSON.
- Sök efter och ersätt strängen i brödtexten – Söker efter en understräng för begäran eller svar och ersätter den med en annan delsträng.
- Maskera URL:er i innehåll – Skriver om (masker) länkar i svarstexten så att de pekar på motsvarande länk via gatewayen.
- Ange serverdelstjänst – Ändrar serverdelstjänstens bas-URL för en inkommande begäran till en URL eller en serverdel. Om du refererar till en serverdelsresurs kan du hantera serverdelstjänstens bas-URL och andra inställningar på en enda plats. Implementera även belastningsutjämning av trafik över en pool med serverdelstjänster och regler för kretsbrytare för att skydda serverdelen från för många begäranden.
- Ange brödtext – Anger meddelandetexten för en begäran eller ett svar.
- Ange HTTP-huvud – Tilldelar ett värde till ett befintligt svar och/eller begärandehuvud eller lägger till ett nytt svar och/eller begärandehuvud.
- Ange frågesträngsparameter – Lägger till, ersätter värdet för eller tar bort frågesträngsparametern för begäran.
- Skriv om URL – Konverterar en begärande-URL från det offentliga formuläret till det formulär som förväntas av webbtjänsten.
- Transformera XML med hjälp av en XSLT – tillämpar en XSL-transformering på XML i begäran eller svarstexten.
Valideringsprinciper
- Verifiera innehåll – Verifierar storleken eller innehållet i en begäran eller svarstext mot ett eller flera API-scheman. Schemaformaten som stöds är JSON och XML.
- Verifiera GraphQL-begäran – Validerar och auktoriserar en begäran till ett GraphQL-API.
- Verifiera OData-begäran – Validerar en begäran till ett OData-API för att säkerställa överensstämmelse med OData-specifikationen.
- Verifiera parametrar – Validerar parametrarna för begärandehuvud, fråga eller sökväg mot API-schemat.
- Verifiera rubriker – Validerar svarshuvudena mot API-schemat.
- Verifiera statuskod – Validerar HTTP-statuskoderna i svar mot API-schemat.
Relaterat innehåll
Mer information om hur du arbetar med principer finns i:
- Självstudie: Transformera och skydda ditt API
- Principreferens för en fullständig lista över principinstruktioner och deras inställningar
- Principuttryck
- Ange eller redigera principer
- Återanvända principkonfigurationer
- Lagringsplats för principfragment
- Skapa principer med Hjälp av Microsoft Copilot för Azure