Synchronizace rozhraní API z instance služby API Management (Preview)

Tento článek ukazuje, jak integrovat instanci služby API Management tak, aby rozhraní API instancí byla průběžně aktuální v inventáři centra API.

Integrace instance služby API Management

I když můžete pomocí Azure CLI importovat rozhraní API na vyžádání ze služby Azure API Management do služby Azure API Center, integrace (propojení) instance služby API Management umožňuje průběžnou synchronizaci, aby inventář rozhraní API zůstal aktuální. Azure API Center může také synchronizovat rozhraní API ze zdrojů, včetně služby Amazon API Gateway.

Když instanci služby API Management integrujete jako zdroj rozhraní API, stane se toto:

1. Všechna rozhraní API a volitelně definice rozhraní API (specifikace) z instance služby API Management se přidají do inventáře centra api.
2. V Centru rozhraní API nakonfigurujete prostředí typu Azure API Management .
3. Pro každou synchronizovanou definici rozhraní API ze služby API Management se vytvoří přidružené nasazení .

Rozhraní API služby API Management se automaticky synchronizují do centra rozhraní API při každé změně nastavení existujících rozhraní API (například přidají se nové verze), vytvoří se nová rozhraní API nebo se odstraní rozhraní API. Tato synchronizace je jednosměrná ze služby API Management do centra rozhraní Azure API, což znamená, že aktualizace rozhraní API v centru api se nesynchronují zpět do instance služby API Management.

Poznámka:

• Integrace služby Azure API Management je aktuálně ve verzi Preview.
• Počet integrovaných instancí služby API Management (zdrojů rozhraní API) je omezen .
• Aktualizace rozhraní API ve službě API Management se obvykle synchronizují do centra rozhraní API během několika minut, ale synchronizace může trvat až 24 hodin.
• Definice rozhraní API se také synchronizují do centra rozhraní API, pokud vyberete možnost jejich zahrnutí během integrace.

Entity synchronizované ze služby API Management

Do synchronizovaných rozhraní API v centru rozhraní API můžete přidat nebo aktualizovat vlastnosti metadat a dokumentaci, které zúčastněným stranám pomůžou zjišťovat, pochopit a využívat rozhraní API. Přečtěte si další informace o předdefinovaných a vlastních vlastnostech metadat služby Azure API Center.

Následující tabulka ukazuje vlastnosti entity, které je možné upravit ve službě Azure API Center a vlastnosti nastavené na základě jejich hodnot ve zdroji rozhraní API.

Entity	Vlastnosti konfigurovatelné ve službě API Center	Vlastnosti určené v integrovaném zdroji rozhraní API
rozhraní API	Souhrn lifecycleStage termsOfService license externalDocumentation customProperties	title description kind
Verze rozhraní API	lifecycleStage	title definice (pokud jsou synchronizované)
Prostředí	title description kind server.managementPortalUri onboarding customProperties	server.type
Nasazení	title description server state customProperties	server.runtimeUri

Poznámka:

Id prostředků a systému pro entity synchronizované s Azure API Center se generují automaticky a není možné je změnit.

Požadavky

• Centrum rozhraní API ve vašem předplatném Azure. Pokud jste ho ještě nevytvořili, přečtěte si článek Rychlý start: Vytvoření centra rozhraní API.

• Instance služby Azure API Management ve stejném nebo jiném předplatném. Instance musí být ve stejném adresáři.

• Pro Azure CLI:

  • Použijte prostředí Bash v Azure Cloud Shellu. Další informace najdete v tématu Rychlý start pro Bash v Azure Cloud Shellu.

    

  • Pokud dáváte přednost místnímu spouštění referenčních příkazů rozhraní příkazového řádku, nainstalujte Azure CLI. Pokud používáte Windows nebo macOS, zvažte spuštění Azure CLI v kontejneru Docker. Další informace najdete v tématu Jak spustit Azure CLI v kontejneru Dockeru.

    • Pokud používáte místní instalaci, přihlaste se k Azure CLI pomocí příkazu az login. Pokud chcete dokončit proces ověřování, postupujte podle kroků zobrazených na terminálu. Další možnosti přihlášení najdete v tématu Přihlášení pomocí Azure CLI.

    • Po zobrazení výzvy nainstalujte rozšíření Azure CLI při prvním použití. Další informace o rozšířeních najdete v tématu Využití rozšíření v Azure CLI.

    • Spuštěním příkazu az version zjistěte verzi a závislé knihovny, které jsou nainstalované. Pokud chcete upgradovat na nejnovější verzi, spusťte az upgrade.

  Poznámka:

  az apic příkazy vyžadují apic-extension rozšíření Azure CLI. Pokud jste nepoužili az apic příkazy, můžete rozšíření nainstalovat dynamicky při spuštění prvního az apic příkazu nebo rozšíření nainstalovat ručně. Přečtěte si další informace o rozšířeních Azure CLI.

  Podívejte se na poznámky k verzi nejnovějších změn a aktualizací v nástroji apic-extension. Některé funkce můžou vyžadovat verzi Preview nebo konkrétní verzi rozšíření.

  Poznámka:

  Příklady příkazů Azure CLI v tomto článku se dají spustit v PowerShellu nebo prostředí Bash. Pokud je to potřeba kvůli jiné syntaxi proměnných, jsou pro tyto dvě prostředí k dispozici samostatné příklady příkazů.

