Megosztás a következőn keresztül:

API-k szinkronizálása API Management-példányból (előzetes verzió)

  • Cikk

Ez a cikk bemutatja, hogyan integrálhat egy API Management-példányt, hogy a példányok API-jai folyamatosan naprakészek legyenek az API-központ készletében.

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.
  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.

Feljegyzés

  • Az Azure API Management integrációja jelenleg előzetes verzióban érhető el.
  • Az integrált API Management-példányok (API-források) száma korlátozott.
  • 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.

Entitás 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		 cím
leírás
kind
API-verzió lifecycleStage cím
definíciók (ha szinkronizálva van)
Környezet cím
leírás
kind
server.managementPortalUri
regisztráció
customProperties		 server.type
Telepítés cím
leírás
kiszolgáló
állapot
customProperties		 server.runtimeUri

Feljegyzés

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.

Előfeltételek

  • Egy API-központ az Azure-előfizetésben. Ha még nem hozott létre egyet, olvassa el az API-központ létrehozása című rövid útmutatót.

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

    Feljegyzés

    az apic parancsokhoz az apic-extension Azure CLI-bővítmény szükséges. Ha még nem használt az apic parancsokat, 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ó az Azure CLI-bővítményekről.

    A legújabb módosításokról és frissítésekről a kibocsátási megjegyzésekben olvashat.apic-extension Bizonyos funkciókhoz szükség lehet a bővítmény előzetes verziójára vagy adott verziójára.

    Feljegyzés

    A cikkben szereplő Azure CLI-parancsok PowerShellben vagy bash-rendszerhéjban futtathatók. A különböző változószintaxis miatt szükség esetén a két rendszerhéjhoz külön parancs példákat biztosítunk.

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.

  1. A portálon keresse meg az API-központot.
  2. A bal oldali 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 a Mentés lehetőséget.

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.

  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 lehetőséget.
  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 – Felügyelt identitás> kiválasztása+ Tagok kijelölése területen.
    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 az Áttekintés + hozzárendelés lehetőséget.

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

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

  1. A portálon keresse meg az API-központot.
  2. Az Eszközök területen válassza a Környezetek lehetőséget.
  3. Válassza a Hivatkozások (előzetes verzió)>+ Hivatkozás létrehozása lehetőséget.
  4. Az Azure API Management Szolgáltatás összekapcsolása lapon:
    1. Válassza ki az integrálni kívánt előfizetést, erőforráscsoportot és Azure API Management szolgáltatást .
    2. A Hivatkozás részletei között adjon meg egy azonosítót.
    3. 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.
    4. 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 Létrehozás lehetőséget.

Képernyőkép az Azure API Management Service portálon való integrálásáról.

A környezet hozzáadódik az API-központhoz. Az API Management API-k importálása az API-központ készletébe lesz importálva.

Képernyőkép a portál környezeti listájáról.

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.

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

Kapcsolódó tartalom