API's synchroniseren vanuit een API Management-exemplaar

2025-10-15

In dit artikel wordt beschreven hoe u een API Management-exemplaar integreert, zodat de API's van de exemplaren continu up-to-date blijven in uw API Center-inventaris .

Tip

In dit artikel wordt uitgelegd hoe u een API Management-exemplaar kunt integreren vanuit uw API-centrum. U kunt ook snel integratie rechtstreeks vanuit een API Management-exemplaar instellen. Selecteer in het linkermenu van uw exemplaar, onder API's, API Center en selecteer een doel-API-centrum in uw abonnement om API's te synchroniseren.

Het integreren van een API-beheersinstantie

Hoewel u de Azure CLI kunt gebruiken om API's op aanvraag te importeren vanuit Azure API Management naar Azure API Center, maakt het integreren (koppelen) van een API Management-exemplaar continue synchronisatie mogelijk, zodat de API-inventaris up-to-date blijft. Azure API Center kan ook API's synchroniseren vanuit bronnen, waaronder Amazon API Gateway.

Wanneer u een API Management-exemplaar integreert als API-bron, gebeurt het volgende:

Alle API's en eventueel API-definities (specificaties) van het API Management-exemplaar worden toegevoegd aan de inventaris van het API-centrum. MCP-servers in API Management zijn opgenomen in de API's die aan de inventaris zijn toegevoegd.
U configureert een omgeving van het type Azure API Management in het API-centrum.
Er wordt een gekoppelde implementatie gemaakt voor elke gesynchroniseerde API-definitie van API Management.

API Management-API's worden automatisch gesynchroniseerd met het API-centrum wanneer de instellingen van bestaande API's worden gewijzigd (bijvoorbeeld nieuwe versies worden toegevoegd), nieuwe API's worden gemaakt of API's worden verwijderd. Deze synchronisatie is eenrichting van API Management naar uw Azure API-centrum, wat betekent dat API-updates in het API-centrum niet worden gesynchroniseerd naar het API Management-exemplaar.

Note

Er gelden limieten voor het aantal geïntegreerde API Management-exemplaren (API-bronnen).
Een geïntegreerd API Management-exemplaar kan worden geconfigureerd in een virtueel netwerk.
API-updates in API Management worden doorgaans binnen enkele minuten gesynchroniseerd met uw API-centrum, maar synchronisatie kan tot 24 uur duren.
API-definities worden ook gesynchroniseerd met het API-centrum als u de optie selecteert om deze op te nemen tijdens de integratie.

Entiteiten gesynchroniseerd vanuit API Management

U kunt metagegevenseigenschappen en documentatie toevoegen aan of bijwerken naar de gesynchroniseerde API's in uw API-centrum, zodat belanghebbenden de API's kunnen detecteren, begrijpen en gebruiken. Meer informatie over de ingebouwde en aangepaste metagegevenseigenschappen van Azure API Center.

De volgende tabel bevat entiteitseigenschappen die kunnen worden gewijzigd in Azure API Center en eigenschappen die zijn ingesteld op basis van hun waarden in de API-bron.

Entity	Eigenschappen die kunnen worden geconfigureerd in API Center	Eigenschappen die zijn bepaald in de geïntegreerde API-bron
API	summary lifecycleStage termsOfService license externalDocumentation customProperties	title description kind
API-versie	lifecycleStage	title definities (indien gesynchroniseerd)
Environment	title description kind server.managementPortalUri onboarding customProperties	server.type
Deployment	title description server state customProperties	server.runtimeUri

Note

Resource- en systeem-id's voor entiteiten die zijn gesynchroniseerd met Azure API Center worden automatisch gegenereerd en kunnen niet worden gewijzigd.

Prerequisites

