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

API-k szinkronizálása az Amazon API Gatewayről az Azure API Centerbe (előzetes verzió)

  • Cikk

Ez a cikk bemutatja, hogyan integrálható egy Amazon API Gateway, hogy az átjáró API-jait folyamatosan naprakészen tarthassa az API-központ készletében.

Az Amazon API Gateway integrálása

Az Amazon API Gateway API-forrásként való integrálása az API-központhoz lehetővé teszi a folyamatos szinkronizálást, hogy az API-készlet naprakész maradjon. Az Azure API Center képes szinkronizálni az API-kat olyan forrásokból is, mint az Azure API Management.

Amikor api-forrásként integrál egy Amazon API Gatewayt, a következők történnek:

  1. Az API-k és opcionálisan az API Gateway API-definíciói (specifikációi) bekerülnek az API-központ készletébe.
  2. Egy Amazon API Gateway típusú környezetet konfigurálhat az API-központban.
  3. Minden szinkronizált API-definícióhoz létrejön egy társított üzembe helyezés .

A szinkronizálás egyirányú az Amazon API Gatewayről az Azure API-központba, ami azt jelenti, hogy az API-központban lévő API-frissítések nem szinkronizálódnak vissza az Amazon API Gatewayre.

Feljegyzés

  • Az Amazon API Gateway integrációja jelenleg előzetes verzióban érhető el.
  • Az integrált API-források száma korlátozott.
  • Az Amazon API Gateway API-i óránként egyszer szinkronizálódnak az API-központtal. A rendszer csak REST API-kat szinkronizál.
  • 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. A rendszer csak az üzembe helyezett API-k definícióit szinkronizálja.

Az Amazon API Gatewayrő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-kulcstartó. Ha létre kell hoznia egyet, olvassa el a gyorsútmutatót: Kulcstartó létrehozása az Azure Portal használatával. A kulcstartó titkos kulcsainak hozzáadásához vagy kezeléséhez legalább a Key Vault titkos kulcskezelői szerepkörére vagy azzal egyenértékű engedélyekre van szükség.

  • Amazon API Gateway.

  • Egy AWS IAM felhasználói identitás, amelyhez a AmazonAPIGatewayAdministrator házirend csatolva van.

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

IAM felhasználói hozzáférési kulcsok létrehozása

Az API-központ Amazon API Gatewayen való hitelesítéséhez hozzáférési kulcsokra van szükség egy AWS IAM-felhasználóhoz.

A szükséges hozzáférési kulcs azonosítójának és titkos kulcsának az AWS felügyeleti konzollal történő létrehozásához tekintse meg a hozzáférési kulcs létrehozását az AWS dokumentációjában.

Mentse a hozzáférési kulcsokat biztonságos helyre. Ezeket az Azure Key Vaultban fogja tárolni a következő lépésekben.

Figyelemfelhívás

A hozzáférési kulcsok hosszú távú hitelesítő adatok, és ugyanolyan biztonságosan kell kezelni őket, mint egy jelszót. További információ a hozzáférési kulcsok biztonságossá tételéről

IAM felhasználói hozzáférési kulcsok tárolása az Azure Key Vaultban

A két IAM felhasználói hozzáférési kulcs manuális feltöltése és biztonságos tárolása az Azure Key Vaultban az alábbi táblázatban javasolt konfigurációval. További információ : Rövid útmutató: Titkos kód beállítása és lekérése az Azure Key Vaultból az Azure Portal használatával.

AWS-titkos kód Feltöltési beállítások Név Titkos kulcs értéke
Hozzáférési kulcs Manuális aws-access-key Az AWS-ből lekért hozzáférési kulcs azonosítója
Titkos hozzáférési kulcs Manuális aws-secret-access-key Titkos hozzáférési kulcs lekérése az AWS-ből

Képernyőkép az Azure Key Vault titkos kulcslistájáról a portálon.

Jegyezze fel az egyes titkos kódok titkos azonosítóját , a hozzá hasonló https://<key-vault-name>.vault.azure.net/secrets/<secret-name>URI-t. Ezeket az azonosítókat a következő lépésekben fogja használni.

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 a Key Vault titkos kulcsainak felhasználói szerepköréhez

Az API-k importálásának engedélyezéséhez rendelje hozzá az API-központ felügyelt identitását a Key Vault Titkos kulcsok felhasználói szerepköréhez az Azure Key Vaultban. Használhatja a portált vagy az Azure CLI-t.

  1. A portálon keresse meg a kulcstartót.
  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 a Key Vault titkos kulcsainak felhasználója 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.

Amazon API Gateway integrálása

Futtassa az az apic integration create aws (előzetes verzió) parancsot az Amazon API Gateway API-központba való integrálásához.

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

  • Adja meg a Key Vault titkos azonosítóit az AWS hozzáférési kulcsához és titkos hozzáférési kulcsához, valamint azt az AWS-régiót, ahol az Amazon API Gateway telepítve van.

az apic integration create aws \
    --resource-group <resource-group-name> \
    --service-name-name <api-center-name> \
    --integration-name <aws-integration-name> \
    --aws-access-key-reference <access-key-uri> \
    --aws-secret-access-key-reference <secret-access-key-uri> 
    --aws-region-name <aws-region>

A környezet hozzáadódik az API-központhoz. Az Amazon API Gateway API-jait a rendszer importálja az API-központ készletébe.

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

Ha az Azure CLI használatával szeretne törölni egy integrációt, 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