Comment définir ou modifier des stratégies dans Gestion des API Azure

  • Article
  • 7 minutes de lecture

Cet article explique comment configurer des stratégies dans votre instance Gestion des API en modifiant les définitions de stratégie dans le Portail Azure. Chaque définition de stratégie est un document XML qui décrit une séquence d’instructions entrantes et sortantes s’exécutant de manière séquentielle sur une requête et une réponse d’API.

L’éditeur de stratégie du portail fournit des formulaires guidés afin que les éditeurs d’API ajoutent et modifient les stratégies dans les définitions de stratégie. Vous pouvez également modifier le code XML directement dans l’éditeur de code de stratégie.

Plus d’informations sur les stratégies :

Prérequis

Si vous ne disposez pas déjà d’une instance Gestion des API et d’une API back-end, consultez :

Accéder à votre instance Gestion des API

  1. Sur le portail Azure, recherchez et sélectionnez Services Gestion des API.

    Select API Management services

  2. Dans la page Services Gestion des API, sélectionnez votre instance Gestion des API.

    Select your API Management instance

Configurer la stratégie dans le portail

L’exemple suivant montre comment configurer une stratégie à l’aide de deux options dans l’éditeur de stratégie du portail :

  • Éditeur basé sur des formulaires guidés pour simplifier la configuration de nombreuses stratégies
  • Éditeur de code dans lequel vous pouvez ajouter ou modifier directement du code XML

Dans cet exemple, la stratégie filtre les requêtes de certaines adresses IP entrantes. Elle est étendue à une API sélectionnée.

Notes

Vous pouvez configurer des stratégies sur d’autres étendues, telles que toutes les API, un produit ou une opération d’API unique. Consultez Configurer l’étendue, plus loin dans cet article, pour obtenir d’autres exemples.

Pour configurer une stratégie :

  1. Dans le volet de navigation gauche de votre instance du service Gestion des API, sélectionnez API.

  2. Sélectionnez une API précédemment importée.

  3. Sélectionnez l’onglet Conception.

  4. Pour appliquer la stratégie à toutes les opérations, sélectionnez Toutes les opérations.

  5. Dans la section Traitement entrant, sélectionnez + Ajouter une stratégie.

    Add policy in API Management

  6. Dans Ajouter une stratégie de trafic entrant, sélectionnez une stratégie à ajouter. Par exemple, sélectionnez Filtrer les adresses IP.

    Filter IP addresses policy

    Conseil

    • Les stratégies affichées sont étendues à la section de stratégie que vous configurez ; dans le cas présent, le traitement entrant.
    • Si vous ne voyez pas de stratégie souhaitée, sélectionnez la vignette Autres stratégies. Cette action ouvre l’éditeur de code XML et affiche une liste complète de stratégies pour cette section et cette étendue.

  7. Sélectionnez Adresses IP autorisées>+ Ajouter un filtre IP et ajoutez les premières et dernières adresses IP d’une plage d’adresses entrantes autorisées à effectuer des requêtes d’API. Ajoutez d’autres plages d’adresses IP, si nécessaire.

    Configure allowed IP addresses

  8. Sélectionnez Enregistrer pour propager immédiatement les modifications apportées à la passerelle Gestion des API.

    La stratégie ip-filter s’affiche désormais dans la section Traitement entrant.

Configurer les stratégies sur différentes étendues

Le service Gestion des API vous permet de configurer des définitions de stratégie sur plusieurs étendues, dans chacune des sections de stratégie.

Important

Toutes les stratégies ne peuvent pas être appliquées à chaque étendue ou section de stratégie. Si la stratégie que vous souhaitez ajouter n’est pas activée, vérifiez que vous vous trouvez dans une section ou une étendue de stratégie prise en charge pour cette stratégie. Pour consulter les sections et les étendues de stratégie d’une stratégie, consultez la section Utilisation dans les rubriques Référence de stratégie.

Notes

La section de stratégie Back-end ne peut contenir qu’un seul élément de stratégie. Par défaut, le service Gestion des API configure la stratégie forward-request dans la section Back-end dans l’étendue globale, et l’élément base dans d’autres étendues.

Étendue globale

L’étendue globale est configurée pour toutes les API dans votre instance Gestion des API.

  1. Dans le volet de navigation gauche de votre instance du service Gestion des API, sélectionnez API>Toutes les API.

  2. Sélectionnez l’onglet Conception.

    Configure policy at product scope

  3. Dans une section de stratégie, sélectionnez + Ajouter une stratégie pour utiliser un éditeur de stratégie basé sur un formulaire, ou sélectionnez l’icône </> (éditeur de code) pour ajouter et modifier directement le code XML.

  4. Sélectionnez Enregistrer pour propager immédiatement les modifications apportées à la passerelle Gestion des API.

Étendue produit

L’étendue du produit est configurée pour un produit sélectionné.

  1. Dans le menu de gauche, sélectionnez Produits, puis sélectionnez un produit auquel vous souhaitez appliquer des stratégies.

  2. Dans la fenêtre du produit, sélectionnez Stratégies.

    Configure policy at global scope

  3. Dans une section de stratégie, sélectionnez + Ajouter une stratégie pour utiliser un éditeur de stratégie basé sur un formulaire, ou sélectionnez l’icône </> (éditeur de code) pour ajouter et modifier directement le code XML.

  4. Sélectionnez Enregistrer pour propager immédiatement les modifications apportées à la passerelle Gestion des API.

Étendue API

L’étendue de l’API est configurée pour toutes les opérations de l’API sélectionnée.

  1. Dans le volet de navigation gauche de votre instance Gestion des API, sélectionnez API, puis sélectionnez l’API à laquelle vous souhaitez appliquer des stratégies.

  2. Sélectionnez l’onglet Conception.

  3. Sélectionnez Toutes les opérations.

    Configure policy at API scope

  4. Dans une section de stratégie, sélectionnez + Ajouter une stratégie pour utiliser un éditeur de stratégie basé sur un formulaire, ou sélectionnez l’icône </> (éditeur de code) pour ajouter et modifier directement le code XML.

  5. Sélectionnez Enregistrer pour propager immédiatement les modifications apportées à la passerelle Gestion des API.

Étendue opération

L’étendue de l’opération est configurée pour une opération d’API sélectionnée.

  1. Dans le volet de navigation gauche de votre instance du service Gestion des API, sélectionnez API.

  2. Sélectionnez l’onglet Conception.

  3. Sélectionnez l’opération à laquelle vous souhaitez appliquer des stratégies.

    Configure policy at operation scope

  4. Dans une section de stratégie, sélectionnez + Ajouter une stratégie pour utiliser un éditeur de stratégie basé sur un formulaire, ou sélectionnez l’icône </> (éditeur de code) pour ajouter et modifier directement le code XML.

  5. Sélectionnez Enregistrer pour propager immédiatement les modifications apportées à la passerelle Gestion des API.

Réutiliser les configurations de stratégie

Vous pouvez créer des fragments de stratégie réutilisables dans votre instance Gestion des API. Les fragments de stratégie sont des éléments XML contenant vos configurations d’une ou plusieurs stratégies. Les fragments de stratégie vous aident à configurer des stratégies de manière cohérente et à gérer les définitions de stratégie sans avoir à répéter ou à retyper du code XML.

Utilisez la stratégie include-fragment pour insérer un fragment de stratégie dans une définition de stratégie.

Utiliser l’élément base pour définir l’ordre d’évaluation de la stratégie

Si vous configurez des définitions de stratégie sur plusieurs étendues, plusieurs stratégies peuvent s’appliquer à une requête ou une réponse d’API. Selon l’ordre dans lequel les stratégies des différentes étendues sont appliquées, la transformation de la requête ou de la réponse peut différer.

Dans le service Gestion des API, déterminez l’ordre d’évaluation de la stratégie en positionnant l’élément base dans chaque section de la définition de stratégie sur chaque étendue. L’élément base hérite des stratégies configurées dans cette section à l’étendue plus large suivante (parente). L’élément base est inclus par défaut dans chaque section de stratégie.

Notes

Pour afficher les stratégies effectives dans l’étendue actuelle, sélectionnez Calculer la stratégie effective dans l’éditeur de stratégie.

Pour modifier l’ordre d’évaluation de la stratégie à l’aide de l’éditeur de stratégie :

  1. Commencez par la définition dans l’étendue la plus étroite que vous avez configurée ; le service Gestion des API l’appliquera en premier.

    Par exemple, lorsque vous utilisez des définitions de stratégie configurées dans l’étendue globale et dans l’étendue de l’API, commencez par la configuration au niveau de l’étendue de l’API.

  2. Placez l’élément base dans une section pour déterminer où hériter de toutes les stratégies de la section correspondante dans l’étendue parente.

    Par exemple, dans une section inbound configurée dans l’étendue de l’API, placez un élément base pour contrôler où hériter des stratégies configurées dans la section inbound dans l’étendue globale. Dans l’exemple suivant, les stratégies héritées de l’étendue globale sont appliquées avant la stratégie ip-filter.

    <policies>
  <inbound>
      <base />
        <ip-filter action="allow">
            <address>10.100.7.1</address>
        </ip-filter>
  </inbound>
  [...]
</policies>

    Notes

    • Vous pouvez placer l’élément base avant ou après un élément de stratégie dans une section.
    • Si vous souhaitez empêcher l’héritage des stratégies de l’étendue parente, supprimez l’élément base. Dans la plupart des cas, cette action n’est pas recommandée.

  3. Continuez à configurer l’élément base dans les définitions de stratégie à des étendues successivement plus larges.

    Une stratégie globale n’a aucune stratégie parente et l’utilisation de l’élément base n’a aucun effet.

Étapes suivantes

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