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

W tym artykule pokazano, jak zintegrować wystąpienie usługi API Management, aby interfejsy API wystąpień były stale aktualizowane w spisie centrum interfejsów API.

Wskazówka

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 twojego wystąpienia, w sekcji Interfejsy API, wybierz Centrum interfejsów API, a następnie wybierz docelowe centrum interfejsów API w 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 Azure API Center, łą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.
2. Konfigurujesz środowisko typu Azure API Management w centrum interfejsu 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.

Uwaga

• 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.

Encja	Właściwości konfigurowalne w Centrum interfejsu API	Właściwości określone w zintegrowanym źródle interfejsu API
interfejs API	Podsumowanie etap cyklu życia Warunki świadczenia usług licencja dokumentacja zewnętrzna customProperties (właściwości niestandardowe)	tytuł opis rodzaj
Wersja interfejsu API	etap cyklu życia	tytuł definicje (jeśli są zsynchronizowane)
Środowisko	tytuł opis typ server.managementPortalUri wdrożenie customProperties (właściwości niestandardowe)	typ_serwera
Wdrożenie	tytuł opis serwer stan customProperties (właściwości niestandardowe)	server.runtimeUri

Uwaga

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

Wymagania wstępne

• 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:

  • Użyj środowiska powłoki Bash w usłudze Azure Cloud Shell. Aby uzyskać więcej informacji, zobacz Get started with Azure Cloud Shell.

    

  • Jeśli wolisz uruchamiać polecenia referencyjne interfejsu wiersza polecenia lokalnie, zainstaluj interfejs wiersza polecenia platformy Azure. Jeśli korzystasz z systemu Windows lub macOS, rozważ uruchomienie interfejsu wiersza polecenia platformy Azure w kontenerze Docker. Aby uzyskać więcej informacji, zobacz Jak uruchomić interfejs wiersza polecenia platformy Azure w kontenerze platformy Docker.

    • Jeśli korzystasz z instalacji lokalnej, zaloguj się do interfejsu wiersza polecenia platformy Azure za pomocą polecenia az login. Aby ukończyć proces uwierzytelniania, wykonaj kroki wyświetlane w terminalu. Aby uzyskać inne opcje logowania, zobacz Uwierzytelnianie na platformie Azure przy użyciu interfejsu wiersza polecenia platformy Azure.

    • Po wyświetleniu monitu zainstaluj rozszerzenie Azure CLI przy pierwszym użyciu. Aby uzyskać więcej informacji na temat rozszerzeń, zobacz Używanie rozszerzeń i zarządzanie nimi za pomocą interfejsu wiersza polecenia platformy Azure.

    • Uruchom polecenie az version, aby znaleźć zainstalowane wersje i biblioteki zależne. Aby uaktualnić do najnowszej wersji, uruchom polecenie az upgrade.

  Uwaga

  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 uwagami o wydaniu, aby uzyskać najnowsze zmiany i aktualizacje w apic-extension. Niektóre funkcje mogą wymagać wersji zapoznawczej lub określonej wersji rozszerzenia.

  Uwaga

  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.

Portal

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

Interfejs wiersza polecenia platformy Azure

Ustaw tożsamość przypisaną przez system w centrum API przy użyciu następującego polecenia az apic update. Zastąp nazwy centrum interfejsu API i grupy zasobów.

az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'

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.

Portal

1. W portalu przejdź do instancji usługi zarządzania API.
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 zarządzania API.
   2. Na karcie Członkowie, w Przypisz dostęp do - Wybierz Zarządzana tożsamość>+ Wybierz członków.
   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.

Interfejs wiersza polecenia platformy Azure

1. Pobierz identyfikator główny podmiotu. W przypadku tożsamości przypisanej przez system użyj polecenia az apic show.

   #! /bin/bash
   apicObjID=$(az apic show --name <api-center-name> \
       --resource-group <resource-group-name> \
       --query "identity.principalId" --output tsv)
   

   # Formatted for PowerShell
   $apicObjID=$(az apic show --name <api-center-name> `
       --resource-group <resource-group-name> `
       --query "identity.principalId" --output tsv)
   

2. Pobierz identyfikator zasobu swojego wystąpienia API Management, korzystając z polecenia az apim show.

   #! /bin/bash
   apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

   # Formatted for PowerShell
   $apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

3. Przypisz tożsamości zarządzanej rolę Czytelnik usługi API Management w swoim wystąpieniu API Management przy użyciu polecenia az role assignment create.

   #! /bin/bash
   scope="${apimID:1}"
   
   az role assignment create \
       --role "API Management Service Reader Role" \
       --assignee-object-id $apicObjID \
       --assignee-principal-type ServicePrincipal \
       --scope $scope 
   

   # Formatted for PowerShell
   $scope=$apimID.substring(1)
   
   az role assignment create `
       --role "API Management Service Reader Role" `
       --assignee-object-id $apicObjID `
       --assignee-principal-type ServicePrincipal `
       --scope $scope 
   

Integrowanie wystąpienia usługi API Management

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

Portal

1. W portalu przejdź do centrum 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 wszystkie interfejsy API mają być synchronizowane z wystąpienia usługi API Management, czy tylko interfejsy API, które znajdują się w obszarze roboczym usługi 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 Szczegółach środowiska wprowadź tytuł środowiska (nazwa), typ środowiska i opcjonalny opis.
   5. W obszarze Szczegóły interfejsu 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 pozycję Utwórz.

Interfejs wiersza polecenia platformy Azure

Uruchom polecenie az apic integration create apim w celu zintegrowania wystąpienia usługi API Management z centrum API.

• Podaj nazwy grupy zasobów, centrum API i integracji.

• Jeśli wystąpienie usługi API Management i centrum interfejsu API znajdują się w tej samej grupie zasobów, możesz podać nazwę wystąpienia usługi API Management jako wartość azure-apim; w przeciwnym razie podaj identyfikator zasobu platformy Azure.

az apic integration create apim \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <apim-integration-name> \
    --azure-apim <apim-instance-name>

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.

Portal

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

Interfejs wiersza polecenia platformy Azure

Uruchom polecenie az apic integration delete (wersja zapoznawcza), aby usunąć integrację. Podaj nazwy grupy zasobów, centrum API i integracji.

az apic integration delete \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <integration-name> \

Powiązana zawartość

• Zarządzanie inwentarzem API za pomocą poleceń Azure CLI
• Importowanie interfejsów API z usługi API Management do centrum interfejsu API platformy Azure
• Dokumentacja usługi Azure API Management