Dela via

Referens för API Management-princip

GÄLLER FÖR: Alla API Management-nivåer

Det här avsnittet innehåller korta beskrivningar och länkar till referensartiklar för alla API Management-principer. DE API Management-gatewayer som stöder varje princip anges. Detaljerade principinställningar och exempel finns i de länkade referensartiklarna.

Mer information om principer:

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.

Hastighetsbegränsning och kvoter

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Begränsa samtalsfrekvens per prenumeration Förhindrar API-användningstoppar genom att begränsa anropsfrekvensen per prenumeration. Ja Ja Ja Ja Ja
Begränsa anropsfrekvens efter nyckel Förhindrar API-användningstoppar genom att begränsa anropsfrekvensen per nyckel. Ja Ja Nej Ja Ja
Ange användningskvot per prenumeration Gör att du kan framtvinga en kvot för samtalsvolym och/eller bandbredd per prenumeration per prenumeration. Ja Ja Ja Ja Ja
Ange användningskvot efter nyckel Gör att du kan framtvinga en kvot för samtalsvolym och/eller bandbredd per nyckel. Ja Ja Nej Ja Ja
Begränsa samtidighet Förhindrar att omslutna principer körs med fler än det angivna antalet begäranden åt gången. Ja Ja Ja Ja Ja
Begränsa användningen av Azure OpenAI-tjänsttoken Förhindrar användningstoppar för Azure OpenAI API genom att begränsa stora språkmodelltoken per beräknad nyckel. Ja Ja Nej Ja Ja
Begränsa användningen av API-token för stora språkmodeller Förhindrar användningstoppar för API:et för stor språkmodell (LLM) genom att begränsa LLM-token per beräknad nyckel. Ja Ja Nej Ja Ja

Autentisering och auktorisering

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Kontrollera HTTP-huvud Framtvingar existens och/eller värde för ett HTTP-huvud. Ja Ja Ja Ja Ja
Hämta autentiseringskontext Hämtar auktoriseringskontexten för en angiven anslutning till en provider för autentiseringsuppgifter som konfigurerats i API Management-instansen. Ja Ja Ja Nej Nej
Begränsa uppringarens IP-adresser Filter (tillåter/nekar) anrop från specifika IP-adresser och/eller adressintervall. Ja Ja Ja Ja Ja
Verifiera Microsoft Entra-token Framtvingar existens och giltighet för en Microsoft Entra (kallades tidigare Azure Active Directory) JWT som extraherats från antingen ett angivet HTTP-huvud, en frågeparameter eller ett tokenvärde. Ja Ja Ja Ja Ja
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. Ja Ja Ja Ja Ja
Verifiera klientcertifikat Framtvingar att ett certifikat som presenteras av en klient för en API Management-instans matchar angivna verifieringsregler och anspråk. Ja Ja Ja Ja Ja
Autentisera med Basic Autentiserar med en serverdelstjänst med grundläggande autentisering. Ja Ja Ja Ja Ja
Autentisera med klientcertifikat Autentiserar med en serverdelstjänst med hjälp av klientcertifikat. Ja Ja Ja Ja Ja
Autentisera med hanterad identitet Autentiserar med en serverdelstjänst med hjälp av en hanterad identitet. Ja Ja Ja Ja Nej

Innehållsverifiering

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Framtvinga innehållssäkerhetskontroller på LLM-begäranden Framtvingar innehållssäkerhetskontroller på LLM-begäranden (uppmaningar) genom att överföra dem till Azure AI Content Safety-tjänsten innan de skickas till serverdelens LLM. Ja Ja Ja Ja Ja
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. Ja Ja Ja Ja Ja
Validera GraphQL-begäran Validerar och auktoriserar en begäran till ett GraphQL-API. Ja Ja Ja Ja Nej
Verifiera OData-begäran Validerar en begäran till ett OData-API för att säkerställa överensstämmelse med OData-specifikationen. Ja Ja Ja Ja Ja
Verifiera parametrar Verifierar parametrarna för begärandehuvud, fråga eller sökväg mot API-schemat. Ja Ja Ja Ja Ja
Verifiera rubriker Verifierar svarshuvudena mot API-schemat. Ja Ja Ja Ja Ja
Verifiera statuskod Verifierar HTTP-statuskoderna i svar mot API-schemat. Ja Ja Ja Ja Ja

Routning

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Vidarebefordra begäran Vidarebefordrar begäran till serverdelstjänsten. Ja Ja Ja Ja Ja
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. Ja Ja Ja Ja Ja
Ange HTTP-proxy Gör att du kan dirigera vidarebefordrade begäranden via en HTTP-proxy. Ja Ja Ja Ja Ja

Cache

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Hämta från cache Utför cachesökning och returnerar ett giltigt cachelagrat svar när det är tillgängligt. Ja Ja Ja Ja Ja
Lagra till cache Cachelagrar svaret enligt den angivna cachekontrollkonfigurationen. Ja Ja Ja Ja Ja
Hämta värde från cache Hämtar ett cachelagrat objekt efter nyckel. Ja Ja Ja Ja Ja
Lagra värdet i cacheminnet Lagrar ett objekt i cacheminnet efter nyckel. Ja Ja Ja Ja Ja
Ta bort värde från cacheminnet Tar bort ett objekt i cacheminnet efter nyckel. Ja Ja Ja Ja Ja
Hämta cachelagrade svar på Azure OpenAI API-begäranden Utför sökning i Azure OpenAI API-cache med hjälp av semantisk sökning och returnerar ett giltigt cachelagrat svar när det är tillgängligt. Ja Ja Ja Ja Nej
Lagra svar på Azure OpenAI API-begäranden att cachelagrar Cachelagrar svaret enligt Azure OpenAI API-cachekonfigurationen. Ja Ja Ja Ja Nej
Hämta cachelagrade svar från API-begäranden för stora språkmodeller Utför uppslag i API-cachen för stora språkmodeller med hjälp av semantisk sökning och returnerar ett giltigt cachelagrat svar när det är tillgängligt. Ja Ja Ja Ja Nej
Lagra svar från API-begäranden för stora språkmodeller som ska cachelagrats Cachelagrar svaret enligt api-cachekonfigurationen för stora språkmodeller. Ja Ja Ja Ja Nej

Omvandling

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Ange metod för begäran Gör att du kan ändra HTTP-metoden för en begäran. Ja Ja Ja Ja Ja
Ange statuskod Ändrar HTTP-statuskoden till det angivna värdet. Ja Ja Ja Ja Ja
Ange variabel Bevarar ett värde i en namngiven kontextvariabel för senare åtkomst. Ja Ja Ja Ja Ja
Ange brödtext Anger meddelandetexten för en begäran eller ett svar. Ja Ja Ja Ja Ja
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. Ja Ja Ja Ja Ja
Ange frågesträngsparameter Lägger till, ersätter värdet för eller tar bort frågesträngsparametern för begäran. Ja Ja Ja Ja Ja
Skriv om URL Konverterar en begärande-URL från dess offentliga form till den form som förväntas av webbtjänsten. Ja Ja Ja Ja Ja
Konvertera JSON till XML Konverterar begäran eller svarstext från JSON till XML. Ja Ja Ja Ja Ja
Konvertera XML till JSON Konverterar begäran eller svarstext från XML till JSON. Ja Ja Ja Ja Ja
Sök och ersätt sträng i brödtext Söker efter en begärande- eller svarsundersträng och ersätter den med en annan understräng. Ja Ja Ja Ja Ja
Maskera URL:er i innehåll Skriver om (masker) länkar i svarstexten så att de pekar på motsvarande länk via gatewayen. Ja Ja Ja Ja Ja
Transformera XML med hjälp av en XSLT Tillämpar en XSL-transformering på XML i begäran eller svarstexten. Ja Ja Ja Ja Ja
Retursvar Avbryter pipelinekörningen och returnerar det angivna svaret direkt till anroparen. Ja Ja Ja Ja Ja
Mock-svar Avbryter pipelinekörningen och returnerar ett simulerat svar direkt till anroparen. Ja Ja Ja Ja Ja

Korsdomän

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Tillåt korsdomänanrop Gör API:et tillgängligt från Adobe Flash- och Microsoft Silverlight-webbläsarbaserade klienter. Ja Ja Ja Ja Ja
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. Ja Ja Ja Ja Ja
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. Ja Ja Ja Ja Ja

