Teilen über

Synchronisieren von APIs aus einer API Management-Instanz

In diesem Artikel wird gezeigt, wie Sie eine API-Verwaltungsinstanz integrieren, damit die APIs der Instanzen kontinuierlich in Ihrem API Center-Bestand auf dem neuesten Stand gehalten werden.

Tip

In diesem Artikel wird erläutert, wie Sie eine API-Verwaltungsinstanz aus Ihrem API Center integrieren. Alternativ können Sie die Integration schnell direkt aus einer API-Verwaltungsinstanz einrichten. Wählen Sie im linken Menü Ihrer Instanz unter APIsAPI Center aus, und wählen Sie in Ihrem Abonnement ein Ziel-API-Center aus, mit dem APIs synchronisiert werden sollen.

Informationen zum Integrieren einer API Management-Instanz

Obwohl Sie die Azure CLI verwenden können, um APIs bei Bedarf von Azure API Management in Azure API Center zu importieren , ermöglicht die Integration (Verknüpfung) einer API-Verwaltungsinstanz eine kontinuierliche Synchronisierung, sodass der API-Bestand auf dem neuesten Stand bleibt. Azure API Center kann auch APIs aus Quellen synchronisieren, einschließlich Amazon API-Gateway.

Wenn Sie eine API Management-Instanz als API-Quelle integrieren, geschieht Folgendes:

  1. Alle APIs und optional API-Definitionen (Spezifikationen) aus der API Management-Instanz werden dem API Center-Bestand hinzugefügt. MCP-Server in der API-Verwaltung sind in den APIs enthalten, die dem Bestand hinzugefügt wurden.
  2. Sie konfigurieren eine Umgebung vom Typ Azure API Management im API Center.
  3. Eine zugeordnete Bereitstellung wird für jede synchronisierte API-Definition aus der API-Verwaltung erstellt.

API Management-APIs werden automatisch mit API Center synchronisiert, wenn sich die Einstellungen vorhandener APIs ändern (z. B. wenn neue Versionen hinzugefügt werden), neue APIs erstellt oder APIs gelöscht werden. Diese Synchronisierung aus API Management mit Azure API Center ist unidirektional. Das bedeutet, dass API-Aktualisierungen in API Center nicht mit der API Management-Instanz synchronisiert werden.

Note

  • Es gibt Grenzwerte für die Anzahl der integrierten API-Verwaltungsinstanzen (API-Quellen).
  • Eine integrierte API-Verwaltungsinstanz kann in einem virtuellen Netzwerk konfiguriert werden.
  • API-Updates in API Management werden in der Regel innerhalb von Minuten mit API Center synchronisiert, die Synchronisierung kann jedoch bis zu 24 Stunden dauern.
  • API-Definitionen werden auch mit dem API Center synchronisiert, wenn Sie die Option auswählen, sie während der Integration einzuschließen.

Aus API Management synchronisierte Entitäten

Sie können Metadaten und Dokumentationen zu den synchronisierten APIs im API Center hinzufügen oder aktualisieren, um Projektbeteiligten dabei zu helfen, die synchronisierten APIs zu finden, zu verstehen und zu nutzen. Hier erfahren Sie mehr über die integrierten und benutzerdefinierten Metadateneigenschaften von Azure API Center.

Die folgende Tabelle zeigt Entitätseigenschaften, die in Azure API Center geändert werden können, und Eigenschaften, die basierend auf ihren Werten in der API-Quelle festgelegt werden.

Entity In API Center konfigurierbare Eigenschaften In der integrierten API-Quelle ermittelte Eigenschaften
API summary
lifecycleStage
termsOfService
license
externalDocumentation
customProperties		 title
description
kind
API-Version lifecycleStage title
Definitionen (sofern synchronisiert)
Environment title
description
kind
server.managementPortalUri
onboarding
customProperties		 server.type
Deployment title
description
server
state
customProperties		 server.runtimeUri

Note

Ressourcen- und System-IDs für Entitäten, die mit Azure API Center synchronisiert werden, werden automatisch generiert und können nicht geändert werden.

Prerequisites

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

  • Eine Instanz von Azure API Management im selben oder in einem anderen Abonnement. Die Instanz muss sich im selben Verzeichnis befinden.

  • Für die Azure CLI:

    Note

    Für az apic-Befehle wird die Azure CLI-Erweiterung apic-extension benötigt. Wenn Sie keine az apic-Befehle verwendet haben, kann die Erweiterung dynamisch installiert werden, wenn Sie den ersten az apic-Befehl ausführen. Sie können die Erweiterung auch manuell installieren. Hier finden Si weitere Informationen zu Azure CLI-Erweiterungen.

    In den Versionshinweisen finden Sie die neuesten Änderungen und Updates in der apic-extension. Für bestimmte Features ist möglicherweise eine Vorschauversion oder eine bestimmte Version der Erweiterung erforderlich.

    Note

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

