Udostępnij przez

Synchronizowanie interfejsów API z wystąpienia usługi API Management

W tym artykule zostanie przedstawione, jak zintegrować wystąpienie usługi API Management, aby interfejsy API tego wystąpienia były stale aktualizowane w spisie centrum API.

Tip

W tym artykule wyjaśniono, jak zintegrować instancję Zarządzania API z centrum API. Alternatywnie, szybko skonfiguruj integrację bezpośrednio z usługi API Management. W menu po lewej stronie wystąpienia, w obszarze Interfejsy API, wybierz Centrum interfejsu API, a następnie wybierz docelowe centrum interfejsu API w ramach swojej subskrypcji, aby zsynchronizować interfejsy API.

Informacje na temat integracji instancji API Management

Chociaż interfejs wiersza polecenia platformy Azure umożliwia importowanie interfejsów API na żądanie z usługi Azure API Management do centrum interfejsu API Platformy Azure, integracja (łączenie) wystąpienia usługi API Management umożliwia ciągłą synchronizację, dzięki czemu spis interfejsów API jest aktualny. Centrum interfejsów API platformy Azure może również synchronizować interfejsy API ze źródeł, w tym z usługi Amazon API Gateway.

Po zintegrowaniu instancji API Management jako źródła interfejsu API podejmowane są następujące działania:

  1. Wszystkie interfejsy API i opcjonalnie definicje interfejsów API (specyfikacje) z wystąpienia zarządzania interfejsami API są dodawane do spisu centrum interfejsów API. Serwery MCP w usłudze API Management są uwzględniane w interfejsach API dodanych do spisu.
  2. Konfigurujesz środowisko typu Azure API Management w centrum API.
  3. Skojarzone wdrożenie jest tworzone dla każdej zsynchronizowanej definicji interfejsu API z usługi API Management.

Interfejsy API zarządzania API są automatycznie synchronizowane z centrum API przy każdej zmianie ustawień istniejących interfejsów API (na przykład dodawanie nowych wersji), gdy tworzone są nowe interfejsy API lub interfejsy API są usuwane. Ta synchronizacja jest jednokierunkowa z API Management do centrum API platformy Azure, co oznacza, że aktualizacje API w centrum API nie są synchronizowane z powrotem do wystąpienia API Management.

Note

  • Istnieją limity liczby zintegrowanych wystąpień usługi API Management (źródeł interfejsu API).
  • Zintegrowaną instancję usługi zarządzania API można skonfigurować w sieci wirtualnej.
  • Aktualizacje interfejsu API w usłudze API Management zwykle są synchronizowane z centrum interfejsu API w ciągu kilku minut, ale synchronizacja może potrwać do 24 godzin.
  • Definicje interfejsu API są również synchronizowane z centrum interfejsu API, jeśli wybierzesz opcję dołączenia ich podczas integracji.

Jednostki synchronizowane z usługi API Management

Właściwości metadanych i dokumentację można dodawać lub aktualizować do zsynchronizowanych interfejsów API w centrum interfejsów API, aby ułatwić uczestnikom projektu odnajdywanie, zrozumienie i korzystanie z interfejsów API. Dowiedz się więcej o wbudowanych i niestandardowych właściwościach metadanych centrum interfejsu API platformy Azure.

W poniższej tabeli przedstawiono właściwości jednostki, które można zmodyfikować w Centrum interfejsu API platformy Azure i właściwości ustawione na podstawie ich wartości w źródle interfejsu API.

Entity Właściwości konfigurowalne w Centrum interfejsu API Właściwości określone w zintegrowanym źródle interfejsu API
API podsumowanie
lifecycleStage
termsOfService
licencja
externalDocumentation
customProperties		 title
description
kind
wersja API lifecycleStage title
definicje (jeśli są zsynchronizowane)
Environment title
description
kind
server.managementPortalUri
dołączanie
customProperties		 server.type
Deployment title
description
serwer
stan
customProperties		 server.runtimeUri

Note

Identyfikatory zasobów i systemu dla jednostek synchronizowanych z usługą Azure API Center są generowane automatycznie i nie można ich zmieniać.

Prerequisites

  • Centrum interfejsu API w ramach subskrypcji platformy Azure. Jeśli go nie utworzono, zobacz Szybki start: tworzenie centrum interfejsu API.

  • Wystąpienie usługi Azure API Management w tej samej lub innej subskrypcji. Wystąpienie musi znajdować się w tym samym katalogu.

  • Dla Azure CLI:

    Note

    az apic Polecenia wymagają rozszerzenia interfejsu wiersza polecenia platformy apic-extension Azure. Jeśli nie użyto az apic poleceń, rozszerzenie można zainstalować dynamicznie po uruchomieniu pierwszego az apic polecenia lub zainstalować rozszerzenie ręcznie. Dowiedz się więcej o rozszerzeniach interfejsu wiersza polecenia platformy Azure.

    Zapoznaj się z informacjami o wersji, aby uzyskać najnowsze zmiany i aktualizacje w pliku apic-extension. Niektóre funkcje mogą wymagać wersji zapoznawczej lub określonej wersji rozszerzenia.

    Note

    Przykłady poleceń Azure CLI w tym artykule mogą być uruchamiane w programie PowerShell lub powłoce Bash. Jeśli to konieczne, podano oddzielne przykłady poleceń dla dwóch powłok ze względu na różne składnie zmiennych.

