Référence des stratégies de gestion des API

  • Article

S’APPLIQUE À : tous les niveaux de gestion des API

Cette section fournit de brèves descriptions et des liens vers des articles de référence pour toutes les stratégies de gestion des API. Les passerelles de gestion des API qui prennent en charge chaque stratégie sont indiquées. Pour obtenir des exemples et des paramètres de stratégie détaillés, consultez les articles de référence liés.

Plus d’informations sur les stratégies :

Important

Limit call rate by subscription et Set usage quota by subscription ont une dépendance sur la clé d’abonnement. La clé d’abonnement n’est pas nécessaire quand d’autres stratégies s’appliquent.

Limitation du taux et quotas

Stratégie Description Classique V2 Consommation Auto-hébergé
Limit call rate by subscription Empêche les pics d’utilisation des API par abonnement en limitant le taux d’appels. Oui Oui Oui Oui
Limiter le taux d’appels par clé Empêche les pics d’utilisation des API par clé en limitant le taux d’appel. Oui Oui No Oui
Set usage quota by subscription Vous permet d’appliquer un volume d’appels et/ou un quota de bande passante renouvelable ou illimité par abonnement. Oui Oui Oui Oui
Définir le quota d’utilisation par clé Vous permet d’appliquer un volume d’appels et/ou un quota de bande passante renouvelable ou illimité par clé. Oui No Non Oui
Limiter la concurrence Empêche les stratégies incluses d’exécuter plus de requêtes simultanées que le nombre spécifié. Oui Oui Oui Oui

Authentification et autorisation

Stratégie Description Classique V2 Consommation Auto-hébergé
Check HTTP header Impose l’existence et/ou une valeur d’un en-tête HTTP. Oui Oui Oui Oui
Obtenir le contexte d’autorisation Obtient le contexte d’autorisation d’une connexion spécifiée à un fournisseur d’informations d’identification configuré dans l’instance de gestion des API. Oui Oui Oui Non
Restrict caller IPs Filtre (autorise/refuse) des appels en provenance d’adresses et/ou de plages d’adresses IP spécifiques. Oui Oui Oui Oui
Valider le jeton Microsoft Entra Applique l’existence et la validité d’un JWT Microsft Entra (anciennement appelé Azure Active Directory) extrait à partir d’un en-tête HTTP, d’un paramètre de requête ou d’une valeur de jeton spécifié(e). Oui Oui Oui Oui
Validate JWT Applique l’existence et la validité d’un JWT extrait à partir d’un en-tête HTTP, d’un paramètre de requête ou d’une valeur de jeton spécifié(e). Oui Oui Oui Oui
Valider le certificat client Garantit qu’un certificat présenté par un client à une instance de gestion des API correspond aux règles de validation et revendications spécifiées. Oui Oui Oui Oui
Authenticate with Basic S’authentifie auprès d’un service backend à l’aide d’une authentification de base. Oui Oui Oui Oui
Authenticate with client certificate S’authentifie auprès d’un service backend à l’aide de certificats clients. Oui Oui Oui Oui
S’authentifier avec l’identité managée S’authentifie auprès d’un service backend à l’aide d’une identité managée. Oui Oui Oui Oui

Validation du contenu

Stratégie Description Classique V2 Consommation Auto-hébergé
Valider le contenu Valide la taille ou le contenu du corps de la requête ou de la réponse par rapport à un ou plusieurs schémas API. Les formats de schéma pris en charge sont JSON et XML. Oui Oui Oui Oui
Valider la demande GraphQL Valide et autorise une demande à une API GraphQL. Oui Oui Oui Oui
Valider la requête OData Valide une requête adressée à une API OData pour garantir la conformité avec la spécification OData. Oui Oui Oui Oui
Valider les paramètres Valide les paramètres de l’en-tête de la demande, de la requête ou du chemin par rapport au schéma API. Oui Oui Oui Oui
Valider les en-têtes Valide les en-têtes de réponse par rapport au schéma API. Oui Oui Oui Oui
Valider le code d’état Valide les codes d’état HTTP dans les réponses par rapport au schéma API. Oui Oui Oui Oui