Integrering och extern kommunikation

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Skicka begäran Skickar en begäran till den angivna URL:en. Ja Ja Ja Ja Ja
Skicka en enkelriktad begäran Skickar en begäran till den angivna URL:en utan att vänta på ett svar. Ja Ja Ja Ja Ja
Logga till händelsehubb Skickar meddelanden i det angivna formatet till en händelsehubb som definierats av en Logger-entitet. Ja Ja Ja Ja Ja
Skicka begäran till en tjänst (Dapr) 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 . Nej Nej Nej Ja Nej
Skicka meddelande till pub/underavsnitt (Dapr) 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 . Nej Nej Nej Ja Nej
Utdatabindning för utlösare (Dapr) 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 . Nej Nej Nej Ja Nej

Loggning / Skogsavverkning

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Spårning Lägger till anpassade spårningar i begärandespårningsutdata i testkonsolen, Application Insights-telemetrier och resursloggar. Ja Ja1 Ja Ja Ja
Generera mått Skickar anpassade mått till Application Insights vid körning. Ja Ja Ja Ja Ja
Generera Azure OpenAI-tokenmått Skickar mått till Application Insights för användning av stora språkmodelltoken via Azure OpenAI-tjänst-API:er. Ja Ja Nej Ja Ja
Generera API-tokenmått för stor språkmodell Skickar mått till Application Insights för användning av LLM-token (large language model) via LLM-API:er. Ja Ja Nej Ja Ja

1 I V2-gatewayen trace lägger principen för närvarande inte till spårningsutdata i testkonsolen.

GraphQL-matchare

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Azure SQL-datakälla för resolver 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. Ja Ja Nej Nej Nej
Cosmos DB-datakälla för resolver 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. Ja Ja Nej Nej Nej
HTTP-datakälla för resolver 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. Ja Ja Ja Nej Nej
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. Ja Ja Ja Nej Nej

AI-gateway

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Begränsa användningen av Azure OpenAI-tjänsttoken Förhindrar användningstoppar för Azure OpenAI API genom att begränsa stora språkmodelltoken per beräknad nyckel. Ja Ja Nej Ja Ja
Begränsa användningen av API-token för stora språkmodeller Förhindrar användningstoppar för API:et för stor språkmodell (LLM) genom att begränsa LLM-token per beräknad nyckel. Ja Ja Nej Ja Ja
Generera Azure OpenAI-tokenmått Skickar mått till Application Insights för användning av stora språkmodelltoken via Azure OpenAI-tjänst-API:er. Ja Ja Nej Ja Ja
Generera API-tokenmått för stor språkmodell Skickar mått till Application Insights för användning av LLM-token (large language model) via LLM-API:er. Ja Ja Nej Ja Ja
Hämta cachelagrade svar på Azure OpenAI API-begäranden Utför sökning i Azure OpenAI API-cache med hjälp av semantisk sökning och returnerar ett giltigt cachelagrat svar när det är tillgängligt. Ja Ja Ja Ja Nej
Hämta cachelagrade svar från API-begäranden för stora språkmodeller Utför uppslag i API-cachen för stora språkmodeller med hjälp av semantisk sökning och returnerar ett giltigt cachelagrat svar när det är tillgängligt. Ja Ja Ja Ja Nej
Lagra svar på Azure OpenAI API-begäranden att cachelagrar Cachelagrar svaret enligt Azure OpenAI API-cachekonfigurationen. Ja Ja Ja Ja Nej
Lagra svar från API-begäranden för stora språkmodeller som ska cachelagrats Cachelagrar svaret enligt api-cachekonfigurationen för stora språkmodeller. Ja Ja Ja Ja Nej
Framtvinga innehållssäkerhetskontroller på LLM-begäranden Framtvingar innehållssäkerhetskontroller på LLM-begäranden (uppmaningar) genom att överföra dem till Azure AI Content Safety-tjänsten innan de skickas till serverdelens LLM. Ja Ja Ja Ja Ja

Principkontroll och -flöde

Riktlinje Beskrivning Klassisk V2 Förbrukning Lokalt installerad Arbetsyta
Kontrollflöde Villkorligt tillämpar principinstruktioner baserat på resultatet av utvärderingen av booleska uttryck. Ja Ja Ja Ja Ja
Inkludera fragment Infogar ett principfragment i principdefinitionen. Ja Ja Ja Ja Ja
Försök igen Kör de omslutna principinstruktionerna igen, om och tills villkoret uppfylls. Körningen upprepas med de angivna tidsintervallen och upp till det angivna antalet återförsök. Ja Ja Ja Ja Ja
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. Ja Ja Ja Ja Ja

Relaterat innehåll

Mer information om hur du arbetar med principer finns i: