Activer et afficher l’affichage du portail Du Centre des API Azure - Extension VS Code

2025-06-09

Cet article explique comment fournir aux développeurs d’entreprise l’accès à la vue du portail Du Centre des API Azure dans l’extension Visual Studio Code pour le Centre d’API Azure. À l’aide de la vue portail, les développeurs peuvent découvrir des API dans votre centre d’API Azure, afficher les définitions d’API et éventuellement générer des clients d’API lorsqu’ils n’ont pas accès pour gérer le centre d’API lui-même ou ajouter des API à l’inventaire. L’accès à la vue du portail du Centre d’API est géré à l’aide de l’ID Microsoft Entra et du contrôle d’accès en fonction du rôle Azure.

Conseil / Astuce

L’extension Visual Studio Code fournit plus de fonctionnalités pour les développeurs d’API disposant d’autorisations pour gérer un centre d’API Azure. Par exemple, les développeurs d’API peuvent inscrire des API dans le centre d’API directement ou à l’aide de pipelines CI/CD. En savoir plus

Conditions préalables

Pour les administrateurs du centre d’API

Un Centre d’API dans votre abonnement Azure. Si vous n’en avez pas encore créé, consultez Démarrage rapide : Créer votre centre d’API.
Autorisations de création d’une inscription d’application dans un locataire Microsoft Entra associé à votre abonnement Azure et autorisations pour accorder l’accès aux données dans votre centre d’API.

Pour les développeurs d’applications

Extension Centre API Azure pour Visual Studio Code

Remarque

Lorsque cela est indiqué, certaines fonctionnalités sont disponibles uniquement dans la préversion de l’extension Azure API Center. Lors de l’installation de l’extension à partir de la Place de marché Visual Studio Code, vous pouvez choisir d’installer la version de mise en production ou une version préliminaire. Basculez entre les deux versions à tout moment à l’aide du menu contextuel Gérer du bouton Gérer de l’extension, dans la vue Extensions.

Les extensions Visual Studio Code suivantes sont facultatives :

Extension Microsoft Kiota : pour générer des clients d’API
GitHub Copilot et GitHub Copilot Chat, fournis avec accès à GitHub Copilot - pour utiliser des outils de modèle de langage en mode agent pour découvrir les API

Étapes permettant aux administrateurs du centre d’API d’activer l’accès à la vue du portail du Centre d’API

Les sections suivantes fournissent des étapes pour permettre aux développeurs d’entreprise d’accéder à la vue du portail du Centre d’API.

Créer une inscription d’application Microsoft Entra

Commencez par configurer une inscription d'applications dans votre tenant Microsoft Entra ID. L’inscription de l’application permet au portail du Centre d’API d’accéder aux données de votre centre d’API pour le compte d’un utilisateur connecté.

Le Centre d’API peut configurer automatiquement l’inscription d’application, ou vous pouvez créer manuellement l’inscription de l’application.

Configurer automatiquement l’inscription de l’application

Pour configurer automatiquement l’inscription de l’application, procédez comme suit :

Dans le Portail Microsoft Azure, accédez à votre centre API.
Dans le menu de gauche, sélectionnezParamètres du > du Centre des API.
Sous l’onglet Fournisseur d’identité , sélectionnez Démarrer la configuration.
Sélectionnez Enregistrer + publier.

Configurer manuellement l’inscription de l’application

Si vous souhaitez créer manuellement l’inscription de l’application, procédez comme suit :

Dans le portail Azure, accédez à ID Microsoft Entra>Inscriptions d’application.
Sélectionnez + Nouvelle inscription.
Sur la page Inscrire une application, définissez les valeurs comme suit :
1. Définissez Nom sur un nom significatif tel que api-center-portal
2. Sous Types de comptes pris en charge, sélectionnez Comptes dans cet annuaire organisationnel (locataire unique) .
3. Dans l’URI de redirection, sélectionnez Application monopage (SPA) et définissez l’URI. Entrez l’URI de votre déploiement du portail du Centre d’API, sous la forme suivante : https://<service-name>.portal.<location>.azure-api-center.ms Remplacez <service name> et <location> par le nom de votre centre d'API et l'emplacement où il est déployé. Exemple : https://myapicenter.portal.eastus.azure-api-center.ms.
4. Sélectionnez Inscrire.

Configurer des URI de redirection supplémentaires pour l’extension VS Code

Lors de l’activation de l’affichage du portail du Centre d’API dans l’extension Visual Studio Code pour le Centre d’API, configurez également les URI de redirection suivants dans l’inscription de l’application :

Dans le portail Azure, accédez à votre inscription d’application.
Dans la page Gérer>l’authentification , sélectionnez Ajouter une plateforme , puis sélectionnez Applications mobiles et de bureau.
Configurez les trois URI de redirection personnalisés suivants :
https://vscode.dev/redirect
http://localhost
ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>

Remplacez <application-client-id> par l’ID d’application (client) de cette application. Vous trouverez cette valeur dans la page Vue d’ensemble de l’inscription de l’application.

Les développeurs d’entreprise doivent se connecter avec un compte Microsoft pour afficher la vue du portail du Centre d’API pour votre centre d’API. Si nécessaire, ajoutez ou invitez des développeurs à votre client Microsoft Entra.

Pour activer la connexion, attribuez le rôle Lecteur de données du Centre d’API Azure aux utilisateurs ou groupes de votre organisation, limité à votre centre d’API.

Important

Par défaut, vous et d’autres administrateurs du Centre d’API n’ont pas accès aux API dans le portail du Centre d’API. Assurez-vous d’attribuer le rôle Azure API Center Data Reader à vous-même et aux autres administrateurs.

Pour connaître les conditions préalables détaillées et les étapes à suivre pour attribuer un rôle aux utilisateurs et aux groupes, consultez Affecter des rôles Azure à l’aide du portail Azure. Les brèves étapes suivantes sont les suivantes :

Dans le Portail Microsoft Azure, accédez à votre centre API.
Dans le menu de gauche, sélectionnez Contrôle d’accès (IAM)>+ Ajouter une attribution de rôle.
Dans le volet Ajouter une attribution de rôle , définissez les valeurs comme suit :
1. Dans la page Rôle , recherchez et sélectionnez Lecteur de données du Centre d’API Azure. Cliquez sur Suivant.
2. Dans la page Membres, Dans Affecter l’accès, sélectionnez Utilisateur, groupe ou principal> de service+ Sélectionner des membres.
3. Dans la page Sélectionner des membres , recherchez et sélectionnez les utilisateurs ou les groupes auxquels attribuer le rôle. Cliquez sur Sélectionner , puis sur Suivant.
4. Vérifiez l'attribution du rôle, puis sélectionnez Vérifier + attribuer.

Remarque

Pour simplifier la configuration de l’accès pour les nouveaux utilisateurs, nous vous recommandons d’attribuer le rôle à un groupe Microsoft Entra et de configurer une règle d’appartenance de groupe dynamique. Pour en savoir plus, consultez Créer ou mettre à jour un groupe dynamique dans l’ID Microsoft Entra.

Après avoir configuré l’accès au portail, les utilisateurs configurés peuvent se connecter au portail et afficher les API dans votre centre d’API.

Remarque

Le premier utilisateur à se connecter au portail est invité à donner son consentement aux autorisations demandées par l’inscription de l’application du portail du Centre d’API. Par la suite, d’autres utilisateurs configurés ne sont pas invités à donner leur consentement.

Étapes permettant aux développeurs d’entreprise d’accéder à la vue du portail du Centre d’API

Les développeurs peuvent suivre ces étapes pour se connecter et se connecter à une vue du portail du Centre des API à l’aide de l’extension Visual Studio Code. Les paramètres de connexion au centre d’API doivent être fournis par l’administrateur du centre d’API. Après la connexion, les développeurs peuvent découvrir et consommer les API dans le centre d’API.

Se connecter à un centre d’API

