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

Den här artikeln visar hur du skapar en länk (förhandsversion) till en API Management-instans så att instansernas API:er kontinuerligt hålls uppdaterade i API Center-inventeringen .

Om att länka 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 länkning av en API Management-instans kontinuerlig synkronisering så att API-inventeringen håller sig uppdaterad.

När du länkar 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.
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.

Kommentar

• Det finns gränser för antalet länkade API Management-instanser (API-källor).
• API-uppdateringar i API Management kan ta några minuter till upp till 24 timmar att synkronisera till api-centret.

Entiteter som synkroniserats från API Management

Du kan lägga till eller uppdatera metadataegenskaper och dokumentation i API-centret för att hjälpa intressenter att identifiera, förstå och använda synkroniserade API:er. 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 bestäms baserat på deras värden i en länkad Azure API Management-instans. Dessutom genereras entiteternas resurs- eller systemidentifierare i Azure API Center automatiskt och kan inte ändras.

Enhet	Egenskaper som kan konfigureras i API Center	Egenskaper som fastställs i API Management
API	Sammanfattning livscykelStage termsOfService licens externalDocumentation customProperties	rubrik description typ
API-version	livscykelStage	rubrik
Environment	rubrik description kind server.managementPortalUri registrering customProperties	server.type
Distribution	rubrik description server tillstånd customProperties	server.runtimeUri

Information om egenskaper finns i REST API-referensen för Azure API Center.

Förutsättningar

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

  • Använd Bash-miljön i Azure Cloud Shell. Mer information finns i Snabbstart för Bash i Azure Cloud Shell.

    

  • Om du föredrar att köra CLI-referenskommandon lokalt installerar du Azure CLI. Om du kör i Windows eller macOS kan du köra Azure CLI i en Docker-container. Mer information finns i Så här kör du Azure CLI i en Docker-container.

    • Om du använder en lokal installation loggar du in på Azure CLI med hjälp av kommandot az login. Slutför autentiseringsprocessen genom att följa stegen som visas i terminalen. Andra inloggningsalternativ finns i Logga in med Azure CLI.

    • När du uppmanas att installera Azure CLI-tillägget vid första användningen. Mer information om tillägg finns i Använda tillägg med Azure CLI.

    • Kör az version om du vill hitta versionen och de beroende bibliotek som är installerade. Om du vill uppgradera till den senaste versionen kör du az upgrade.

  Kommentar

  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 .

  Kommentar

  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.

Lägga till en hanterad identitet i API-centret

I det här scenariot använder API Center en hanterad identitet för att komma åt API:er i din API Management-instans. Beroende på dina behov konfigurerar du antingen en systemtilldelad eller en eller flera användartilldelade hanterade identiteter.

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

Portal

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.

Azure CLI

Ange den systemtilldelade identiteten i API-centret med hjälp av följande az apic update-kommando . Ersätt namnen på api-centret och resursgruppen:

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

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.

Portal

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älj 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älj 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 + tilldela.

Azure CLI

1. Hämta huvud-ID:t för identiteten. För en systemtilldelad identitet använder du kommandot 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. Hämta resurs-ID:t för din API Management-instans med kommandot 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. Tilldela den hanterade identiteten rollen API Management Service Reader i DIN API Management-instans med kommandot 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 
   

Länka en API Management-instans

Du kan länka en API Management-instans med hjälp av portalen.

1. Gå till API-centret i portalen.
2. Under Tillgångar väljer du Miljöer.
3. Välj Länkar (förhandsversion)>+ Ny länk.
4. På sidan Länka azure API Management Service :
   1. Välj den prenumeration, resursgrupp och Azure API Management-tjänst som du vill länka.
   2. I Länkinformation anger du en identifierare.
   3. I Miljöinformation anger du en miljörubrik (namn), miljötyp och valfri miljöbeskrivning.
   4. I API-information väljer du en livscykelfas för de synkroniserade API:erna. (Du kan uppdatera det här värdet för dina API:er när de har lagts till i API-centret.) Välj också om API-definitioner ska synkroniseras.
5. Välj Skapa.

Miljön läggs till i api-centret. API Management-API:erna importeras till API Center-inventeringen.

Ta bort en länk

När en API Management-instans är länkad kan du inte ta bort synkroniserade API:er från DITT API Center. Om du behöver det kan du ta bort länken. När du tar bort en länk:

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

Så här tar du bort en API Management-länk:

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

Relaterat innehåll

• Hantera API-inventering med Azure CLI-kommandon
• Importera API:er från API Management till ditt Azure API Center
• Dokumentation om Azure API Management