Créer et gérer un espace de travail dans Gestion des API Azure
S’APPLIQUE À : Premium
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.
Remarque
- Les dernières fonctionnalités de l’espaces de travail sont pris 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 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
Remarque
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.
Prérequis
- Une instance APIM. 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) Un réseau virtuel et un sous-réseau Azure existants ou nouveaux 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 :
Dans Détails de la passerelle, entrez un nom de passerelle et sélectionnez le nombre d’Unités de mise à l’échelle. Les coûts de passerelle sont basés sur le nombre d’unités que vous sélectionnez. 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 une configuration réseau qui inclut un accès réseau entrant ou privé sortant privé, sélectionnez un Réseau virtuel et un Sous-réseau pour isoler la passerelle d’espace de travail ou en créer une nouvelle. 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.
La création de l’espace de travail, de la passerelle d’espace de travail et des ressources associées peut prendre de quelques minutes à 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.
Remarque
- 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.
Remarque
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 d’espace de travail de service de Gestion des API
- Responsable produit d’API d’espace de travail de service 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 d’espace de travail de gestion des API
- Responsable produit d’API d’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.
- Propriétaire
- Contributeur
- Lecteur
Démarrage de 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.