Włącz tożsamość zarządzaną w centrum API

W tym scenariuszu centrum interfejsu API używa tożsamości zarządzanej do uzyskiwania dostępu do zasobów platformy Azure. W zależności od potrzeb, aktywuj zarządzaną tożsamość przypisaną przez system lub jedną lub więcej tożsamości zarządzanych przypisanych przez użytkownika.

W poniższych przykładach pokazano, jak włączyć tożsamość zarządzaną przypisaną przez system przy użyciu witryny Azure Portal lub interfejsu wiersza polecenia platformy Azure. Na wysokim poziomie kroki konfiguracji są podobne dla tożsamości zarządzanej przypisanej przez użytkownika.

  1. W portalu przejdź do centrum interfejsu API.
  2. W menu po lewej stronie w obszarze Zabezpieczenia wybierz pozycję Tożsamości zarządzane.
  3. Wybierz pozycję Przypisany system i ustaw stan na Wł.
  4. Wybierz Zapisz.

Przypisz tożsamości zarządzanej rolę czytelnika usługi zarządzania API

Aby zezwolić na importowanie interfejsów API, przypisz zarządzanej tożsamości centrum interfejsu API rolę Czytelnik usługi API Management w wystąpieniu usługi API Management. Możesz użyć portalu lub interfejsu wiersza polecenia platformy Azure.

  1. W portalu przejdź do wystąpienia usługi API Management.
  2. W menu po lewej stronie wybierz pozycję Kontrola dostępu (Zarządzanie dostępem i tożsamościami)..
  3. Wybierz pozycję + Dodaj przypisanie roli.
  4. Na stronie Dodawanie przypisania roli ustaw następujące wartości:
    1. Na karcie Rola wybierz pozycję Czytelnik usługi API Management.
    2. Na karcie Członkowie w obszarze Przypisz dostęp do — wybierz pozycję Tożsamość>
    3. Na stronie Wybieranie tożsamości zarządzanych wybierz tożsamość zarządzaną przypisaną przez system centrum interfejsu API, która została dodana w poprzedniej sekcji. Kliknij opcję Wybierz.
    4. Wybierz Przejrzyj + przypisz.

Integrowanie wystąpienia usługi API Management

Możesz zintegrować wystąpienie API Management za pomocą portalu lub interfejsu wiersza poleceń Azure.

  1. W portalu przejdź do centrum interfejsu API.
  2. W obszarze Platformy wybierz pozycję Integracje.
  3. Wybierz pozycję + Nowa integracja>z usługi Azure API Management.
  4. Na stronie Integrowanie usługi Azure API Management :
    1. Wybierz, czy zsynchronizować wszystkie interfejsy API z instancji API Management, czy tylko te, które znajdują się w obszarze roboczym API Management.
    2. Wybierz usługę Subskrypcja, Grupa zasobów i Azure API Management , które chcesz zintegrować. Jeśli chcesz synchronizować tylko interfejsy API z obszaru roboczego, wybierz pozycję Wybierz obszar roboczy.
    3. W obszarze Szczegóły integracji wprowadź identyfikator. Jeśli tożsamość zarządzana nie została jeszcze skonfigurowana z dostępem do wystąpienia usługi API Management, włącz opcję Automatycznie skonfiguruj tożsamość zarządzaną i przypisz uprawnienia. Ta opcja automatycznie przypisuje tożsamość zarządzaną przypisaną przez system centrum interfejsów API, co jest niezbędne do synchronizowania interfejsów API z wystąpienia usługi API Management.
    4. W obszarze Szczegóły środowiska wprowadź tytuł środowiska (nazwa), typ środowiska i opcjonalny opis.
    5. W szczegółach API:
      1. Wybierz cykl życia dla zsynchronizowanych interfejsów API. (Tę wartość można zaktualizować dla API po dodaniu ich do centrum API).
      2. Opcjonalnie zdecyduj, czy uwzględnić definicje API wraz z zsynchronizowanymi API.
  5. Wybierz Utwórz.

Zrzut ekranu przedstawiający integrowanie usługi Azure API Management w portalu.

Instancja API Management jest zintegrowana jako środowisko w centrum API. Interfejsy API usługi API Management są synchronizowane z inwentaryzacją centrum API.

Usuń integrację

Źródło interfejsu API jest zintegrowane, ale nie można usunąć zsynchronizowanych interfejsów API z centrum interfejsu API. Jeśli chcesz, możesz usunąć integrację. Po usunięciu integracji:

  • Zsynchronizowane interfejsy API w inwentarzu centrum API są usuwane
  • Środowisko i wdrożenia skojarzone ze źródłem interfejsu API są usuwane

Integrację można usunąć przy użyciu portalu lub interfejsu wiersza polecenia platformy Azure.

  1. W portalu przejdź do centrum interfejsu API.
  2. W obszarze Zasoby wybierz pozycję Integracje środowisk>(wersja zapoznawcza).
  3. Wybierz integrację, a następnie wybierz pozycję Usuń (ikona kosza).

Treści powiązane

  • Last updated on