API-k szinkronizálása API Management-példányból

Ez a cikk bemutatja, hogyan integrálhat (csatolhat) egy API Management-példányt, hogy a példány API-jait folyamatosan naprakészen tarthassa az API-központ készletében.

Tip

Ez a cikk bemutatja, hogyan integrálhat egy API Management-példányt az API-központból. Másik lehetőségként gyorsan beállíthatja az integrációt közvetlenül egy API Management-példányból. A példány bal oldali menüjében, az API-k alatt válassza az API Center lehetőséget, és válasszon ki egy cél API-központot az előfizetésben az API-k szinkronizálásához.

Note

Az API Center Standard mostantól további költségek nélkül használható, ha a Standard, Standard v2, Premium vagy Premium v2 szinten lévő API Management-példányhoz csatolja. További információkért tekintse meg az API Center csomagjait és funkcióit.

Az API Management-példány integrálása

Bár az Azure CLI használatával igény szerint importálhat API-kat az Azure API Managementből az Azure API Centerbe, az API Management-példányok integrálása (csatolása) lehetővé teszi a folyamatos szinkronizálást, hogy az API-leltár naprakész maradjon. Az Azure API Center képes szinkronizálni az API-kat olyan forrásokból is, mint az Amazon API Gateway.

Amikor api-forrásként integrál egy API Management-példányt, a következő történik:

1. Az API Management-példány összes API-ja és opcionálisan API-definíciói (specifikációi) hozzá lesznek adva az API-központ készletéhez. Az MCP-kiszolgálók és az API Management A2A-ügynök API-i a készlethez hozzáadott API-k részét képezik.
2. Azure API Management típusú környezetet konfigurálhat az API-központban.
3. Az API Management minden szinkronizált API-definícióhoz létrehoz egy társított üzembe helyezést .

Az API Management API-k automatikusan szinkronizálódnak az API-központtal, amikor a meglévő API-k beállításai módosulnak (például új verziókat adnak hozzá), új API-k jönnek létre, vagy az API-k törlődnek. Ez a szinkronizálás egyirányú az API Managementtől az Azure API-központig, ami azt jelenti, hogy az API-központban lévő API-frissítések nem szinkronizálódnak vissza az API Management-példányra.

Note

• Az integrált API Management-példányok (API-források) száma korlátozott .
• Konfigurálhat egy integrált API Management-példányt egy virtuális hálózaton.
• Az API Management API-frissítései általában percek alatt szinkronizálódnak az API-központtal, de a szinkronizálás akár 24 órát is igénybe vehet.
• Az API-definíciók akkor is szinkronizálódnak az API-központtal, ha kiválasztja azt a lehetőséget, hogy belefoglalja őket az integráció során.

Az API Managementből szinkronizált entitások

Az API-központban metaadat-tulajdonságokat és dokumentációt adhat hozzá vagy frissíthet a szinkronizált API-khoz, hogy segítsen az érdekelt feleknek az API-k felderítésében, megértésében és felhasználásában. További információ az Azure API Center beépített és egyéni metaadat-tulajdonságairól.

Az alábbi táblázat az Azure API Centerben módosítható entitástulajdonságokat és az API-forrásban lévő értékek alapján beállított tulajdonságokat mutatja be.

Entity	Az API Centerben konfigurálható tulajdonságok	Az integrált API-forrásban meghatározott tulajdonságok
API	összegzés lifecycleStage termsOfService licenc externalDocumentation customProperties	title description kind
API-verzió	lifecycleStage	title definíciók (ha szinkronizálva van)
Environment	title description kind szerver.managementPortalUri bevezetés customProperties	server.type
Deployment	title description kiszolgáló state customProperties	server.runtimeUri

Note

Az Azure API Centerbe szinkronizált entitások erőforrás- és rendszerazonosítói automatikusan létrejönnek, és nem módosíthatók.

Prerequisites

• Egy API-központ az Azure-előfizetésben. Ha nem hoz létre API-központot, olvassa el a rövid útmutatót: Az API-központ létrehozása.

• Egy Azure API Management-példány ugyanabban vagy egy másik előfizetésben. A példánynak ugyanabban a könyvtárban kell lennie.