Aktivieren einer verwalteten Identität in Ihrem API-Center

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. Navigieren Sie im Portal zu Ihrem API-Center.
  2. Wählen Sie im linken Menü unter Sicherheit die Option Verwaltete Identitäten aus.
  3. Wählen Sie Systemseitig zugewiesen aus, und legen Sie den Status auf Ein fest.
  4. Wählen Sie Speichern aus.

Zuweisen der Rolle „Leser des API Management-Diensts“ zur verwalteten Identität

Um den Import von APIs zuzulassen, weisen Sie der verwalteten Identität Ihres API-Centers die Rolle Leser des API Management-Diensts in Ihrer API Management-Instanz zu. Sie können das Portal oder die Azure CLI verwenden.

  1. Navigieren Sie im Portal zu Ihrer API Management-Instanz.
  2. Wählen Sie im linken Menü Zugriffssteuerung (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 Rolle die Option Leser des API Management-Diensts 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. Klicken Sie auf "Auswählen".
    4. Wählen Sie Überprüfen+ Zuweisen aus.

Integrieren einer API Management-Instanz

Sie können eine API Management-Instanz über das Portal oder die Azure CLI integrieren.

  1. Navigieren Sie im Portal zu Ihrem API-Center.
  2. Wählen Sie unter "Plattformen" die Option "Integrationen" aus.
  3. Wählen Sie +Neue Integration>aus Azure API Management aus.
  4. Auf der Seite "Integration Ihres Azure API Management Service " gehen Sie wie hier vor:
    1. Wählen Sie aus, ob alle APIs aus der API-Verwaltungsinstanz oder nur APIs synchronisiert werden sollen, die sich in einem API-Verwaltungsarbeitsbereich befinden.
    2. Wählen Sie den Abonnement-, Ressourcen- und Azure API-Verwaltungsdienst aus, den Sie integrieren möchten. Wenn Sie nur APIs aus einem Arbeitsbereich synchronisieren möchten, treffen Sie eine Auswahl in "Arbeitsbereich auswählen".
    3. Geben Sie in den Integrationsdetails einen Bezeichner ein. Wenn Sie noch keine verwaltete Identität mit Zugriff auf die API-Verwaltungsinstanz konfiguriert haben, aktivieren Sie automatisch verwaltete Identität und Zuweisen von Berechtigungen. Diese Auswahl weist automatisch der vom System zugewiesenen verwalteten Identität des API Centers die erforderlichen Berechtigungen zum Synchronisieren von APIs aus der API-Verwaltungsinstanz zu.
    4. Geben Sie unter Umgebungsdetails eine Umgebungsbezeichnung (Name), einen Umgebungstyp und eine optionale Beschreibung ein.
    5. In API-Details:
      1. Wählen Sie einen Lebenszyklus für die synchronisierten APIs aus. (Sie können diesen Wert für die APIs aktualisieren, nachdem sie zu API Center hinzugefügt wurden.)
      2. Wählen Sie optional aus, ob API-Definitionen in die synchronisierten APIs eingeschlossen werden sollen.
  5. Wählen Sie "Erstellen" aus.

Screenshot der Integration eines Azure API-Verwaltungsdiensts im Portal.

Die API-Verwaltungsinstanz ist als Umgebung in Ihr API Center integriert. Die API-Verwaltungs-APIs werden mit dem API Center-Bestand synchronisiert.

Löschen einer Integration

Während eine API Management-Instanz verknüpft ist, können Sie synchronisierte APIs nicht aus dem API Center löschen. Bei Bedarf können Sie die Integration löschen. Wenn Sie eine Integration löschen:

  • werden die synchronisierten APIs in Ihrem API Center-Bestand gelöscht.
  • werden die Umgebung und Bereitstellungen, die der API-Quelle zugeordnet sind, gelöscht.

Sie können eine Integration über das Portal oder die Azure CLI löschen.

  1. Navigieren Sie im Portal zu Ihrem API-Center.
  2. Wählen Sie unter Assets die Option Umgebungen>Integrationen (Vorschau) aus.
  3. Wählen Sie die Integration und dann "Löschen" (Papierkorbsymbol) aus.

Verwandte Inhalte

  • Last updated on