Dela via

Synkronisera API:er från en API Management-instans

Den här artikeln visar hur du integrerar en API Management-instans så att instansernas API:er kontinuerligt hålls uppdaterade i API Center-inventeringen .

Tip

Den här artikeln beskriver hur du integrerar en API Management-instans från ditt API Center. Du kan också snabbt konfigurera integrering direkt från en API Management-instans. I den vänstra menyn i din instans går du till API:er och väljer API Center och ett mål-API-center i din prenumeration för att synkronisera API:er till.

Om att integrera en API Management-instans

Även om du kan använda Azure CLI för att importera API:er på begäran från Azure API Management till Azure API Center, möjliggör integrering (länkning) en API Management-instans kontinuerlig synkronisering så att API-inventeringen hålls uppdaterad. Azure API Center kan också synkronisera API:er från källor, inklusive Amazon API Gateway.

När du integrerar en API Management-instans som en API-källa händer följande:

  1. Alla API:er och eventuellt API-definitioner (specifikationer) från API Management-instansen läggs till i API Center-inventeringen. MCP-servrar i API Management ingår i DE API:er som läggs till i inventeringen.
  2. Du konfigurerar en miljö av typen Azure API Management i API Center.
  3. En associerad distribution skapas för varje synkroniserad API-definition från API Management.

API Management-API:er synkroniseras automatiskt till API Center när befintliga API:ers inställningar ändras (till exempel nya versioner läggs till), nya API:er skapas eller API:er tas bort. Den här synkroniseringen är enkelriktad från API Management till Ditt Azure API Center, vilket innebär att API-uppdateringar i API Center inte synkroniseras tillbaka till API Management-instansen.

Note

  • Det finns gränser för antalet integrerade API Management-instanser (API-källor).
  • En integrerad API Management-instans kan konfigureras i ett virtuellt nätverk.
  • API-uppdateringar i API Management synkroniseras vanligtvis till api-centret inom några minuter, men synkroniseringen kan ta upp till 24 timmar.
  • API-definitioner synkroniseras också till API-centret om du väljer alternativet att inkludera dem under integreringen.

Entiteter som synkroniserats från API Management

Du kan lägga till eller uppdatera metadataegenskaper och dokumentation till de synkroniserade API:erna i API-centret för att hjälpa intressenter att identifiera, förstå och använda API:erna. Läs mer om inbyggda och anpassade metadataegenskaper i Azure API Center.

I följande tabell visas entitetsegenskaper som kan ändras i Azure API Center och egenskaper som anges baserat på deras värden i API-källan.

Entity Egenskaper som kan konfigureras i API Center Egenskaper som bestäms i integrerad API-källa
API summary
lifecycleStage
termsOfService
license
externalDocumentation
customProperties		 title
description
kind
API-version lifecycleStage title
definitioner (om de synkroniseras)
Environment title
description
typ
server.managementPortalUri
onboarding
customProperties		 server.type
Deployment title
description
server
state
customProperties		 server.runtimeUri

Note

Resurs- och system-ID:n för entiteter som synkroniseras med Azure API Center genereras automatiskt och kan inte ändras.

Prerequisites

  • Ett API-center i din Azure-prenumeration. Om du inte har skapat något läser du Snabbstart: Skapa ditt API-center.

  • En Azure API Management-instans, i samma eller en annan prenumeration. Instansen måste finnas i samma katalog.

  • För Azure CLI:

    Note

    az apic kommandon kräver Azure CLI-tillägget apic-extension . Om du inte har använt az apic kommandon kan tillägget installeras dynamiskt när du kör ditt första az apic kommando, eller så kan du installera tillägget manuellt. Läs mer om Azure CLI-tillägg.

    Se viktig information för de senaste ändringarna och uppdateringarna apic-extensioni . Vissa funktioner kan kräva en förhandsversion eller en specifik version av tillägget.

    Note

    Azure CLI-kommandoexempel i den här artikeln kan köras i PowerShell eller ett bash-gränssnitt. Vid behov på grund av olika variabelsyntax tillhandahålls separata kommandoexempel för de två gränssnitten.