• Azure CLI esetén:

  • Használja a Bash-környezetet az Azure Cloud Shellben. További információ: Az Azure Cloud Shell használatának első lépései.

    

  • Ha a CLI referencia parancsokat helyben szeretnéd futtatni, telepítsd az Azure CLI-t. Ha Windows vagy macOS rendszeren fut, fontolja meg az Azure CLI-t egy Docker-konténerben futtatni. További információkért lásd: Az Azure CLI használata Docker-konténerben.

    • Ha egy helyileg telepített verziót használ, jelentkezzen be az Azure CLI-be az az login parancs futtatásával. Az azonosítási folyamat befejezéséhez kövesse a terminálján megjelenő lépéseket. További bejelentkezési lehetőségekért lásd: Hitelesítés az Azure-ba az Azure CLI használatával.

    • Amikor megjelenik a felszólítás, az első használatkor telepítse az Azure CLI bővítményt. További információ a bővítményekről: Bővítmények használata és kezelése az Azure CLI-vel.

    • Futtasd a az version parancsot, hogy megtudd a telepített verziót és függő könyvtárakat. A legújabb verzióra való frissítéshez futtassa a az upgrade parancsot.

  Note

  A az apic parancsokhoz az apic-extension Azure CLI-bővítmény szükséges. A bővítmény dinamikusan telepíthető az első az apic parancs futtatásakor, vagy manuálisan is telepítheti a bővítményt. További információ: Azure CLI-bővítmények kezelése: Telepítés, Frissítés és Eltávolítás.

  A legújabb módosításokat és frissítéseket a apic-extensionkibocsátási megjegyzésekben találja. Bizonyos funkciókhoz szükség lehet a bővítmény előzetes verziójára vagy adott verziójára.

  Note

  Ebben a cikkben az Azure CLI parancspéldákat a PowerShellben vagy bash parancssorban futtathatja. Ha eltérő változószintaxisra van szükség, a cikk külön parancs példákat tartalmaz a két rendszerhéjra.

Felügyelt identitás engedélyezése az API-központban

Ebben a forgatókönyvben az API-központ felügyelt identitással fér hozzá az Azure-erőforrásokhoz. Az igényeitől függően engedélyezze a rendszer által hozzárendelt vagy egy vagy több felhasználó által hozzárendelt felügyelt identitást.

Az alábbi példák bemutatják, hogyan engedélyezheti a rendszer által hozzárendelt felügyelt identitásokat az Azure Portal vagy az Azure CLI használatával. Magas szinten a konfigurációs lépések hasonlóak a felhasználó által hozzárendelt felügyelt identitásokhoz.

Portal

1. A portálon nyissa meg az API-központot.
2. Az oldalsáv menü Biztonság területén válassza a Felügyelt identitások lehetőséget.
3. Válassza ki a hozzárendelt rendszert, és állítsa be az állapotot Be értékre.
4. Válassza az Mentésgombot.

Azure CLI

Állítsa be a rendszer által hozzárendelt identitást az API-központban az alábbi az apic update paranccsal. Cserélje le az API-központ és az erőforráscsoport nevét:

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

A felügyelt identitás hozzárendelése AZ API Management Service Reader szerepkörhöz

Az API-k importálásának engedélyezéséhez rendelje hozzá az API-központ felügyelt identitását az API Management Service Reader szerepkörhöz az API Management-példányban. Használhatja a portált vagy az Azure CLI-t.

Portal

1. A portálon keresse meg az API Management-példányt.
2. A bal oldali menüben válassza a Hozzáférés-vezérlés (IAM) lehetőséget.
3. Válassza a + Szerepkör-hozzárendelés hozzáadása opciót.
4. A Szerepkör-hozzárendelés hozzáadása lapon állítsa be az értékeket az alábbiak szerint:
   1. A Szerepkör lapon válassza az API Management Service Reader lehetőséget.
   2. A Tagok lapon, a Hozzáférés hozzárendelése ehhez: Felügyelt identitás>+ Tagok kiválasztása.
   3. A Felügyelt identitások kiválasztása lapon válassza ki az előző szakaszban hozzáadott API-központ rendszer által hozzárendelt felügyelt identitását. Kattintson a Kijelölés gombra.
   4. Válassza a Véleményezés + hozzárendelés lehetőséget.

