API Management-Richtlinienreferenz

  • Artikel

GILT FÜR: Alle API Management-Ebenen

Dieser Abschnitt enthält kurze Beschreibungen und Links zu Referenzartikeln für alle API Management-Richtlinien. Die API Management-Gateways, die jede Richtlinie unterstützen, werden angegeben. Ausführliche Richtlinieneinstellungen und Beispiele finden Sie in den verknüpften Referenzartikeln.

Weitere Informationen zu Richtlinien:

Wichtig

Anrufrate nach Abonnement begrenzen und das Nutzungskontingent nach Abonnement festlegen haben eine Abhängigkeit vom Abonnementschlüssel. Wenn andere Richtlinien angewendet werden, ist kein Abonnementschlüssel erforderlich.

Ratenbegrenzung und Kontingente

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Limit call rate (Aufrufrate begrenzen) Verhindert API-Nutzungsspitzen durch abonnementbezogene Begrenzung der Aufrufrate. Ja Ja Ja Ja
Aufrufrate nach Schlüssel begrenzen Verhindert API-Nutzungsspitzen, indem die Aufrufrate pro Schlüssel begrenzt wird. Ja Ja Keine Ja
Set usage quota by subscription (Nutzungskontingent nach Abonnement festlegen) (Nutzungskontingent nach Abonnement festlegen) Ermöglicht die Erzwingung eines erneuerbaren oder für die Lebensdauer gültigen Aufruf- und/oder Bandbreitenkontingents pro Abonnement. Ja Ja Ja Ja
Nutzungskontingent nach Schlüssel festlegen Ermöglicht die Erzwingung eines erneuerbaren oder für die Lebensdauer gültigen Aufruf- und/oder Bandbreitenkontingents pro Schlüssel. Ja Nr. Nein Ja
Parallelität einschränken Verhindert, dass die eingeschlossenen Richtlinien durch mehr als die angegebene Anzahl von Anforderungen gleichzeitig ausgeführt wird. Ja Ja Ja Ja
Einschränken des Tokenverbrauchs durch den Azure OpenAI Service Verhindert API-Verbrauchsspitzen von Azure OpenAI, indem Token für ein großes Sprachmodell pro berechnetem Schlüssel eingeschränkt werden Ja Ja Nr. No
Einschränken der API-Tokenverwendung für große Sprachmodelle Verhindert API-Verbrauchsspitzen von großen Sprachmodellen (LLMs), indem LLM-Token pro berechnetem Schlüssel eingeschränkt werden Ja Ja Nr. No

Authentifizierung und Autorisierung

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
HTTP-Header überprüfen Erzwingt das Vorhandensein und/oder den Wert eines HTTP-Headers. Ja Ja Ja Ja
Autorisierungskontext abrufen Ruft den Autorisierungskontext einer angegebenen Verbindung mit einem in der API Management-Instanz konfigurierten Anmeldeinformationsanbieter ab. Ja Ja Ja No
Beschränkung für Aufrufer-IP Filtert (erlaubt/verweigert) Aufrufe von bestimmten IP-Adressen und/oder Adressbereichen. Ja Ja Ja Ja
Microsoft Entra-Token überprüfen Erzwingt das Vorhandensein und die Gültigkeit eines Microsoft Entra-JWT (vormals Azure Active Directory-JWT), das aus einem angegebenen HTTP-Header, Abfrageparameter oder Tokenwert extrahiert wurde. Ja Ja Ja Ja
JWT überprüfen Erzwingt das Vorhandensein und die Gültigkeit eines JWT, das aus einem angegebenen HTTP-Header, Abfrageparameter oder Tokenwert extrahiert wurde. Ja Ja Ja Ja
Clientzertifikat überprüfen Erzwingt, dass ein Zertifikat, das ein Client einer API Management-Instanz präsentiert, mit den angegebenen Validierungsregeln und Ansprüchen übereinstimmt. Ja Ja Ja Ja
Standardauthentifizierung Verwendet die Standardauthentifizierung für die Authentifizierung bei einem Back-End-Dienst. Ja Ja Ja Ja
Authentifizierung mit Clientzertifikat Verwendet Clientzertifikate für die Authentifizierung bei einem Back-End-Dienst. Ja Ja Ja Ja
Authentifizierung mit verwalteter Identität Authentifiziert sich mithilfe einer verwalteten Identität bei einem Back-End-Dienst. Ja Ja Ja Ja

Validierung von Inhalten

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Überprüfen von Inhalt Überprüft die Größe oder den Inhalt eines Anforderungs- oder Reaktionstexts anhand eines oder mehrerer API-Schemas. Die unterstützten Schemaformate sind JSON und XML. Ja Ja Ja Ja
Überprüfen der GraphQL-Anforderung Überprüft und autorisiert eine Anforderung an eine GraphQL-API. Ja Ja Ja Ja
OData-Anforderung überprüfen Überprüft eine Anforderung an eine OData-API, um die Konformität mit der OData-Spezifikation sicherzustellen. Ja Ja Ja Ja
Parameter überprüfen Überprüft den Anforderungsheader, die Abfrage oder die Pfadparameter anhand des API-Schemas. Ja Ja Ja Ja
Header überprüfen Überprüft die Anforderungsheader anhand des API-Schemas. Ja Ja Ja Ja
Statuscode überprüfen Überprüft die HTTP-Statuscodes in Antworten anhand des API-Schemas. Ja Ja Ja Ja

Routing

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Anforderung weiterleiten Leitet die Anforderung an den Back-End-Dienst weiter. Ja Ja Ja Ja
Back-End-Dienst festlegen Ändert die Basis-URL des Back-End-Diensts einer eingehenden Anforderung in eine URL oder ein Back-End. Durch Verweisen auf eine Back-End-Ressource können Sie die Basis-URL des Back-End-Diensts und andere Einstellungen an einem zentralen Ort verwalten. Implementieren Sie außerdem einen Lastenausgleich für den Datenverkehr über einen Pool von Back-End-Diensten hinweg und Circuit Breaker-Regeln (Trennschalter), um das Back-End vor zu vielen Anforderungen zu schützen. Ja Ja Ja Ja
HTTP-Proxy festlegen Ermöglicht das Routing weitergeleiteter Anforderungen über einen HTTP-Proxy. Ja Ja Ja Ja

Caching

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Aus Cache abrufen Führt einen Cache-Lookupvorgang aus und gibt, sofern verfügbar, eine gültige zwischengespeicherte Antwort zurück. Ja Ja Ja Ja
In Cache ablegen Speichert eine Antwort entsprechend der angegebenen Konfiguration des Cachesteuerelements zwischen. Ja Ja Ja Ja
Wert aus Cache abrufen Ruft ein zwischengespeichertes Element nach Schlüssel ab. Ja Ja Ja Ja
Wert im Cache speichern Speichert ein Element nach Schlüssel im Cache. Ja Ja Ja Ja
Wert aus Cache entfernen Entfernt ein Element nach Schlüssel aus dem Cache. Ja Ja Ja Ja
Abrufen zwischengespeicherter Antworten der API-Anforderungen von Azure OpenAI Führt die Suche im Azure OpenAI-API-Cache mithilfe der semantischen Suche aus und gibt eine gültige zwischengespeicherte Antwort zurück (falls verfügbar) Ja Ja Ja Ja
Speichern von Antworten der API-Anforderungen von Azure OpenAI in den Cache Speichert die Antwort gemäß der API-Cachekonfiguration von Azure OpenAI zwischen Ja Ja Ja Ja
Abrufen zwischengespeicherter Antworten von API-Anforderungen für große Sprachmodelle Führt die Suche im LLM-API-Cache mithilfe der semantischen Suche aus und gibt eine gültige zwischengespeicherte Antwort zurück (falls verfügbar) Ja Ja Ja Ja
Speichern zwischengespeicherter Antworten von API-Anforderungen für große Sprachmodelle im Cache Speichert die Antwort gemäß der Konfiguration des API-Caches für große Sprachenmodelle zwischen Ja Ja Ja Ja

Transformation

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Anforderungsmethode festlegen Ermöglicht es Ihnen, die HTTP-Methode für eine Anforderung zu ändern. Ja Ja Ja Ja
Statuscode festlegen Ändert den HTTP-Statuscode auf den angegebenen Wert. Ja Ja Ja Ja
Festlegen der Variable Speichert einen Wert in einer benannten context-Variablen, um später darauf zuzugreifen. Ja Ja Ja Ja
Text festlegen Legt den Nachrichtentext für eine Anforderung oder Antwort fest. Ja Ja Ja Ja
HTTP-Header setzen Weist einer vorhandenen Antwort- und/oder Anfragekopfzeile einen Wert zu oder fügt eine neue Antwort- und/oder Anfragekopfzeile hinzu. Ja Ja Ja Ja
Abfrageparameter setzen Fügt den Abfragezeichenfolgen-Parameter hinzu, ersetzt dessen Wert oder löscht ihn. Ja Ja Ja Ja
URL umschreiben Konvertiert eine Anforderung-URL von der öffentlichen Form in die vom Webdienst erwartete Form. Ja Ja Ja Ja
JSON in XML konvertieren Konvertiert einen Anforderungs- oder Antworttext aus JSON in XML. Ja Ja Ja Ja
XML in JSON konvertieren Konvertiert einen Anforderungs- oder Antworttext aus XML in JSON. Ja Ja Ja Ja
Zeichenfolge in Text ersetzen Sucht nach einer Teilzeichenfolge in der Antwort oder Anforderung und ersetzt diese durch eine andere Teilzeichenfolge. Ja Ja Ja Ja
URLs in Inhalt maskieren Ändert (maskiert) Links im Antworttext, sodass diese über das Gateway auf den äquivalenten Link zeigen. Ja Ja Ja Ja
XML mithilfe von XSLT transformieren Wendet eine XSL-Transformation in XML auf den Anforderungs- oder Antworttext an. Ja Ja Ja Ja
Rückgabeantwort Bricht die Pipeline-Ausführung ab und gibt die angegebene Antwort unmittelbar an den Aufrufer zurück. Ja Ja Ja Ja
Modellantwort Bricht die Pipelineausführung ab und gibt die Modellantwort unmittelbar an den Aufrufer zurück. Ja Ja Ja Ja

Domänenübergreifend

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Domänenübergreifende Aufrufe zulassen Macht die API für browserbasierte Adobe Flash- und Microsoft Silverlight-Clients zugänglich. Ja Ja Ja Ja
CORS Fügt einem Vorgang oder einer API CORS-Unterstützung (Cross-Origin Resource Sharing) hinzu, um domänenübergreifende Aufrufe aus browserbasierten Clients zu ermöglichen. Ja Ja Ja Ja
JSONP Fügt einem Vorgang oder einer API JSONP-Unterstützung (JSON mit Padding) hinzu, um domänenübergreifende Aufrufe aus browserbasierten JavaScript-Clients zu ermöglichen. Ja Ja Ja Ja

Integration und externe Kommunikation

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Anforderung senden Sendet eine Anforderung an die angegebene URL. Ja Ja Ja Ja
Unidirektionale Anforderung senden Sendet eine Anforderung an die angegebene URL, ohne auf eine Antwort zu warten. Ja Ja Ja Ja
Protokoll an Event Hub Sendet Nachrichten im angegebenen Format an ein von einem Protokollierungstool definiertes Nachrichtenziel. Ja Ja Ja Ja
Anforderung an einen Dienst senden (Dapr) Verwendet eine Dapr-Runtime für die Lokalisierung eines Dapr-Microservice und die zuverlässige Kommunikation mit ihm. Weitere Informationen zum Dienstaufruf in Dapr enthält die Beschreibung in dieser INFO-Datei. No Nr. Nein Ja
Nachricht an Pub/Sub-Thema senden (Dapr) Verwendet die Dapr-Runtime, um eine Nachricht in einem Veröffentlichungs-/Abonnementthema zu veröffentlichen. Weitere Informationen zu Veröffentlichen/Abonnieren-Nachrichten in Dapr enthält die Beschreibung in dieser INFO-Datei. No Nr. Nein Ja
Ausgabebindung auslösen (Dapr) Verwendet eine Dapr-Runtime zum Aufrufen eines externen Systems über eine Ausgabebindung. Weitere Informationen zu Bindungen in Dapr enthält die Beschreibung in dieser INFO-Datei. No Nr. Nein Ja

Logging

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Trace Fügt benutzerdefinierte Ablaufverfolgungen zur Ausgabe der Anforderungsablaufverfolgung in der Testkonsole, in Application Insights-Telemetriedaten und in Ressourcenprotokollen hinzu. Ja Ja1 Ja Ja
Metriken ausgeben Sendet bei Ausführung benutzerdefinierte Metriken an Application Insights. Ja Ja Ja Ja
Ausgeben der Token von Azure OpenAI Sendet Metriken an Application Insights für den Verbrauch von Token großer Sprachmodelle über die Dienst-APIs von Azure OpenAI Ja Ja Keine Ja
Einschränken der API-Tokenmetriken für große Sprachmodelle Sendet Metriken an Application Insights über den Verbrauch von Token großer Sprachmodelle (LLMs) über LLM-APIs Ja Ja Keine Ja

1 Im V2-Gateway fügt die Richtlinie trace derzeit keine Ablaufverfolgungsausgabe in der Testkonsole hinzu.

GraphQL-Resolver

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Azure SQL-Datenquelle für Resolver Konfiguriert die Azure SQL-Anforderung und optional die Antwort zum Auflösen von Daten für einen Objekttyp und ein Feld in einem GraphQL-Schema. Ja Ja Nr. No
Cosmos DB-Datenquelle für Resolver Konfiguriert die Cosmos DB-Anforderung und optional die Antwort zum Auflösen von Daten für einen Objekttyp und ein Feld in einem GraphQL-Schema. Ja Ja Nr. No
HTTP-Datenquelle für Resolver Konfiguriert die HTTP-Anforderung und optional die HTTP-Antwort, um Daten für einen Objekttyp und ein Feld in einem GraphQL-Schema aufzulösen. Ja Ja Ja No
Ereignis im GraphQL-Abonnement veröffentlichen Veröffentlicht ein Ereignis für ein oder mehrere Abonnements, die in einem GraphQL-API-Schema angegeben sind. Konfigurieren Sie die Richtlinie mit einem GraphQL-Resolver für ein verknüpftes Feld im Schema für einen anderen Vorgangstyp, z. B. eine Mutation. Ja Ja Ja No

Richtliniensteuerung und -flow

Richtlinie Beschreibung Klassisch V2 Verbrauch Selbstgehostet
Ablaufsteuerung Wendet Richtlinienanweisungen bedingt anhand der Ergebnisse der Auswertung von booleschen Ausdrücken an. Ja Ja Ja Ja
Fragment einbeziehen Fügt ein Richtlinienfragment in die Richtliniendefinition ein. Ja Ja Ja Ja
Wiederholen Wiederholt die Ausführung der eingeschlossenen Richtlinienanweisungen, falls und bis die Bedingung erfüllt ist. Die Ausführung wird mit den angegebenen Zeitintervallen und bis zur angegebenen Anzahl der Wiederholungsversuche wiederholt. Ja Ja Ja Ja
Warten Wartet darauf, dass eingeschlossene Richtlinien für Sendeanforderung, Wert aus dem Cache abrufen oder Ablaufsteuerung abgeschlossen werden, bevor der Vorgang fortgesetzt wird. Ja Ja Ja Ja

Zugehöriger Inhalt

Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier: