API Management-Richtlinienreferenz
Dieser Abschnitt enthält Links zu Referenzartikeln für alle API Management-Richtlinien.
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.
Richtlinien für die Zugriffsbeschränkung
- HTTP-Header überprüfen – Erfordert das Vorhandensein und/oder einen Wert eines HTTP-Headers.
- Autorisierungskontext abrufen: Ruft den Autorisierungskontext einer angegebenen Autorisierung ab, die in der API Management-Instanz konfiguriert ist.
- Limit call rate (Aufrufrate begrenzen) – verhindert API-Lastspitzen, indem die Aufrufrate jeweils pro Abonnement beschränkt wird.
- Limit call rate by key (Aufrufrate nach Schlüssel begrenzen) – Verhindert API-Lastspitzen, indem die Aufrufrate jeweils pro Schlüssel beschränkt wird.
- Beschränkung für Aufrufer-IP – Filtert (erlaubt/blockiert) Aufrufe von bestimmten IP-Adressen und/oder Adressbereichen.
- Set usage quota by subscription (Nutzungskontingent nach Abonnement festlegen) – ermöglicht die Durchsetzung eines erneuerbaren oder für die Lebensdauer gültigen Kontingents für Aufrufe und/oder Bandbreite auf Grundlage des Abonnements.
- Set usage quota by key (Nutzungskontingent nach Schlüssel festlegen) – Ermöglicht die Durchsetzung eines erneuerbaren oder für die Lebensdauer gültigen Kontingents für Aufrufe und/oder Bandbreite auf Grundlage des Schlüssels.
- Überprüfen des Azure Active Directory-Tokens: Erzwingt das Vorhandensein und die Gültigkeit eines Azure Active Directory-JWT, das aus einem angegebenen HTTP-Header, Abfrageparameter oder Tokenwert extrahiert wurde.
- JWT überprüfen – Erzwingt das Vorhandensein und die Gültigkeit eines JWT, das aus einem angegebenen HTTP-Header, Abfrageparameter oder Tokenwert extrahiert wurde.
- Überprüfen des Clientzertifikats: Erzwingt, dass ein Zertifikat, das einer API Management-Instanz von einem Client präsentiert wird, mit den angegebenen Validierungsregeln und Ansprüchen übereinstimmt.
Erweiterte Richtlinien
- Ablaufsteuerung – Bedingte Anwendung von Richtlinienanweisungen basierend auf den Ergebnissen der Auswertung von booleschen Ausdrücken
- Metriken ausgeben – Sendet bei Ausführung benutzerdefinierte Metriken an Application Insights.
- Anforderung weiterleiten – Leitet die Anforderung an den Back-End-Dienst.
- Include fragment: Fügt ein Richtlinienfragment in die Richtliniendefinition ein.
- Parallelität einschränken: verhindert die Ausführung der eingeschlossenen Richtlinien durch mehr als die angegebene Anzahl von Anforderungen gleichzeitig.
- Im Event Hub protokollieren – Sendet Nachrichten im angegebenen Format an einen von einem Protokollierungstool definierten Event Hub.
- Modellantwort – bricht die Pipelineausführung ab und gibt die Modellantwort unmittelbar an den Aufrufer zurück.
- 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.
- Zurückgegebene Antwort – bricht die Pipeline-Ausführung ab und gibt die angegebene Antwort unmittelbar an den Aufrufer zurück.
- Unidirektionale Anforderung senden – sendet eine Anforderung an die angegebene URL, ohne auf eine Antwort zu warten.
- Sendeanforderung – sendet eine Anforderung an die angegebene URL.
- HTTP-Proxy festlegen: Sie können weitergeleitete Anforderungen über einen HTTP-Proxy leiten.
- Anforderungsmethode festlegen – dient der Vornahme von Änderungen der HTTP-Anforderungsmethode.
- Statuscode festlegen – Ändert den HTTP-Statuscode in den angegebenen Wert.
- Variable festlegen – Speichert einen Wert in einer benannten Kontextvariablen, um später darauf zugreifen zu können.
- Ablaufverfolgung: Fügt benutzerdefinierte Ablaufverfolgungen zur Ausgabe der Anforderungsablaufverfolgung in der Testkonsole, in Application Insights-Telemetriedaten und in Ressourcenprotokollen hinzu.
- Warten – wartet darauf, dass eingeschlossene Richtlinien für Send request (Sendeanforderung), Get value from cache (Wert aus dem Cache abrufen) oder Control flow (Ablaufsteuerung) abgeschlossen werden, bevor der Vorgang fortgesetzt wird.
Authentifizierungsrichtlinien
- Standardauthentifizierung – Authentifizierung mit einem Back-End-Dienst unter Verwendung der Standardauthentifizierung.
- Authentifizierung mit Clientzertifikat – Authentifizierung mit einem Back-End-Dienst unter Verwendung von Clientzertifikaten.
- Authentifizierung mit einer verwalteten Identität – Authentifizierung mit einem Back-End-Dienst unter Verwendung einer verwalteten Identität.
Cachingrichtlinien
- Aus Cache abrufen – Führt eine Cachesuche aus und gibt ggf. eine gültige Antwort aus dem Cache zurück.
- In Cache ablegen – Cacheantwort gemäß der angegebenen Konfiguration für die Cachesteuerung.
- Get value from cache (Wert aus dem Cache abrufen) – ruft ein zwischengespeichertes Element nach Schlüssel ab.
- Store value in cache (Wert im Cache speichern) – speichert ein Element im Cache auf Basis des Schlüssels.
- Wert aus dem Cache entfernen – Entfernt ein Element im Cache nach Schlüssel.
Domänenübergreifende Richtlinien
- Domänenübergreifende Aufrufe zulassen – Erlaubt API-Aufrufe aus browserbasierten Clients, die Adobe Flash und Microsoft Silverlight verwenden.
- CORS – Fügt Unterstützung für Cross-Origin Resource Sharing (CORS) zu einer Operation oder einer API hinzu, um domänenübergreifende Aufrufe aus browserbasierten Clients zu ermöglichen.
- JSONP – Fügt Unterstützung für JSON mit Padding (JSONP) zu einer Operation oder einer API hinzu, um domänenübergreifende Aufrufe aus browserbasierten Clients mit JavaScript zu ermöglichen.
Dapr-Integrationsrichtlinien
- Anforderung an einen Dienst senden: 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.
- Nachricht an Pub/Sub-Thema senden: 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.
- Ausgabebindung auslösen: 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.
GraphQL-API-Richtlinien
- Überprüfen einer GraphQL-Anforderung²– Überprüft und autorisiert eine Anforderung an eine GraphQL-API.
- Festlegen des GraphQL-Resolvers: Ruft Daten ab oder legt sie für ein GraphQL-Feld in einem Objekttyp fest, der in einem GraphQL-Schema angegeben ist
Transformationsrichtlinien
- JSON in XML konvertieren – Konvertiert den Anforderungs- oder Antworttext von JSON in XML.
- XML in JSON konvertieren – Konvertiert den Anforderungs- oder Antworttext von XML in JSON.
- Zeichenfolge in Text ersetzen – Sucht nach einer Zeichenfolge in Antwort oder Anforderung und ersetzt diese durch eine andere Teilzeichenfolge.
- URLs in Inhalt maskieren – Ändert (maskiert) Links im Antworttext, sodass diese über das Gateway auf den äquivalenten Link zeigen.
- Back-End-Dienst festlegen – Ändert den Back-End-Dienst für eine eingehende Anforderung.
- Text festlegen – Legt den Nachrichtentext für eingehende und ausgehende Anforderungen fest.
- HTTP-Header setzen – Weist einem vorhandenen Antwort- und/oder Anforderungsheader einen Wert zu oder fügt einen neuen Antwort- und/oder Anforderungsheader hinzu.
- Abfrageparameter setzen – Fügt Abfrageparameter hinzu, löscht diese oder ersetzt deren Werte.
- URL umschreiben – Konvertiert eine Anforderung-URL von der öffentlichen Form in die vom Webdienst erwartete Form.
- XML mithilfe von XSLT transformieren – Wendet eine XSL-Transformation auf XML im Anforderungs- oder Antworttext an.
Überprüfungsrichtlinien
- Inhalt validieren: Hiermit wird die Größe oder der Inhalt eines Anforderungs- oder Reaktionstexts anhand eines oder mehrerer API-Schemas überprüft. Die unterstützten Schemaformate sind JSON und XML.
- Validieren von Parametern: Überprüft die Parameter für Anforderung, Abfrage oder Pfad anhand des API-Schemas.
- Validieren von Headern: Überprüft die Anforderungsheader anhand des API-Schemas.
- Statuscode überprüfen: Überprüft die HTTP-Statuscodes.
Nächste Schritte
Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier: