Teilen über

Aktivieren und Anzeigen der Azure API Center-Portalansicht – VS Code-Erweiterung

In diesem Artikel wird erläutert, wie Unternehmensentwicklern Zugriff auf die Portalansicht des Azure API Center in der Visual Studio Code-Erweiterung für Azure API Center bieten. Mithilfe der Portalansicht können Entwickler APIs im Azure API Center ermitteln, API-Definitionen anzeigen und optional API-Clients generieren, wenn sie keinen Zugriff auf die Verwaltung des API-Centers selbst haben oder APIs zum Bestand hinzufügen. Der Zugriff auf die API Center-Portalansicht wird mithilfe der Microsoft Entra-ID und der rollenbasierten Zugriffssteuerung von Azure verwaltet.

Tipp

Die Visual Studio Code-Erweiterung bietet weitere Features für API-Entwickler, die über Berechtigungen zum Verwalten eines Azure API Center verfügen. API-Entwickler können APIs beispielsweise direkt im API Center registrieren oder CI/CD-Pipelines verwenden. Weitere Informationen

Voraussetzungen

Für API Center-Administratoren

  • Ein API-Center in Ihrem Azure-Abonnement. Wenn Sie noch keins erstellt haben, lesen Sie die Schnellstartanleitung: Erstellen Ihres API-Centers.

  • Berechtigungen zum Erstellen einer App-Registrierung in einem Microsoft Entra-Mandanten, der Ihrem Azure-Abonnement zugeordnet ist, und Berechtigungen zum Gewähren des Zugriffs auf Daten in Ihrem API Center.

Für App-Entwickler

Die folgenden Visual Studio Code-Erweiterungen sind optional:

Schritte für API Center-Administratoren zum Aktivieren des Zugriffs auf die API Center-Portalansicht

Die folgenden Abschnitte enthalten Schritte für API Center-Administratoren, um Unternehmensentwicklern den Zugriff auf die API Center-Portalansicht zu ermöglichen.

Erstellen der Microsoft Entra-App-Registrierung

Konfigurieren Sie zunächst eine App-Registrierung in Ihrem Microsoft Entra ID-Mandanten. Die App-Registrierung ermöglicht es dem API Center-Portal, im Namen eines angemeldeten Benutzers auf Daten aus Ihrem API-Center zuzugreifen.

DAS API Center kann die App-Registrierung automatisch einrichten, oder Sie können die App-Registrierung manuell erstellen.

Automatisches Einrichten der App-Registrierung

Führen Sie die folgenden Schritte aus, um die App-Registrierung automatisch einzurichten:

  1. Navigieren Sie im Azure-Portal zu Ihrem API Center.
  2. Wählen Sie im linken Menü die Api Center-Portaleinstellungen> aus.
  3. Wählen Sie auf der Registerkarte "Identitätsanbieter " die Option "Einrichten starten" aus.
  4. Wählen Sie auf der Registerkarte "Schnelleinrichtung " die Option "Speichern + Veröffentlichen" aus.

Wenn Sie später auf die App-Registrierung zugreifen müssen, finden Sie sie im Portal unter App-Registrierungen. Die Anwendung wird mit dem folgenden Format benannt: <api-center-name-apic-aad>.

Manuelles Einrichten der App-Registrierung

Wenn Sie die App-Registrierung manuell erstellen möchten, führen Sie die folgenden Schritte aus:

  1. Navigieren Sie im Azure-Portal zu Microsoft Entra ID>Manage>App-Registrierungen.

  2. Wählen Sie + Neue Registrierung aus.

  3. Legen Sie auf der Seite Anwendung registrieren folgende Werte fest:

    1. Festlegen des Namens auf einen aussagekräftigen Namen wie api-center-portal
    2. Wählen Sie unter "Unterstützte Kontotypen" nur "Konten" in diesem Organisationsverzeichnis (<Verzeichnisname> – Einzelner Mandant) aus.
    3. Wählen Sie im Umleitungs-URIdie Einzelseitenanwendung (Single Page Application, SPA) aus, und legen Sie den URI fest. Geben Sie den URI Ihrer API Center-Portalbereitstellung in das folgende Formular ein: https://<service-name>.portal.<location>.azure-apicenter.ms Ersetzen Sie <service name> und <location> durch den Namen Ihres API-Centers und den Ort, an dem es bereitgestellt wird. Beispiel: https://myapicenter.portal.eastus.azure-apicenter.ms.
    4. Wählen Sie Registrieren aus.

Konfigurieren zusätzlicher Umleitungs-URIs für die VS-Codeerweiterung

Konfigurieren Sie beim Aktivieren der API Center-Portalansicht in der Visual Studio Code-Erweiterung für API Center auch die folgenden Umleitungs-URIs in der App-Registrierung:

  1. Navigieren Sie im Azure-Portal zu Ihrer App-Registrierung.

  2. Wählen Sie auf der Seite "Authentifizierung>" die Option "Plattform hinzufügen" und dann "Mobile" und "Desktopanwendungen" aus.

  3. Konfigurieren Sie die folgenden drei benutzerdefinierten Umleitungs-URIs:
    https://vscode.dev/redirect
    http://localhost
    ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>

    Ersetzen Sie <application-client-id> durch die Anwendungs-ID (Client-ID) dieser App. Sie finden diesen Wert auf der Seite "Übersicht" der App-Registrierung.