Een API-centrum in uw Azure-abonnement. Als u er nog geen hebt gemaakt, raadpleeg Quickstart: Uw API-Centrum maken.
Een Azure API Management-exemplaar in hetzelfde of een ander abonnement. Het exemplaar moet zich in dezelfde bestandsmap bevinden.
Voor Azure CLI:
- Gebruik de Bash-omgeving in Azure Cloud Shell. Zie Aan de slag met Azure Cloud Shell voor meer informatie.
- Als je de voorkeur geeft aan het lokaal uitvoeren van CLI-referentiecommando's, installeer dan de Azure CLI. Als je op Windows of macOS werkt, overweeg dan om Azure CLI in een Docker-container te draaien. Voor meer informatie, zie Hoe u de Azure CLI in een Docker-container kunt uitvoeren.
  - Als u een lokale installatie gebruikt, meldt u zich aan bij Azure CLI met de opdracht az login. Om het authenticatieproces te voltooien, volgt u de stappen die op uw terminal worden weergegeven. Zie Verifiëren bij Azure met behulp van Azure CLI voor andere aanmeldingsopties.
  - Wanneer u daarom wordt gevraagd, installeer de Azure CLI-extensie bij het eerste gebruik. Zie Extensies gebruiken en beheren met de Azure CLIvoor meer informatie over extensies.
  - Voer az version uit om de geïnstalleerde versie en de afhankelijke bibliotheken te vinden. Voer az upgrade uit om naar de nieuwste versie te upgraden.
Note

az apic voor opdrachten is de apic-extension Azure CLI-extensie vereist. Als u geen opdrachten hebt gebruikt az apic , kan de extensie dynamisch worden geïnstalleerd wanneer u uw eerste az apic opdracht uitvoert of kunt u de extensie handmatig installeren. Meer informatie over Azure CLI-extensies.

Zie de releaseopmerkingen voor de meest recente wijzigingen en updates in de apic-extension. Voor bepaalde functies is mogelijk een preview- of specifieke versie van de extensie vereist.

Note

Voorbeelden van Azure CLI-opdrachten in dit artikel kunnen worden uitgevoerd in PowerShell of een bash-shell. Indien nodig vanwege verschillende syntaxis van variabelen, worden er afzonderlijke opdrachtvoorbeelden gegeven voor de twee shells.

Een beheerde identiteit inschakelen in uw API-centrum

Voor dit scenario gebruikt uw API-centrum een beheerde identiteit voor toegang tot Azure-resources. Afhankelijk van uw behoeften schakelt u een door het systeem toegewezen of een of meer door de gebruiker toegewezen beheerde identiteiten in.

In de volgende voorbeelden ziet u hoe u een door het systeem toegewezen beheerde identiteit inschakelt met behulp van Azure Portal of de Azure CLI. Op hoog niveau zijn configuratiestappen vergelijkbaar voor een door de gebruiker toegewezen beheerde identiteit.

Portal
Azure-CLI

Navigeer in de portal naar uw API-centrum.
Selecteer beheerde identiteiten in het linkermenu onder Beveiliging.
Selecteer Systeem toegewezen en stel de status in op Aan.
Selecteer Opslaan.

Stel de door het systeem toegewezen identiteit in uw API-centrum in met behulp van de volgende az apic update-opdracht . Vervang de namen van uw API-centrum en resourcegroep:

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

De rol API Management Service Reader toewijzen aan de beheerde identiteit

Als u het importeren van API's wilt toestaan, wijst u de beheerde identiteit van uw API Center toe aan de rol API Management-servicelezer in uw API Management-exemplaar. U kunt de portal of de Azure CLI gebruiken.

Portal
Azure-CLI

Navigeer in de portal naar uw API Management-exemplaar.
Selecteer toegangsbeheer (IAM) in het linkermenu.
Selecteer + Roltoewijzing toevoegen.
Stel op de Roltoewijzing-pagina als volgt de waarden in:
1. Selecteer op het tabblad Rol de optie API Management Service Reader.
2. Op het tabblad Leden, in Toegang toewijzen aan - Beheerde identiteit> selecteren+ Leden selecteren.
3. Selecteer op de pagina Beheerde identiteiten de door het systeem toegewezen beheerde identiteit van uw API-center dat u in de vorige sectie hebt toegevoegd. Klik op Selecteren.
4. Selecteer Beoordelen en toewijzen.

