Créer et gérer un espace de travail dans Gestion des API Azure

S’APPLIQUE À : Essentiel v2 | Standard v2 | 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.

Suivez les étapes décrites dans cet article pour :

• Créez un espace de travail Gestion des API associé à la passerelle managée par défaut de l’instance, ou associé à une passerelle d’espace de travail nouvelle ou existante.
• Si vous le souhaitez, isolez une passerelle d’espace de travail dans un réseau virtuel Azure.
• Attribuez des autorisations à l’espace de travail.

Prerequisites

• Une instance de gestion des API. Si vous en avez besoin, créez-le 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 nouveau ou existant Azure pour isoler le trafic entrant et sortant d'une 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.
• (Facultatif, pour associer la passerelle managée par défaut à un espace de travail) Un client REST pour appeler l’API REST Gestion des API.

Créer un espace de travail et associer la passerelle managée par défaut - API REST

Vous pouvez créer un espace de travail qui route le trafic d’API via la passerelle managée par défaut du service au lieu d’une passerelle d’espace de travail. Cette option évite le coût supplémentaire et la complexité d’une ressource de passerelle distincte. Le trafic d’API est acheminé via le nom d’hôte par défaut du service (par exemple, <service-name>.azure-api.net).

Utilisez l’espace de travail - Créer ou mettre à jour l’API REST pour créer un espace de travail.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}?api-version=2024-05-01
Authorization: Bearer {token}
Content-Type: application/json

{
  "properties": {
    "displayName": "my workspace",
    "description": "Workspace using default managed gateway",
    "serveOn": "workspaceAndDefault"
  }
}

Remplacez :

• {subscriptionId} par votre ID d’abonnement Azure
• {resourceGroupName} avec le nom du groupe de ressources de votre instance Gestion des API
• {serviceName} avec le nom de votre instance Gestion des API
• {workspaceId} avec un identificateur d’espace de travail unique (alphanumérique, traits d’union autorisés)

Une réponse réussie retourne HTTP 201 Created avec la ressource d’espace de travail. Par défaut, l’espace de travail achemine le trafic d’API via le nom d’hôte par défaut du service.

Une fois l’espace de travail créé, passez à Affecter des utilisateurs à l’espace de travail : portail pour configurer les autorisations d’accès.

Créer un espace de travail et associer une passerelle d’espace de travail - portail

1. Connectez-vous au portail Azure et accédez à votre instance de API Management.

2. Dans le menu de gauche, sous API, sélectionnez Espaces de travail>+ Ajouter.

3. 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.

4. 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.

5. 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.

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.

Si l’espace de travail utilise une ressource de passerelle d’espace de travail, attribuez également aux utilisateurs de l’espace de travail un rôle RBAC fourni par Azure ayant pour étendue la passerelle d’espace de travail.

• 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

1. Connectez-vous au portail Azure et accédez à votre instance de API Management.

2. Dans le menu de gauche, sélectionnez Contrôle d’accès (IAM)>+ Ajouter.

3. 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

1. Dans le menu de votre instance Gestion des API, sous API, sélectionnez Espaces de travail> le nom de l’espace de travail créé.

2. Dans la fenêtre Espace de travail, sélectionnez Contrôle d’accès (IAM)>+ Ajouter.

3. Attribuez aux membres de l’espace de travail l’un des rôles limités à l’espace de travail suivants afin qu’ils puissent gérer les API de l’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

1. Connectez-vous au portail Azure et accédez à votre instance de API Management.

2. Dans le menu de gauche, sous API, sélectionnez Espaces de travail> le nom de votre espace de travail.

3. Dans le menu de gauche de l’espace de travail, sélectionnez Passerelles, puis sélectionnez la passerelle d’espace de travail.

4. Dans le menu de gauche, sélectionnez Contrôle d’accès (IAM)>+ Ajouter.

5. Attribuez l’un des rôles suivants à chaque membre de l’espace de travail. Au minimum, attribuez le rôle Lecteur pour afficher les paramètres de la passerelle. Les propriétaires et les contributeurs peuvent gérer les paramètres de la passerelle, notamment 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 d’Azure Monitor pour l’espace de travail et les envoyer à un espace de travail Log Analytics. L’équipe de l’espace de travail peut 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, vous devez disposer de paramètres de diagnostic aux niveaux du service et de l’espace de travail :

1. Tout d’abord, activez un paramètre de diagnostic au niveau du service pour collecter les journaux de la passerelle d’API Management, si un paramètre n’est pas déjà activé. Envoyez des journaux à un espace de travail Log Analytics. Pour plus d’informations, consultez Configurer les paramètres de diagnostic pour gestion des API.

2. Ensuite, activez un paramètre de diagnostic au niveau de l’espace de travail pour envoyer les journaux de la passerelle API Management vers le 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 sont 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 :

1. Connectez-vous au portail Azure et accédez à votre instance de API Management.

2. Dans le menu de gauche, sous API, sélectionnez Espaces de travail> le nom de votre espace de travail.

3. Dans le menu de gauche des espaces de travail, sous Surveillance, sélectionnez Paramètres> de diagnostic+ Ajouter un paramètre de diagnostic.

4. Dans le paramètre diagnostic, entrez ou sélectionnez les détails du paramètre :

   1. Nom du paramètre de diagnostic : entrez un nom descriptif.
   2. Groupes de catégories : effectuez éventuellement une sélection pour votre scénario.
   3. Sous Catégories, sélectionnez Journaux liés à ApiManagement Gateway pour recueillir les journaux de passerelle des API dans cet espace de travail.
   4. 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.
   5. Cliquez sur Enregistrer.

Commencez avec votre espace de travail

En fonction de leur rôle dans l’espace de travail, les utilisateurs peuvent avoir des autorisations pour créer des API, des produits, des abonnements et d’autres ressources, ou ils peuvent avoir un accès en lecture seule à certaines ou à toutes ces ressources.

Consultez les conseils suivants pour commencer à gérer, protéger et publier des API dans un espace de travail.

Contenu connexe

• En savoir plus sur les espaces de travail dans Gestion des API Azure.
• Utiliser un réseau virtuel pour sécuriser le trafic entrant ou sortant pour Gestion des API Azure