Aktivieren der Anmeldung bei der API Center-Portalansicht durch Microsoft Entra-Benutzende und -Gruppen

Enterprise-Entwickler müssen sich mit einem Microsoft-Konto anmelden, um die API Center-Portalansicht für Ihr API Center anzuzeigen. Fügen Sie bei Bedarf Entwickler zu Ihrem Microsoft Entra-Mandanten hinzu oder laden Sie sie ein .

Um die Anmeldung beim API Center-Portal für den Zugriff auf APIs zu ermöglichen, weisen Sie benutzern oder Gruppen in Ihrer Organisation die Rolle " Azure API Center Data Reader " zu, die auf Ihr API Center ausgerichtet ist.

Von großer Bedeutung

Standardmäßig müssen Sie und andere Administratoren des API Center sich anmelden, um auf APIs im API Center-Portal zuzugreifen. Stellen Sie sicher, dass Sie die Rolle Azure API Center-Datenleser sich selbst und anderen Administratoren zuweisen.

Ausführliche Voraussetzungen und Schritte zum Zuweisen einer Rolle zu Benutzern und Gruppen finden Sie unter Zuweisen von Azure-Rollen mithilfe des Azure-Portals. Kurze Schritte:

  1. Navigieren Sie im Azure-Portal zu Ihrem API Center.
  2. Wählen Sie im linken Menü die Option Access Control (IAM)>+ Rollenzuweisung hinzufügen aus.
  3. Legen Sie im Bereich " Rollenzuweisung hinzufügen " die Werte wie folgt fest:
    1. Suchen und wählen Sie auf der Seite Rolle den Azure API Center-Datenleser aus. Wählen Sie Weiteraus.
    2. Wählen Sie auf der Seite Mitglieder unter Zugriff zuweisen die Option Benutzer, Gruppe oder Dienstprinzipal>+ Mitglieder auswählen aus.
    3. Suchen Sie auf der Seite Mitglieder auswählen nach den Benutzern oder Gruppen, denen die Rolle zugewiesen werden soll, und wählen Sie diese aus. Klicken Sie auf Auswählen und dann auf Weiter.
    4. Überprüfen Sie die Rollenzuweisung, und wählen Sie Überprüfen + zuweisen aus.

Hinweis

Um die Zugriffskonfiguration für neue Benutzer zu optimieren, empfiehlt es sich, die Rolle einer Microsoft Entra-Gruppe zuzuweisen und eine dynamische Gruppenmitgliedschaftsregel zu konfigurieren. Weitere Informationen finden Sie unter Erstellen oder Aktualisieren einer dynamischen Gruppe in microsoft Entra ID.

Nachdem Sie den Zugriff auf das Portal konfiguriert haben, können sich konfigurierte Benutzer beim Portal anmelden und die APIs in Ihrem API Center anzeigen.

Hinweis

Der erste Benutzer, der sich beim Portal anmeldet, wird aufgefordert, den Berechtigungen zuzustimmen, die von der API Center-Portal-App-Registrierung angefordert werden. Danach werden andere konfigurierte Benutzer nicht zur Zustimmung aufgefordert.

Schritte für Unternehmensentwickler für den Zugriff auf die API Center-Portalansicht

Entwickler können diese Schritte ausführen, um mithilfe der Visual Studio Code-Erweiterung eine Verbindung herzustellen und sich bei einer API Center-Portalansicht anzumelden. Einstellungen zum Herstellen einer Verbindung mit dem API Center müssen vom API Center-Administrator bereitgestellt werden. Nach dem Herstellen einer Verbindung können Entwickler die APIs im API Center ermitteln und nutzen.

Herstellen einer Verbindung mit einem API-Center

  1. Wählen Sie in Visual Studio Code auf der Aktivitätsleiste auf der linken Seite „API-Center“ aus.

    Screenshot des API Center-Symbols in der Aktivitätsleiste.

  2. Verwenden Sie die Tastenkombination STRG+UMSCHALT+P, um die Befehlspalette zu öffnen. Geben Sie Azure API Center ein: Stellen Sie eine Verbindung mit einem API Center her, und drücken Sie die EINGABETASTE.

  3. Beantworten Sie die Eingabeaufforderungen, um die folgenden Informationen einzugeben:

    1. Die Laufzeit-URL Ihres API-Centers im Format <service name>.data.<region>.azure-apicenter.ms (nicht mit https:// voranstellen). Beispiel: contoso-apic.data.eastus.azure-apicenter.ms. Diese Laufzeit-URL wird auf der Seite "Übersicht" des API-Centers in der Azure-Portalansicht angezeigt.

    2. Die Anwendungs-ID (Client-ID) aus der App-Registrierung, die vom Administrator im vorherigen Abschnitt konfiguriert wurde.

    3. Die Verzeichnis-ID (Mandanten-ID) aus der App-Registrierung, die im vorherigen Abschnitt durch eine administrierende Person konfiguriert wurde.

    Tipp

    Ein API Center-Administrator muss die vorherigen Verbindungsdetails für Entwickler bereitstellen oder einen direkten Link im folgenden Format bereitstellen:
    vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms

    Nachdem Sie eine Verbindung mit dem API Center hergestellt haben, wird der Name des API Center in der API Center-Portalansicht angezeigt.

  4. Um die APIs im API Center anzuzeigen, wählen Sie unter dem API Center-Namen die Option "Bei Azure anmelden" aus. Die Anmeldung ist mit einem Microsoft-Konto zulässig, dem die Azure API Center Data Reader-Rolle im API Center zugewiesen ist.

    Screenshot der API Center-Portalansicht in der API Center-Erweiterung.

  5. Wählen Sie nach der Anmeldung APIs aus, um die APIs im API Center auflisten zu können. Erweitern Sie eine API, um ihre Versionen und Definitionen zu erkunden.

    Screenshot der API Center-API-Definitionen in der API Center-Erweiterung.

  6. Wiederholen Sie die vorstehenden Schritte, um eine Verbindung mit weiteren API-Centern herzustellen, wenn der Zugriff konfiguriert ist.

Entdecken und Nutzen von APIs in der API Center-Portalansicht

Die API Center-Portalansicht hilft Unternehmensentwicklern, API-Details zu ermitteln und die API-Cliententwicklung zu starten. Entwickler können auf die folgenden Features zugreifen, indem Sie in der API Center-Portalansicht mit der rechten Maustaste auf eine API-Definition klicken:

  • Exportieren eines API-Spezifikationsdokuments – Exportieren einer API-Spezifikation aus einer Definition und anschließendes Herunterladen als Datei
  • Api-Client generieren – Verwenden der Microsoft Kiota-Erweiterung zum Generieren eines API-Clients für ihre bevorzugte Sprache
  • Generieren von Markdown – Generieren der API-Dokumentation im Markdown-Format
  • OpenAPI-Dokumentation – Anzeigen der Dokumentation für eine API-Definition und Testen von Vorgängen in einer Swagger-Benutzeroberfläche (nur für OpenAPI-Definitionen verfügbar)

Verwenden von Sprachmodelltools

Entwickler mit Zugriff auf die API Center-Portalansicht können API Center-Sprachmodelltools hinzufügen, die im Agentmodus von GitHub Copilot verwendet werden. Erfahren Sie mehr über die Verwendung von Tools im Agentmodus.

Die API Center-Tools können im Agentmodus verwendet werden, um nach APIs und API-Versionen, API-Definitionen und Spezifikationen, Bereitstellungen und mehr mithilfe von Eingabeaufforderungen in natürlicher Sprache zu suchen.

So fügen Sie API Center-Sprachmodustools im Agentmodus von GitHub Copilot hinzu und verwenden sie:

  1. Stellen Sie eine Verbindung mit einem API-Center her, wie in einem vorherigen Abschnitt beschrieben.

  2. Öffnen Sie GitHub Copilot Chat in Visual Studio Code.

  3. Legen Sie den Modus von GitHub Copilot Chat auf Agent fest.

  4. Wählen Sie im Chatfenster das Symbol Extras aus.

    Screenshot des GitHub Copilot-Chatfensters in Visual Studio Code.

  5. Wählen Sie ein oder mehrere API Center-Tools aus, die im Chat verfügbar sein sollen.

    Screenshot der Auswahl von API Center-Tools in Visual Studio Code.

  6. Geben Sie im Chatfenster eine Eingabeaufforderung ein, um die verfügbaren Tools zu verwenden. Beispiel:

    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.

  7. Überprüfen Sie die Antworten von GitHub Copilot Chat. Fahren Sie mit der Unterhaltung fort, um die Ergebnisse zu verfeinern oder Nachverfolgungsfragen zu stellen.

Problembehandlung

Anmeldung bei Azure nicht möglich

Wenn Benutzer, denen die Azure API Center Data Reader-Rolle zugewiesen wurde, den Anmeldefluss nach der Auswahl der Anmeldung bei Azure in der API Center-Portalansicht nicht abschließen können, liegt möglicherweise ein Problem mit der Konfiguration der Verbindung vor.

Überprüfen Sie die Einstellungen in der App-Registrierung, die Sie in der Microsoft Entra-ID konfiguriert haben. Bestätigen Sie die Werte der Anwendungs-ID (Client-ID) und der Verzeichnis-ID (Mandanten-ID) in der App-Registrierung und der Runtime-URL des API-Centers. Richten Sie dann die Verbindung zum API Center erneut ein.

Verwandte Inhalte

  • Last updated on