Povolení spravované identity v centru rozhraní API

V tomto scénáři centrum rozhraní API používá spravovanou identitu pro přístup k prostředkům Azure. V závislosti na vašich potřebách povolte spravované identity přiřazené systémem nebo jednu nebo více spravovaných identit přiřazených uživatelem.

Následující příklady ukazují, jak povolit spravovanou identitu přiřazenou systémem pomocí webu Azure Portal nebo Azure CLI. Na vysoké úrovni jsou kroky konfigurace podobné spravované identitě přiřazené uživatelem.

Azure Portal

1. Na portálu přejděte do centra rozhraní API.
2. V nabídce vlevo v části Zabezpečení vyberte Spravované identity.
3. Vyberte Přiřazený systém a nastavte stav na Zapnuto.
4. Zvolte Uložit.

Azure CLI

Pomocí následujícího příkazu az apic update nastavte identitu přiřazenou systémem v centru rozhraní API. Nahraďte názvy centra rozhraní API a skupiny prostředků:

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

Přiřazení spravované identity roli čtenáře služby API Management

Pokud chcete povolit import rozhraní API, přiřaďte spravované identitě centra ROZHRANÍ API roli Čtenář služby API Management ve vaší instanci služby API Management. Můžete použít portál nebo Azure CLI.

Azure Portal

1. Na portálu přejděte do vaší instance služby API Management.
2. V nabídce vlevo vyberte Řízení přístupu (IAM).
3. Vyberte + Přidat přiřazení role.
4. Na stránce Přidat přiřazení role nastavte hodnoty následujícím způsobem:
   1. Na kartě Role vyberte čtenář služby API Management.
   2. Na kartě Členové v části Přiřadit přístup – Vyberte spravované identity> a vyberte členy.
   3. Na stránce Vybrat spravované identity vyberte spravovanou identitu přiřazenou systémem centra rozhraní API, kterou jste přidali v předchozí části. Klepněte na tlačítko Vybrat.
   4. Vyberte Zkontrolovat + přiřadit.

Azure CLI

1. Získejte ID objektu zabezpečení identity. Pro identitu přiřazenou systémem použijte příkaz 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. Pomocí příkazu az apim show získejte ID prostředku vaší instance služby API Management.

   #! /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. Pomocí příkazu az role assignment create přiřaďte spravovanou identitu roli čtenáře služby API Management ve vaší instanci služby API Management.

   #! /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 
   

Integrace instance služby API Management

Instanci služby API Management můžete integrovat pomocí portálu nebo Azure CLI.

Azure Portal

1. Na portálu přejděte do centra rozhraní API.
2. V části Prostředky vyberte Prostředí.
3. Vyberte Odkazy (Preview)>+ Vytvořit odkaz.
4. Na stránce Propojit službu Azure API Management:
   1. Vyberte předplatné, skupinu prostředků a službu Azure API Management, kterou chcete integrovat.
   2. Do podrobností odkazu zadejte identifikátor.
   3. V části Podrobnosti o prostředí zadejte název prostředí (název ), typ prostředí a volitelný popis.
   4. V podrobnostech rozhraní API:
      1. Vyberte životní cyklus synchronizovaných rozhraní API. (Tuto hodnotu pro rozhraní API můžete aktualizovat po jejich přidání do centra rozhraní API.)
      2. Volitelně můžete vybrat, jestli se mají zahrnout definice rozhraní API se synchronizovanými rozhraními API.
5. Vyberte Vytvořit.

Azure CLI

Spuštěním příkazu az apic integration create apim integrujte instanci služby API Management do centra rozhraní API.

• Zadejte názvy skupiny prostředků, centra rozhraní API a integrace.

• Pokud je instance služby API Management a centrum rozhraní API ve stejné skupině prostředků, můžete jako hodnotu azure-apimzadat název instance služby API Management. V opačném případě zadejte ID prostředku 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>

Prostředí se přidá do centra rozhraní API. Rozhraní API služby API Management se naimportují do inventáře centra api.

Odstranění integrace

I když je zdroj rozhraní API integrovaný, nemůžete odstranit synchronizovaná rozhraní API z centra rozhraní API. Pokud potřebujete, můžete integraci odstranit. Když odstraníte integraci:

• Synchronizovaná rozhraní API v inventáři centra API se odstraní.
• Odstraní se prostředí a nasazení přidružená ke zdroji rozhraní API.

Integraci můžete odstranit pomocí portálu nebo Azure CLI.

Azure Portal

1. Na portálu přejděte do centra rozhraní API.
2. V části Prostředky vyberte Odkazy prostředí>(Preview).
3. Vyberte odkaz a pak vyberte Odstranit (ikona koše).

Azure CLI

Spuštěním příkazu az apic integration delete (Preview) odstraňte integraci. Zadejte názvy skupiny prostředků, centra rozhraní API a integrace.

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

Související obsah

• Správa inventáře rozhraní API pomocí příkazů Azure CLI
• Import rozhraní API ze služby API Management do centra azure API
• Dokumentace ke službě Azure API Management