Dans Visual Studio Code, dans la barre d’activités à gauche, sélectionnez API Center (Centre API).
Utilisez le raccourci clavier Ctrl+Maj+P pour ouvrir la palette de commandes. Tapez Azure API Center : connectez-vous à un centre d’API et appuyez sur Entrée.
Répondez aux invites pour entrer les informations suivantes :
1. URL d’exécution de votre centre d’API, au format <service name>.data.<region>.azure-apicenter.ms (ne pas préfixer avec https://). Exemple : contoso-apic.data.eastus.azure-apicenter.ms. Cette URL d’exécution s’affiche sur la page Vue d’ensemble du Centre d’API dans la vue du portail Azure.
2. ID d'application (client) de l'application enregistrée configurée par l'administrateur dans la section précédente.
3. ID de répertoire (tenant) à partir de l’inscription de l’application configurée par l’administrateur dans la section précédente.
Conseil / Astuce

Un administrateur du centre d’API doit fournir les détails de connexion précédents aux développeurs ou fournir un lien direct au format suivant :
vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

Une fois que vous vous êtes connecté au centre d’API, le nom du centre d’API apparaît dans la vue du portail du Centre d’API.
Pour afficher les API dans le centre d’API, sous le nom du centre d’API, sélectionnez Se connecter à Azure. La connexion est autorisée avec un compte Microsoft affecté au rôle Lecteur de données du Centre d’API Azure dans le Centre d’API.
Après vous être connecté, sélectionnez LES API pour répertorier les API dans le centre d’API. Développez une API pour explorer ses versions et définitions.
Répétez les étapes précédentes pour vous connecter à d’autres centres d’API, si l’accès est configuré.

Découvrir et consommer des API dans l’affichage du portail du Centre d’API

La vue du portail du Centre des API permet aux développeurs d’entreprise de découvrir les détails de l’API et de démarrer le développement du client d’API. Les développeurs peuvent accéder aux fonctionnalités suivantes en cliquant avec le bouton droit sur une définition d’API dans la vue du portail du Centre des API :

Document de spécification d’API d’exportation : exporter une spécification d’API à partir d’une définition, puis la télécharger en tant que fichier
Générer un client d’API - Utiliser l’extension Microsoft Kiota pour générer un client d’API pour leur langue préférée
Générer Markdown - Générer la documentation de l’API au format Markdown
Documentation OpenAPI - Consultez la documentation d’une définition d’API et essayez les opérations dans une interface utilisateur Swagger (disponible uniquement pour les définitions OpenAPI)

Utiliser les outils de modèle de langage

Dans la version préliminaire de l’extension Du Centre des API Azure, les développeurs ayant accès à la vue du portail du Centre d’API peuvent ajouter des outils de modèle de langage du Centre d’API à utiliser en mode agent de GitHub Copilot. En savoir plus sur l’utilisation d’outils en mode agent.

Les outils du Centre des API peuvent être utilisés en mode agent pour vous aider à rechercher des API et des versions d’API, des définitions d’API et des spécifications, des déploiements et bien plus encore à l’aide d’invites en langage naturel.

Pour ajouter et utiliser les outils en mode langage du Centre d’API dans le mode agent de GitHub Copilot :

Connectez-vous à un centre d’API comme décrit dans une section précédente.
Ouvrez GitHub Copilot Chat dans Visual Studio Code.
Définissez le mode de conversation GitHub Copilot sur Agent.
Sélectionnez l’icône Outils dans la fenêtre de conversation.
Sélectionnez un ou plusieurs outils du Centre d’API à mettre à disposition dans la conversation.

Entrez une demande dans la fenêtre de conversation pour utiliser les outils disponibles. Par exemple:

Find potential MCP servers for a project I'm working on. I need the deployment URLs from my API center of any MCP servers that can run code snippets.

Passez en revue les réponses de GitHub Copilot Chat. Poursuivez la conversation pour affiner les résultats ou poser des questions de suivi.

Résolution des problèmes

Si les utilisateurs auxquels le rôle Lecteur de données du Centre des API Azure a été attribué ne peuvent pas terminer le processus de connexion après avoir sélectionné Se connecter à Azure dans la vue du portail du Centre des API, il peut y avoir un problème avec la configuration de la connexion.

Vérifiez les paramètres de l’inscription de l’application que vous avez configurée dans l’ID Microsoft Entra. Vérifiez les valeurs de l’ID d’application (client) et de l’ID d’annuaire (locataire) dans l’enregistrement de l’application, ainsi que l’URL d'exécution du centre API. Ensuite, configurez à nouveau la connexion au centre d’API.