Routage

Stratégie Description Classique V2 Consommation Auto-hébergé
Forward request Transfère la requête au service backend. Oui Oui Oui Oui
Définir le service back-end Modifie l’URL de base du service backend d’une requête entrante en URL ou en backend. Le référencement d’une ressource back-end vous permet de gérer l’URL de base du service back-end et d’autres paramètres à un seul emplacement. Implémentez également l’équilibrage de charge du trafic sur un pool de services back-end et de règles de disjoncteur pour protéger le back-end contre un excès de requêtes. Oui Oui Oui Oui
Définir le proxy HTTP Vous permet de router les requêtes transférées via un proxy HTTP. Oui Oui Oui Oui

Mise en cache

Stratégie Description Classique V2 Consommation Auto-hébergé
Get from cache Effectue une recherche dans le cache, et renvoie une réponse mise en cache valide quand elle est disponible. Oui Oui Oui Oui
Store to cache Met en cache la réponse en fonction de la configuration de contrôle de cache spécifiée. Oui Oui Oui Oui
Obtenir la valeur du cache Récupère un élément mis en cache par clé. Oui Oui Oui Oui
Stocker la valeur dans le cache Stocke un élément dans le cache par clé. Oui Oui Oui Oui
Supprimer une valeur du cache Supprime un élément dans le cache par clé. Oui Oui Oui Oui

Transformation

Stratégie Description Classique V2 Consommation Auto-hébergé
Définir la méthode de requête Vous permet de modifier la méthode HTTP d’une requête. Oui Oui Oui Oui
Définir le code d’état Permet de définir le code d’état HTTP sur la valeur indiquée. Oui Oui Oui Oui
Définir la variable Conserve une valeur dans une variable contextuelle nommée en vue d’un accès ultérieur. Oui Oui Oui Oui
Définir le corps Définit le corps du message pour une requête ou une réponse. Oui Oui Oui Oui
Définir l’en-tête HTTP Affecte une valeur à un en-tête de et/réponse ou de requête existant, ou ajoute un nouvel en-tête de réponse et/ou de requête. Oui Oui Oui Oui
Définir un paramètre de chaîne de requête Ajoute, modifie la valeur ou supprime le paramètre de chaîne de requête de demande. Oui Oui Oui Oui
URL de réécriture Convertit une URL de requête de sa forme publique en une forme attendue par le service web. Oui Oui Oui Oui
Convertir JSON en XML Convertit le corps de la requête ou de la réponse de JSON à XML. Oui Oui Oui Oui
Convertir XML en JSON Convertit le corps d’une requête ou d’une réponse de XML à JSON. Oui Oui Oui Oui
Rechercher et remplacer une chaîne dans le corps Recherche une sous-chaîne de requête ou de réponse et la remplace par une autre sous-chaîne. Oui Oui Oui Oui
Masquer les URL dans le contenu Réécrit (masque) les liens dans le corps de la réponse pour qu’ils pointent vers le lien équivalent via la passerelle. Oui Oui Oui Oui
Transformer XML avec une XSLT Applique une transformation de XSL en XML dans le corps de la requête ou de la réponse. Oui Oui Oui Oui
Réponse de retour Abandonne l’exécution du pipeline et renvoie la réponse indiquée directement à l’appelant. Oui Oui Oui Oui
Simuler une réponse Abandonne l’exécution du pipeline et renvoie une réponse factice directement à l’appelant. Oui Oui Oui Oui

Inter-domaines

Stratégie Description Classique V2 Consommation Auto-hébergé
Allow cross-domain calls Rend l’API accessible à partir de clients basés sur un navigateur Adobe Flash et Microsoft Silverlight. Oui Oui Oui Oui
CORS Ajoute la prise en charge du partage des ressources cross-origin (CORS) à une opération ou à une API pour permettre les appels inter-domaines à partir de clients basés sur un navigateur. Oui Oui Oui Oui
JSONP Ajoute la prise en charge de JSON avec remplissage (JSONP) à une opération ou à une API pour permettre les appels inter-domaines à partir de clients basés sur un navigateur JavaScript. Oui Oui Oui Oui

