Synchronisieren von API-Ressourcen aus einem Git-Repository mit Azure API Center

In diesem Artikel wird beschrieben, wie Sie ein Git-Repository in Azure API Center integrieren, um API-Ressourcen wie skills, agents und MCP-Server in Ihren API-Bestand zu synchronisieren. Durch das Verbinden eines Git-Repositorys können Sie Ihr API Center-Inventar auf dem neuesten Stand halten, ohne jedes Objekt manuell zu registrieren oder zu aktualisieren.

Wenn Sie ein Git-Repository integrieren:

  • Ihr API-Center erstellt eine Umgebung , die das Repository als Quelle von Ressourcen darstellt.
  • API Center synchronisiert ressourceninformationen regelmäßig aus dem Repository mit Ihrem API Center-Bestand.

Voraussetzungen

  • Ein API-Center. Wenn Sie noch kein API-Center haben, lesen Sie die Schnellstartanleitung zum Erstellen eines API-Centers.

  • Ein Git-Repository mit den Ressourcen, die Sie synchronisieren möchten.

  • Für nicht öffentliche Repositorys ein persönliches Zugriffstoken (PAT) für den Zugriff auf das Repository. Der PAT muss über entsprechende Berechtigungen zum Lesen des Repositoryinhalts verfügen. Informationen zum Erstellen eines PAT für GitHub finden Sie unter Erstellen eines fein abgestimmten persönlichen Zugriffstokens.

  • Ein Azure-Schlüsseltresor zum Speichern des PAT, falls dieses für den Zugriff verwendet wird. Wenn Sie einen Schlüsseltresor erstellen müssen, lesen Sie Quickstart: Erstellen eines Schlüsseltresors mithilfe des Azure Portals. Um geheime Schlüssel im Schlüsseltresor hinzuzufügen oder zu verwalten, benötigen Sie mindestens die Rolle " Key Vault Secrets Officer " oder gleichwertige Berechtigungen.

  • Für Azure CLI:

    Note

    Sie können Azure CLI-Befehlsbeispiele in diesem Artikel in PowerShell oder einer Bash-Shell ausführen. Bei Bedarf aufgrund unterschiedlicher Variablensyntax werden separate Befehlsbeispiele für die beiden Shells bereitgestellt.

Speichern von PAT im Azure Key Vault

Wenn Ihr Git-Repository privat ist, laden Sie einen PAT manuell in Azure Key Vault hoch und speichern Sie ihn sicher, sodass der Zugriff auf das Repository gewährt wird. Wenn Sie das Git-Repository in Ihr API Center integrieren, konfigurieren Sie die Integration, um diesen geheimen Schlüssel zu verwenden.

Weitere Informationen finden Sie unter Schnellstart: Festlegen eines Geheimnisses und Abrufen des Geheimnisses aus Azure Key Vault mithilfe des Azure-Portals.

Wenn Sie kein PAT konfigurieren müssen, fahren Sie mit der Integration eines Git-Repositorys fort.

Konfigurieren einer verwalteten Identität für Ihr API Center

Ihr API Center verwendet eine verwaltete Identität, um sich bei Azure Key Vault zu authentifizieren und das PAT abzurufen, das für den Zugriff auf das Git-Repository erforderlich ist. Die folgenden Verfahren beschreiben, wie Sie eine verwaltete Identität für Ihr API Center manuell konfigurieren und ihm die erforderlichen Berechtigungen für den Zugriff auf den Key Vault zuweisen.

Wenn Sie die verwaltete Identität nicht konfigurieren, kann das API Center diese automatisch konfigurieren, wenn Sie das Git-Repository integrieren.

In diesem Szenario verwendet Ihr API-Center eine verwaltete Identität für den Zugriff auf Azure-Ressourcen. Aktivieren Sie je nach Ihren Anforderungen entweder eine systemseitig oder ein oder mehrere benutzerseitig zugewiesene verwaltete Identitäten.

Die folgenden Beispiele zeigen, wie Sie eine systemseitig zugewiesene verwaltete Identität mithilfe des Azure-Portals oder der Azure CLI aktivieren. Im Großen und Ganzen sind die Konfigurationsschritte für eine benutzerseitig zugewiesene verwaltete Identität ähnlich.

  1. Wechseln Sie im Portal zum API Center.
  2. Wählen Sie im Randleistenmenü unter "Sicherheit" die Option "Verwaltete Identitäten" aus.
  3. Wählen Sie System zugewiesen aus, und legen Sie den Status auf Ein fest.
  4. Wählen Sie "Speichern" aus.

