Note
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de changer d’annuaire.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de changer d’annuaire.
S’APPLIQUE À : Premium | Premium v2
Configurez un espace de travail pour permettre à une équipe d’API de gérer et de mettre en production ses propres API, tout en fournissant à l’équipe de plateforme d’API les outils permettant d’observer, de régir et de gérer la plateforme Gestion des API. Après la création d’un espace de travail et l’attribution des autorisations, les collaborateurs de l’espace de travail peuvent créer et gérer leurs propres API, produits, abonnements et ressources associés.
Note
- Les dernières fonctionnalités des espaces de travail sont prises en charge dans l’API REST de Gestion des API version 2023-09-01-preview ou ultérieure.
- Pour plus de considérations sur la tarification, consultez la page Tarification d’API Management.
Suivez les étapes décrites dans cet article pour :
- Créer un espace de travail Gestion des API et associer une passerelle d’espace de travail à l’aide du portail Azure
- Isoler éventuellement la passerelle d’espace de travail dans un réseau virtuel Azure
- Attribuer des autorisations à l’espace de travail
Note
- Actuellement, la création d’une passerelle d’espace de travail est une opération de longue durée pouvant prendre jusqu’à 3 heures ou plus.
- L’association de plusieurs espaces de travail à une passerelle d’espace de travail est disponible uniquement pour les passerelles d’espace de travail créées après le 15 avril 2025. En savoir plus sur les passerelles d’espace de travail partagé.
Prerequisites
- Une instance de gestion des API. Si nécessaire, créez-en une dans un niveau pris en charge.
- Le rôle Propriétaire ou Contributeur sur le groupe de ressources où l’instance Gestion des API est déployée ou des autorisations équivalentes pour créer des ressources dans le groupe de ressources.
- (Facultatif) Sous-réseau d’un réseau virtuel Azure nouveau ou existant pour isoler le trafic entrant et sortant de la passerelle d’espace de travail. Pour connaître les options et les exigences de la configuration, consultez Exigences de ressource réseau pour les passerelles d’espace de travail.
Créer un espace de travail : Portail
Connectez-vous au portail Azure et accédez à votre instance de Gestion des API.
Dans le menu de gauche, sous API, sélectionnez Espaces de travail>+ Ajouter.
Sous l’onglet Informations de base, entrez un Nom d’affichage descriptif, un Nom de ressource et une Description facultative de l’espace de travail. Cliquez sur Suivant.
Sous l’onglet Passerelle , configurez les paramètres de la passerelle d’espace de travail.
Sélectionnez Créer un nouveau pour créer une nouvelle passerelle d’espace de travail, ou sélectionnez Utiliser existant pour associer l’espace de travail à une passerelle existante sur laquelle d’autres espaces de travail sont déployés.
Si vous choisissez de créer une passerelle :
Dans les détails de la passerelle, entrez un nouveau nom de passerelle et sélectionnez le nombre d’unités d’échelle. Les coûts de passerelle sont basés sur le nombre d’unités. Pour plus d’informations, consultez la section Tarification de Gestion des API Azure.
Dans Réseau, sélectionnez une Configuration réseau pour votre passerelle d’espace de travail.
Important
Planifiez attentivement la configuration réseau de votre espace de travail. Vous ne pouvez pas modifier la configuration réseau après avoir créé l’espace de travail.
Si vous sélectionnez l’accès public entrant, l’accès privé sortant (intégration de réseau virtuel) ou l’accès privé entrant, l’accès privé sortant (injection de réseau virtuel), sélectionnez un réseau virtuel et un sous-réseau pour isoler la passerelle d’espace de travail, ou créez-en un. Pour connaître les exigences de réseau, consultez Exigences de ressource réseau pour les passerelles d’espace de travail.
Cliquez sur Suivant. Une fois la validation terminée, sélectionnez Créer.
Note
La création d’une passerelle d’espace de travail, si elle est sélectionnée, peut prendre jusqu’à plusieurs heures. Pour suivre la progression du déploiement dans le Portail Azure, accédez au groupe de ressources de la passerelle. Dans le menu de gauche, sous Paramètres, sélectionnez Déploiements.
Une fois le déploiement terminé, le nouvel espace de travail apparaît dans la liste dans la page Espaces de travail. Sélectionnez l’espace de travail pour en gérer les paramètres et ressources.
Note
- Pour afficher le nom d’hôte du runtime de passerelle et d’autres détails de passerelle, sélectionnez l’espace de travail dans le portail. Sous Déploiement + infrastructure, sélectionnez Passerelles, puis sélectionnez le nom de la passerelle de l’espace de travail.
- Pendant la création de la passerelle d’espace de travail, les appels du runtime aux API de l’espace de travail échouent.
Affecter des utilisateurs à l’espace de travail : Portail
Après la création d’un espace de travail, attribuez des autorisations aux utilisateurs pour gérer les ressources de l’espace de travail. Chaque utilisateur d’un espace de travail doit se voir attribuer à la fois un rôle RBAC d’espace de travail étendu au service et un rôle RBAC étendu à l’espace de travail, ou obtenir des autorisations équivalentes à l’aide de rôles personnalisés.
Pour gérer la passerelle d’espace de travail, nous vous recommandons également d’attribuer aux utilisateurs de l’espace de travail un rôle RBAC fourni par Azure étendu à la passerelle d’espace de travail.
Note
Pour faciliter la gestion, configurez des groupes Microsoft Entra pour attribuer des autorisations d’espace de travail à plusieurs utilisateurs.
- Pour obtenir la liste des rôles intégrés de l’espace de travail, consultez Comment utiliser le contrôle d’accès en fonction du rôle dans Gestion des API.
- Pour les étapes d’attribution d’un rôle, consultez Attribuer des rôles Azure à l’aide du portail.
Attribuer un rôle étendu au service
Connectez-vous au portail Azure et accédez à votre instance de Gestion des API.
Dans le menu de gauche, sélectionnez Contrôle d’accès (IAM)>+ Ajouter.
Attribuez l’un des rôles étendus au service suivants à chaque membre de l’espace de travail :
- Développeur d'API pour l'espace de travail du service de gestion des API
- Responsable produit de l'API pour l'espace de travail du service de gestion des API
Attribuer un rôle étendu à l’espace de travail
Dans le menu de votre instance Gestion des API, sous API, sélectionnez Espaces de travail> le nom de l’espace de travail créé.
Dans la fenêtre Espace de travail, sélectionnez Contrôle d’accès (IAM)>+ Ajouter.
Attribuez l’un des rôles étendus à l’espace de travail suivants aux membres de l’espace de travail pour qu’ils puissent gérer des API d’espace de travail et d’autres ressources.
- Lecteur d’espace de travail de gestion des API
- Contributeur d’espace de travail de gestion des API
- Développeur d'API pour l'espace de travail de gestion des API
- Responsable produit API de l’espace de travail Gestion des API
Attribuer un rôle étendu à la passerelle
Connectez-vous au portail Azure et accédez à votre instance de Gestion des API.
Dans le menu de gauche, sous API, sélectionnez Espaces de travail> le nom de votre espace de travail.
Dans le menu de gauche de l’espace de travail, sélectionnez Passerelles, puis sélectionnez la passerelle d’espace de travail.
Dans le menu de gauche, sélectionnez Contrôle d’accès (IAM)>+ Ajouter.
Attribuez l’un des rôles suivants à chaque membre de l’espace de travail. Au minimum, nous vous recommandons d’attribuer le rôle Lecteur pour afficher les paramètres de la passerelle. Les Propriétaires et Contributeurs peuvent gérer les paramètres de la passerelle, y compris la mise à l’échelle de la passerelle.
- Owner
- Contributor
- Reader
Activer les paramètres de diagnostic pour la surveillance des API d’espace de travail
Configurez les paramètres pour collecter les journaux Azure Monitor pour l’espace de travail et les envoyer à un espace de travail Log Analytics afin que l’équipe de l’espace de travail puisse surveiller ses propres API, tandis que l’équipe de plateforme d’API peut accéder aux journaux centralisés de l’instance Gestion des API. Consultez le diagramme suivant :
Pour collecter les journaux Azure Monitor pour l’espace de travail, les paramètres de diagnostic sont nécessaires au niveau du service et de l’espace de travail :
Tout d'abord, activez un paramètre de diagnostic au niveau du service pour la collecte des journaux de la passerelle d'API Management, si un paramètre n'est pas déjà activé. Nous recommandons d’envoyer des journaux à un espace de travail Log Analytics : Pour plus d’informations, consultez Configurer les paramètres de diagnostic pour gestion des API.
Ensuite, activez un paramètre de diagnostic au niveau de l’espace de travail pour envoyer les journaux de la passerelle de gestion des API au même espace de travail Log Analytics. Ce paramètre collecte les journaux pour toutes les passerelles d’espace de travail associées à l’espace de travail.
Important
Un paramètre de diagnostic au niveau du service configure la journalisation sur l’instance Gestion des API, y compris les espaces de travail sur lesquels un paramètre de diagnostic au niveau de l’espace de travail est activé. Si vous n’activez pas de paramètre de diagnostic au niveau de l’espace de travail, les journaux de passerelle de l’espace de travail ne seront pas collectés ou agrégés dans Log Analytics.
Note
Par défaut, les membres de l'équipe de l'espace de travail à qui sont attribués les rôles RBAC intégrés n'ont pas les autorisations nécessaires pour modifier les paramètres de diagnostic dans un espace de travail. L’équipe de plateforme d’API dispose de ces autorisations.
Pour configurer un paramètre de diagnostic d’espace de travail pour la collecte des journaux de passerelle au niveau de l’espace de travail :
Connectez-vous au portail Azure et accédez à votre instance de Gestion des API.
Dans le menu de gauche, sous API, sélectionnez Espaces de travail> le nom de votre espace de travail.
Dans le menu de gauche des espaces de travail, sous Surveillance, sélectionnez Paramètres> de diagnostic+ Ajouter un paramètre de diagnostic.
Dans la page Paramètre de diagnostic, entrez ou sélectionnez les détails du paramètre :
- Nom du paramètre de diagnostic : entrez un nom descriptif.
- Groupes de catégories : effectuez éventuellement une sélection pour votre scénario.
- Sous Catégories : sélectionnez les journaux liés à la passerelle ApiManagement pour collecter les journaux de passerelle pour les API de cet espace de travail.
- Sous Détails de destination, sélectionnez cette option pour envoyer des journaux au même espace de travail Azure Log Analytics spécifié dans le paramètre de diagnostic au niveau du service et dans d’autres paramètres de diagnostic au niveau de l’espace de travail.
- Cliquez sur Enregistrer.
Note
- Actuellement, seuls les journaux de passerelle peuvent être collectés pour les espaces de travail.
- Accédez aux journaux de niveau espace de travail en allant dans Surveillance>Journaux dans le menu de gauche de l'espace de travail.
Commencez avec votre espace de travail
En fonction de leur rôle dans l’espace de travail, les utilisateurs peuvent disposer des autorisations pour créer des API, des produits, des abonnements et d’autres ressources ; ils peuvent également avoir un accès en lecture seule à tout ou partie d’entre elles.
Consultez les conseils suivants pour commencer à gérer, protéger et publier des API dans un espace de travail.