Intégration et communication externe

Stratégie Description Classique V2 Consommation Auto-hébergé
Envoyer une requête Envoie une requête à l’URL spécifiée. Oui Oui Oui Oui
Envoyer une requête unidirectionnelle Envoie une requête à l’URL spécifiée sans attendre de réponse. Oui Oui Oui Oui
Enregistrer dans Event Hub Envoie des messages au format spécifié à un Event Hub défini par une entité Enregistreur d’événements. Oui Oui Oui Oui
Envoyer une requête à un service (Dapr) utilise le runtime Dapr pour localiser et communiquer de manière fiable avec un microservice Dapr. Pour en savoir plus sur l’appel de service dans Dapr, consultez la description fournie dans ce fichier LISEZMOI. Non Non Non Oui
Envoyer un message à une rubrique Publier/S’abonner (Dapr) utilise le runtime Dapr pour publier un message dans une rubrique Publier/S’abonner. Pour plus d’informations sur les messages Publier/S’abonner dans Dapr, consultez la description fournie dans ce fichier LISEZMOI. Non Non Non Oui
Déclencher la liaison de sortie (Dapr) utilise le runtime Dapr pour appeler un système externe par le biais d’une liaison de sortie. Pour en savoir plus sur les liaisons dans Dapr, consultez la description fournie dans ce fichier LISEZMOI. Non Non Non Oui

Logging

Stratégie Description Classique V2 Consommation Auto-hébergé
Suivi Ajoute des traces personnalisées dans la sortie de suivi des requêtes dans la console de test, les télémétries Application Insights et les journaux de ressources. Oui Oui1 Oui Oui
Émettre des métriques Envoie des métriques personnalisées à Application Insights lors de l’exécution. Oui Oui Oui Oui

1 Dans la passerelle V2, la stratégie trace n’ajoute actuellement pas de sortie de suivi dans la console de test.

Résolveurs GraphQL

Stratégie Description Classique V2 Consommation Auto-hébergé
Source de données Azure SQL pour le résolveur Configure la requête Azure SQL et la réponse facultative pour résoudre les données d’un type d’objet et d’un champ dans un schéma GraphQL. Oui Oui No Non
Source de données Cosmos DB pour le résolveur Configure la requête Cosmos DB et la réponse facultative pour résoudre les données d’un type d’objet et d’un champ dans un schéma GraphQL. Oui Oui No Non
Source de données HTTP pour le résolveur Configure la requête HTTP et la réponse facultative HTTP pour résoudre les données d’un type d’objet et d’un champ dans un schéma GraphQL. Oui Oui Oui Non
Publier un événement dans un abonnement GraphQL Publie un événement dans un ou plusieurs abonnements spécifiés dans le schéma de l’API GraphQL. Configurez la stratégie dans un résolveur GraphQL relatif à un champ connexe dans le schéma pour un autre type d’opération à l’instar d’une mutation. Oui Oui Oui Non

Contrôle de stratégie et flux

Stratégie Description Classique V2 Consommation Auto-hébergé
Control flow Applique de façon conditionnelle des instructions de stratégie basées sur les résultats de l’évaluation d’expressions booléennes. Oui Oui Oui Oui
Inclure le fragment Insère un fragment de stratégie dans la définition de la stratégie. Oui Oui Oui Oui
Réessayer Effectue une nouvelle tentative d’exécution des instructions de stratégie incluses, si la condition est remplie et jusqu’à ce qu’elle le soit. L’exécution se répète à intervalles réguliers et ce jusqu’au nombre de tentatives défini. Oui Oui Oui Oui
Wait Attend l’exécution des stratégies Envoyer une requête, Obtenir une valeur du cache ou Contrôler le flux pour continuer. Oui Oui Oui Oui

Contenu connexe

Pour plus d’informations sur l’utilisation des stratégies, consultez :