Aktivera en hanterad identitet i api-centret

I det här scenariot använder API Center en hanterad identitet för att komma åt Azure-resurser. Beroende på dina behov aktiverar du antingen en systemtilldelad eller en eller flera användartilldelade hanterade identiteter.

I följande exempel visas hur du aktiverar en systemtilldelad hanterad identitet med hjälp av Azure Portal eller Azure CLI. På hög nivå liknar konfigurationsstegen en användartilldelad hanterad identitet.

  1. Gå till API-centret i portalen.
  2. I den vänstra menyn under Säkerhet väljer du Hanterade identiteter.
  3. Välj Systemtilldelat och ange status till På.
  4. Välj Spara.

Tilldela den hanterade identiteten rollen API Management Service Reader

Om du vill tillåta import av API:er tilldelar du api-centrets hanterade identitet rollen API Management Service Reader i DIN API Management-instans. Du kan använda portalen eller Azure CLI.

  1. I portalen navigerar du till din API Management-instans.
  2. Välj Åtkomstkontroll (IAM) i den vänstra menyn.
  3. Välj + Lägg till rolltilldelning.
  4. På sidan Lägg till rolltilldelning anger du följande värden:
    1. På fliken Roll väljer du API Management Service Reader.
    2. På fliken Medlemmar går du till Tilldela åtkomst till – Välj Hanterad identitet>+ Välj medlemmar.
    3. På sidan Välj hanterade identiteter väljer du den systemtilldelade hanterade identiteten för ditt API Center som du lade till i föregående avsnitt. Klicka på Välj.
    4. Välj Granska och tilldela.

Integrera en API Management-instans

Du kan integrera en API Management-instans med hjälp av portalen eller Azure CLI.

  1. Gå till API-centret i portalen.
  2. Under Plattformar väljer du Integreringar.
  3. Välj + Ny integrering>Från Azure API Management.
  4. På sidan Integrera Azure API Management Service:
    1. Välj om du vill synkronisera alla API:er från API Management-instansen eller endast API:er som finns på en API Management-arbetsyta.
    2. Välj den prenumeration, resursgrupp och Azure API Management-tjänst som du vill integrera. Om du bara vill synkronisera API:er från en arbetsyta gör du ett val i Välj en arbetsyta.
    3. I Integreringsinformation ange en identifier. Om du inte redan har konfigurerat en hanterad identitet med åtkomst till API Management-instansen aktiverar du Konfigurera hanterad identitet automatiskt och tilldela behörigheter. Det här valet tilldelar automatiskt API-centrets systemtilldelade hanterade identitet de behörigheter som krävs för att synkronisera API:er från API Management-instansen.
    4. I Miljöinformation anger du en miljörubrik (namn), miljötyp och valfri beskrivning.
    5. Inom API-information:
      1. Välj en livscykel för synkroniserade API:er. (Du kan uppdatera det här värdet för API:erna när de har lagts till i API-centret.)
      2. Du kan också välja om API-definitioner ska inkluderas med synkroniserade API:er.
  5. Välj Skapa.

Skärmbild av integrering av en Azure API Management-tjänst i portalen.

API Management-instansen är integrerad som en miljö i ditt API Center. API Management-API:erna synkroniseras med API Center-inventeringen.

Ta bort en integration

När en API-källa är integrerad kan du inte ta bort synkroniserade API:er från API-centret. Om du behöver kan du ta bort integreringen. När du tar bort en integrering:

  • De synkroniserade API:erna i API Center-inventeringen tas bort
  • Miljön och distributionerna som är associerade med API-källan tas bort

Du kan ta bort en integrering med hjälp av portalen eller Azure CLI.

  1. Gå till API-centret i portalen.
  2. Under Tillgångar väljer du Miljöintegreringar>(förhandsversion).
  3. Välj integreringen och välj sedan Ta bort (papperskorgsikon).

Relaterat innehåll