Azure CLI

1. Az identitás fő azonosítóját kérje le. Rendszer által hozzárendelt identitás esetén használja az az apic show parancsot.

   #! /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. Kérje le az API Management-példány erőforrás-azonosítóját az az apim show paranccsal.

   #! /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. Rendelje hozzá a felügyelt identitást AZ API Management Service Reader szerepkörhöz az API Management-példányban az az role assignment create paranccsal.

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

API Management-példány integrálása

Az API Management példányt a portál vagy az Azure CLI használatával integrálhatja.

Portal

1. A portálon nyissa meg az API-központot.
2. A Platformok területen válassza az Integrációk lehetőséget.
3. Válassza az + Új integráció>az Azure API Managementből lehetőséget.
4. Az Azure API Management Service integrálása:
   1. Válassza ki, hogy szinkronizálja-e az API Management-példány összes API-jának szinkronizálását, vagy csak az API Management-munkaterületen található API-kat.
   2. Válassza ki az integrálni kívánt előfizetést, erőforráscsoportot és Azure API Management szolgáltatást . Ha csak az API-kat szeretné szinkronizálni egy munkaterületről, válasszon egy munkaterületet.
   3. Az integráció részletei között adjon meg egy azonosítót. Ha még nem konfigurált felügyelt identitást az API Management-példányhoz való hozzáféréssel, engedélyezze a felügyelt identitás automatikus konfigurálását és az engedélyek hozzárendelését. Ez a választás automatikusan hozzárendeli az API-központ rendszer által kijelölt felügyelt identitást az API Management példányból érkező API-k szinkronizálásához szükséges engedélyekhez.
   4. A Környezet részletei mezőben adja meg a környezet címét (nevét), a környezet típusát és a nem kötelező leírást.
   5. Az API-részletek között:
      1. Válassza ki a szinkronizált API-k életciklusát . (Az API-k értékét az API-központba való hozzáadásuk után frissítheti.)
      2. Ha szeretné, válassza ki, hogy az API-definíciókat a szinkronizált API-kkal kívánja-e felvenni.
5. Válassza a Create gombot.

Azure CLI

Futtassa az az apic integration create apim parancsot egy API Management-példány api-központba való integrálásához.

Note

• Ez a parancs csak az APIC-bővítmény előzetes verziójában érhető el.
• A parancs használata előtt telepítse az új előzetes verziót.

• Adja meg az erőforráscsoport, az API-központ és az integráció nevét.

• Ha az API Management-példány és az API-központ ugyanabban az erőforráscsoportban található, megadhatja az API Management-példány nevét az értékével azure-apim. Ellenkező esetben adja meg az Azure-erőforrás-azonosítót.

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>

Az API Management-példány környezetként van integrálva az API-központban. Az API Management API-k szinkronizálva vannak az API-központ készletével.

Integráció törlése

Miközben egy API-forrás integrálva van, nem törölheti a szinkronizált API-kat az API-központból. Ha szükséges, törölheti az integrációt. Integráció törlésekor:

• Az API-központ készletében lévő szinkronizált API-k törlődnek
• Az API-forráshoz társított környezet és üzemelő példányok törlődnek

Az integrációt a portálon vagy az Azure CLI-vel törölheti.

Portal

1. A portálon keresse meg az API-központot.
2. Az Eszközök területen válassza a Környezetintegrációk>(előzetes verzió) lehetőséget.
3. Jelölje ki az integrációt, majd válassza a Törlés (kuka ikon) lehetőséget.

Azure CLI

Az integráció törléséhez futtassa az az apic integration delete (előzetes verzió) parancsot. Adja meg az erőforráscsoport, az API-központ és az integráció nevét.

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

Kapcsolódó tartalom

• API-leltár kezelése Azure CLI-parancsokkal
• API-k importálása az API Managementből az Azure API-központba
• MCP-kiszolgálók regisztrálása és felderítése az API-központban
• Az Azure API Management dokumentációja