Synchronizowanie interfejsów API z wystąpienia usługi API Management (wersja zapoznawcza)

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.

Informacje o integracji wystąpienia usługi 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 wystąpienia usługi API Management jako źródła interfejsu API wykonywane są następujące czynności:

1. Wszystkie interfejsy API i opcjonalnie definicje interfejsu API (specyfikacje) z wystąpienia usługi API Management są dodawane do spisu centrum interfejsów API.
2. Środowisko typu Azure API Management można skonfigurować w centrum interfejsu API.
3. Skojarzone wdrożenie jest tworzone dla każdej zsynchronizowanej definicji interfejsu API z usługi API Management.

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

Uwaga

• Integracja usługi Azure API Management jest obecnie dostępna w wersji zapoznawczej.
• Istnieją limity liczby zintegrowanych wystąpień usługi API Management (źródeł interfejsu API).
• 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 lifecycleStage termsOfService license (licencja) externalDocumentation customProperties	title opis kind
Wersja interfejsu API	lifecycleStage	title definicje (jeśli są zsynchronizowane)
Środowisko	title opis kind server.managementPortalUri onboarding customProperties	server.type
Wdrożenie	title opis serwer stan customProperties	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.

• W przypadku interfejsu wiersza polecenia platformy Azure:

  • Użyj środowiska powłoki Bash w usłudze Azure Cloud Shell. Aby uzyskać więcej informacji, zobacz Szybki start dotyczący powłoki Bash w usłudze 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 Logowanie się przy użyciu interfejsu wiersza polecenia platformy Azure.

    • Po wyświetleniu monitu zainstaluj rozszerzenie interfejsu wiersza polecenia platformy Azure podczas pierwszego użycia. Aby uzyskać więcej informacji na temat rozszerzeń, zobacz Korzystanie z rozszerzeń w interfejsie 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 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.

  Uwaga

  Przykłady poleceń interfejsu wiersza polecenia platformy Azure w tym artykule mogą być uruchamiane w programie PowerShell lub powłoce bash. W razie potrzeby ze względu na różne składnie zmiennych podano oddzielne przykłady poleceń dla dwóch powłok.

Włączanie tożsamości zarządzanej w centrum interfejsu 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 włącz przypisane przez system lub co najmniej jedną tożsamość zarządzaną przypisaną 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 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 pozycję Zapisz.

Interfejs wiersza polecenia platformy Azure

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

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

Przypisywanie tożsamości zarządzanej roli czytelnika usługi API Management

Aby zezwolić na importowanie interfejsów API, przypisz tożsamość zarządzaną 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 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ść> zarządzana+ 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 podmiotu zabezpieczeń tożsamości. 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 wystąpienia usługi API Management przy użyciu 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ść zarządzaną rolę Czytelnik usługi API Management w wystąpieniu usługi 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

Wystąpienie usługi API Management można zintegrować przy użyciu portalu lub interfejsu wiersza polecenia platformy Azure.

Portal

1. W portalu przejdź do centrum interfejsu API.
2. W obszarze Zasoby wybierz pozycję Środowiska.
3. Wybierz pozycję Linki (wersja zapoznawcza)>+ Utwórz link.
4. Na stronie Łączenie usługi Azure API Management:
   1. Wybierz usługę Subskrypcja, Grupa zasobów i Azure API Management, które chcesz zintegrować.
   2. W obszarze Szczegóły łącza wprowadź identyfikator.
   3. W obszarze Szczegóły środowiska wprowadź tytuł środowiska (nazwa), typ środowiska i opcjonalny opis.
   4. W obszarze Szczegóły interfejsu API:
      1. Wybierz cykl życia dla zsynchronizowanych interfejsów API. (Tę wartość można zaktualizować dla interfejsów API po dodaniu ich do centrum interfejsu API).
      2. Opcjonalnie wybierz, czy chcesz uwzględnić definicje interfejsu API z zsynchronizowanymi interfejsami API.
5. Wybierz pozycję Utwórz.

Interfejs wiersza polecenia platformy Azure

Uruchom polecenie az apic integration create apim, aby zintegrować wystąpienie usługi API Management z centrum interfejsu API.

• Podaj nazwy grupy zasobów, centrum interfejsu 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>

Środowisko jest dodawane w centrum interfejsu API. Interfejsy API usługi API Management są importowane do spisu centrum interfejsów API.

Usuwanie integracji

Ź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 spisie centrum interfejsu 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 interfejsu API.
2. W obszarze Zasoby wybierz pozycję Łącza środowisk>(wersja zapoznawcza).
3. Wybierz link, a następnie wybierz pozycję 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 interfejsu 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 spisem interfejsu API za pomocą poleceń interfejsu wiersza polecenia platformy Azure
• Importowanie interfejsów API z usługi API Management do centrum interfejsu API platformy Azure
• Dokumentacja usługi Azure API Management