Zuweisen der verwalteten Identität zur Rolle „Key Vault-Geheimnisbenutzer”

Um den Import der Objekte zuzulassen, weisen Sie die verwaltete Identität Ihres API Centers der Rolle "Key Vault Secrets User" in Ihrem Azure Key Vault zu. Sie können das Portal oder die Azure CLI verwenden.

  1. Wechseln Sie im Portal zu Ihrem Key Vault.
  2. Wählen Sie im Randleistenmenü die Option Access Control (IAM) aus.
  3. Wählen Sie + Rollenzuweisung hinzufügen aus.
  4. Legen Sie auf der Seite Rollenzuweisung hinzufügen die Werte wie folgt fest:
    1. Wählen Sie auf der Registerkarte RoleKey Vault Secrets User aus.
    2. Auf der Seite Mitglieder unter Zugriff zuweisen: Wählen Sie Verwaltete Identität>+ Mitglieder auswählen aus.
    3. Wählen Sie auf der Seite Verwaltete Identitäten auswählen die systemseitig zugewiesene verwaltete Identität Ihres API-Centers aus, die Sie im vorherigen Abschnitt hinzugefügt haben. Klicke auf Auswählen.
    4. Wählen Sie "Überprüfen+ Zuweisen" aus.

Integrieren eines Git-Repositorys

So integrieren Sie ein Git-Repository:

  1. Wechseln Sie im Azure-Portal zu Ihrem API Center.

  2. Wählen Sie im Seitenmenü Plattformen>Integrationen aus.

  3. Wählen Sie +Neue Integration und dann "Aus Git-Repository" aus.

  4. Geben Sie bei der Integration Ihres Git-Repositorys die folgenden Informationen ein:

    Feld Description
    Konfigurieren der Git-Repositoryquelle
    Repository-URL Geben Sie die URL zum Git-Repository ein, das Objektdateien enthält. Optional können Sie die Branch und den Unterordner angeben (z. B. https://github.com/<org>/<repo>/tree/main/skills).
    Git-Anbieter Wählen Sie den Anbieter aus (z. B. GitHub).
    Konfiguration des Objekttyps API Center konfiguriert einen Standard-Fähigkeit-Asset-Typ für mit Dateimuster **/skill.md.

    Wählen Sie +Objekttyp hinzufügen , um einen oder mehrere Objekttypen zur Synchronisierung hinzuzufügen.
    Persönliches Zugriffstoken (PAT) Wenn Sie ein PAT in Azure Key Vault gespeichert haben, klicken Sie auf Auswählen, um zum Key Vault-Geheimnis zu navigieren.

    Optional: Wählen Sie Verwaltete Identität automatisch konfigurieren und Berechtigungen zuweisen aus, wenn Sie keine verwaltete Identität manuell für den Zugriff auf das Schlüsseltresorgeheimnis konfiguriert haben.
    Integrationsdetails Akzeptieren Sie den generierten Linkbezeichner, oder geben Sie eine benutzerdefinierte ID für den Integrationslink an.
    Umgebungsdetails
    Umgebungstitel Geben Sie einen Anzeigenamen für die Umgebung des Repositorys ein (z.B. Git-Repository).
    Identifizierung Geben Sie einen Ressourcennamen für die Umgebung ein (z. B. git-repository).
    Umgebungstyp Wählen Sie den Umgebungstyp aus (z. B. "Produktion").
    Beschreibung Fügen Sie optional eine Beschreibung für die Umgebung hinzu.
    Objektdetails
    Lebenszyklus Wählen Sie die Lebenszyklusstufe für Ressourcen aus, die aus dem Repository synchronisiert werden (z. B. "Entwurf").

    Screenshot der Integration eines Git-Repositorys in ein API-Center im Portal.

  5. Wählen Sie "Erstellen" aus.

Das Portal fügt die Umgebung ihrem API Center hinzu. Das Portal fügt die Objekte aus dem Repository dem API Center-Bestand auf der Seite "Bestandsressourcen>" hinzu. Sie können verknüpfte Objekte anhand des Linksymbols in der Liste identifizieren.

Screenshot der verknüpften Objekte im API-Center im Portal.