Haal de hoofd-ID van de identiteit op. Gebruik de opdracht az apic show voor een door het systeem toegewezen identiteit.

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

Haal de resource-id van uw API Management-exemplaar op met behulp van de opdracht 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)

Wijs de beheerde identiteit toe aan de rol API Management Service Reader in uw API Management-exemplaar met behulp van de opdracht 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

Het API Management-exemplaar integreren

U kunt een API Management-exemplaar integreren met behulp van de portal of de Azure CLI.

Portal
Azure-CLI

Navigeer in de portal naar uw API-centrum.
Selecteer Integraties onder Platforms.
Selecteer + Nieuwe integratie>vanuit Azure API Management.
Op de pagina Uw Azure API Management-service integreren :
1. Selecteer of u alle API's wilt synchroniseren vanuit het API Management-exemplaar of alleen API's die zich in een API Management-werkruimte bevinden.
2. Selecteer het abonnement, de resourcegroep en de Azure API Management-service die u wilt integreren. Als u alleen API's uit een werkruimte wilt synchroniseren, maakt u een selectie in Een werkruimte kiezen.
3. Voer in integratiedetails een id in. Als u nog geen beheerde identiteit hebt geconfigureerd met toegang tot het API Management-exemplaar, schakelt u Automatisch beheerde identiteit configureren in en wijst u machtigingen toe. Met deze selectie worden automatisch de door het systeem toegewezen beheerde identiteit van het API Center de benodigde machtigingen toegewezen om API's van het API Management-exemplaar te synchroniseren.
4. Voer in Omgevingsgegevens een omgevingstitel (naam), omgevingstype en optionele beschrijving in.
5. In API-details:
  1. Selecteer een levenscyclus voor de gesynchroniseerde API's. (U kunt deze waarde voor de API's bijwerken nadat deze zijn toegevoegd aan uw API-centrum.)
  2. Selecteer desgewenst of API-definities moeten worden opgenomen met de gesynchroniseerde API's.
Klik op Creëren.

Schermopname van het integreren van een Azure API Management-service in de portal.

Voer de az apic integration create APIM-opdracht uit om een API Management-exemplaar te integreren in uw API Center.

Geef de namen op van de resourcegroep, het API-centrum en de integratie.
Als het API Management-exemplaar en het API-centrum zich in dezelfde resourcegroep bevinden, kunt u de naam van het API Management-exemplaar opgeven als de waarde van azure-apim; anders geeft u de Azure-resource-id op.

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>

Het API Management-exemplaar is geïntegreerd als een omgeving in uw API-centrum. De API Management-API's worden gesynchroniseerd met de inventaris van het API-centrum.

Een integratie verwijderen

Hoewel een API-bron is geïntegreerd, kunt u gesynchroniseerde API's niet verwijderen uit uw API-centrum. Als dat nodig is, kunt u de integratie verwijderen. Wanneer u een integratie verwijdert:

De gesynchroniseerde API's in uw API Center-inventaris worden verwijderd
De omgeving en implementaties die aan de API-bron zijn gekoppeld, worden verwijderd

U kunt een integratie verwijderen met behulp van de portal of de Azure CLI.

Portal
Azure-CLI

Navigeer in de portal naar uw API-centrum.
Selecteer onder Assetsde optie Integraties van omgevingen>(preview).
Selecteer de integratie en selecteer vervolgens verwijderen (prullenbakpictogram).

Voer de opdracht az apic integration delete (preview) uit om een integratie te verwijderen. Geef de namen op van de resourcegroep, het API-centrum en de integratie.

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

Feedback

Is deze pagina nuttig?