Synkronisera API:er från en API Management-instans (förhandsversion)
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 .
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:
- Alla API:er och eventuellt API-definitioner (specifikationer) från API Management-instansen läggs till i API Center-inventeringen.
- Du konfigurerar en miljö av typen Azure API Management i API Center.
- 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
- Integreringen av Azure API Management är för närvarande i förhandsversion.
- Det finns gränser för antalet integrerade API Management-instanser (API-källor).
- 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.
| Enhet | Egenskaper som kan konfigureras i API Center | Egenskaper som bestäms i integrerad API-källa |
|---|---|---|
| API | Sammanfattning livscykelStage termsOfService licens externalDocumentation customProperties |
rubrik description typ |
| API-version | livscykelStage | rubrik definitioner (om de synkroniseras) |
| Environment | rubrik description kind server.managementPortalUri registrering customProperties |
server.type |
| Distribution | rubrik description server tillstånd customProperties |
server.runtimeUri |
Kommentar
Resurs- och system-ID:n för entiteter som synkroniseras med Azure API Center genereras automatiskt och kan inte ändras.
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 apickommandon kräver Azure CLI-tilläggetapic-extension. Om du inte har använtaz apickommandon kan tillägget installeras dynamiskt när du kör ditt förstaaz apickommando, 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.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.
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.
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.
- I portalen navigerar du till din API Management-instans.
- Välj Åtkomstkontroll (IAM) i den vänstra menyn.
- Välj + Lägg till rolltilldelning.
- På sidan Lägg till rolltilldelning anger du följande värden:
- På fliken Roll väljer du API Management Service Reader.
- På fliken Medlemmar går du till Tilldela åtkomst till – Välj Hanterad identitet>+ Välj medlemmar.
- 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.
- Välj Granska + tilldela.
Integrera en API Management-instans
Du kan integrera en API Management-instans med hjälp av portalen eller Azure CLI.
- Gå till API-centret i portalen.
- Under Tillgångar väljer du Miljöer.
- Välj Länkar (förhandsversion)>+ Skapa en länk.
- På sidan Länka azure API Management Service :
- Välj den prenumeration, resursgrupp och Azure API Management-tjänst som du vill integrera.
- I Länkinformation anger du en identifierare.
- I Miljöinformation anger du en miljörubrik (namn), miljötyp och valfri beskrivning.
- I API-information:
- 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.)
- Du kan också välja om API-definitioner ska inkluderas med synkroniserade API:er.
- Välj Skapa.
Miljön läggs till i api-centret. API Management-API:erna importeras till API Center-inventeringen.
Ta bort en integrering
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.