Munkaterület létrehozása és kezelése az Azure API Managementben

A KÖVETKEZŐKRE VONATKOZIK: Prémium | Prémium v2

Állítson be egy munkaterületet, amely lehetővé teszi egy API-csapat számára a saját API-k kezelését és termékbevezetését, miközben biztosítja az API-platform csapatának az API Management platform megfigyeléséhez, szabályozásához és karbantartásához szükséges eszközöket. Miután létrehozott egy munkaterületet, és engedélyeket rendelt hozzá, a munkaterület-közreműködők létrehozhatják és kezelhetik saját API-kat, termékeket, előfizetéseket és kapcsolódó erőforrásokat.

Note

• Az API Management REST API 2023-09-01-preview vagy újabb verziója támogatja a legújabb munkaterületi funkciókat.
• A díjszabással kapcsolatos szempontokért tekintse meg az API Management díjszabását.

Kövesse a cikkben leírt lépéseket a következőkhöz:

• API Management-munkaterület létrehozása és munkaterület-átjáró társítása az Azure Portal használatával
• Opcionálisan elkülönítheti a munkaterületi átjárót egy Azure-beli virtuális hálózaton
• Engedélyek hozzárendelése a munkaterülethez

Note

• A munkaterület-átjáró létrehozása jelenleg egy hosszú ideig futó művelet, amely akár 3 órát vagy több időt is igénybe vehet.
• Több munkaterület munkaterület-átjáróval való társítása csak a 2025. április 15. után létrehozott munkaterület-átjárók esetében érhető el. További információ a megosztott munkaterületi átjárókról.

Prerequisites

• EGY API Management-példány. Ha szükséges, hozzon létre egyet egy támogatott szinten.
• Tulajdonosi vagy közreműködői szerepkör abban az erőforráscsoportban, amelyben az API Management-példány telepítve van, vagy ezzel egyenértékű engedélyek az erőforrások erőforráscsoportban való létrehozásához.
• (Nem kötelező) Egy új vagy meglévő Azure-beli virtuális hálózat alhálózata, amely elkülöníti a munkaterület-átjáró bejövő és kimenő forgalmát. A konfigurációs beállításokról és követelményekről lásd a munkaterület-átjárók hálózati erőforrás-követelményeit.

Munkaterület létrehozása – portál

1. Jelentkezzen be az Azure Portalra, és keresse meg az API Management-példányt.

2. A bal oldali menü API-k csoportjában válassza a Munkaterületek>+ Hozzáadás lehetőséget.

3. Az Alapszintű beállítások lapon adjon meg egy leíró megjelenítendő nevet, erőforrásnevet és a munkaterület opcionális leírását . Válassza a Következőlehetőséget.

4. Az Átjáró lapon konfigurálja a munkaterületi átjáró beállításait.

   

   • Válassza az Új létrehozása lehetőséget egy új munkaterületi átjáró létrehozásához, vagy válassza a Meglévő használata lehetőséget, ha a munkaterületet olyan meglévő átjáróhoz szeretné társítani, amelyen más munkaterületek is üzembe helyezve vannak.

   • Ha úgy dönt, hogy új átjárót hoz létre:

     • Az átjáró részletei között adjon meg egy új átjárónevet, és válassza ki a méretezési egységek számát. Az átjáró költségei az egységek számán alapulnak. További információkért tekintse meg az API Management díjszabását.

     • A Hálózaton válassza ki a munkaterület-átjáró hálózati konfigurációját .

       Important

       Gondosan tervezze meg a munkaterület hálózati konfigurációját. A munkaterület létrehozása után nem módosíthatja a hálózati konfigurációt.

     • Ha a bejövő nyilvános hozzáférés, a kimenő privát hozzáférés (virtuális hálózati integráció) vagy a bejövő privát hozzáférés, a kimenő privát hozzáférés (virtuális hálózat injektálása) lehetőséget választja, válasszon ki egy virtuális hálózatot és alhálózatot a munkaterület-átjáró elkülönítéséhez, vagy hozzon létre egy újat. A hálózati követelményekről lásd a munkaterület-átjárók hálózati erőforrás-követelményeit.

5. Válassza a Következőlehetőséget. Az ellenőrzés befejezése után válassza a Létrehozás lehetőséget.

   Note

   Az új munkaterületi átjáró létrehozása – ha ki van választva – akár több órát is igénybe vehet. Az Azure Portal üzembe helyezési folyamatának nyomon követéséhez nyissa meg az átjáró erőforráscsoportját. A bal oldali menü Beállítások területén válassza az Implementációk lehetőséget.

Az üzembe helyezés befejezése után az új munkaterület megjelenik a Munkaterületek lapon található listában. Válassza ki a munkaterületet a beállításainak és erőforrásainak kezeléséhez.

Note

• Az átjáró futtatókörnyezeti gazdagépnevének és egyéb átjáróadatainak megtekintéséhez válassza ki a munkaterületet a portálon. Az Üzembe helyezés + infrastruktúra területen válassza az Átjárók lehetőséget, és válassza ki a munkaterület átjárójának nevét.
• A munkaterület-átjáró létrehozása közben a munkaterület API-jára irányuló futtatókörnyezeti hívások nem lesznek sikeresek.

Felhasználók hozzárendelése munkaterülethez – portál

Munkaterület létrehozása után rendeljen engedélyeket a felhasználókhoz a munkaterület erőforrásainak kezeléséhez. Minden munkaterület-felhasználóhoz hozzá kell rendelni egy szolgáltatás hatókörű munkaterületIBAC-szerepkört és egy munkaterület-hatókörű RBAC-szerepkört, vagy egyéni szerepkörökkel egyenértékű engedélyeket kell biztosítani.

A munkaterület-átjáró kezeléséhez javasoljuk, hogy a munkaterület felhasználóinak egy Azure által biztosított RBAC-szerepkört is rendeljen a munkaterület-átjáróhoz.

Note

A könnyebb kezelés érdekében állítsa be a Microsoft Entra-csoportokat, hogy több felhasználóhoz rendeljen munkaterületi engedélyeket.

• A beépített munkaterületi szerepkörök listájáért lásd: Szerepköralapú hozzáférés-vezérlés használata az API Managementben.
• A szerepkörök hozzárendelésének lépéseit az Azure-szerepkörök hozzárendelése a portálon című témakörben találja.

Szolgáltatás hatókörű szerepkör hozzárendelése

1. Jelentkezzen be az Azure Portalra, és 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)>+ Hozzáadás lehetőséget.

3. Rendelje hozzá a következő szolgáltatáshatókörű szerepkörök egyikét a munkaterület minden egyes tagjára:

   • API Management Service Workspace API Developer
   • API Management Service Workspace API Product Manager

Munkaterület hatókörű szerepkör hozzárendelése

1. Az API Management-példány menüjében, az API-k alatt válassza a Munkaterületek> lehetőséget a létrehozott munkaterület nevére.

2. A Munkaterület ablakban válassza a Hozzáférés-vezérlés (IAM)>+ Hozzáadás lehetőséget.

3. Rendelje hozzá az alábbi munkaterület-hatókörű szerepkörök egyikét a munkaterület tagjaihoz, hogy kezelni tudják a munkaterület API-kat és más erőforrásokat.

   • API Management-munkaterület olvasója
   • API Management-munkaterület közreműködője
   • API Management Workspace API Developer
   • API Management Workspace API Product Manager

Átjáró hatókörű szerepkör hozzárendelése

1. Jelentkezzen be az Azure Portalra, és keresse meg az API Management-példányt.

2. A bal oldali menü API-k csoportjában válassza a Munkaterületek> lehetőséget a munkaterület nevére.

3. A munkaterület bal oldali menüjében válassza az Átjárók lehetőséget, majd a munkaterületi átjárót.

4. A bal oldali menüben válassza a Hozzáférés-vezérlés (IAM)>+ Hozzáadás lehetőséget.

5. Rendelje hozzá az alábbi szerepkörök egyikét a munkaterület minden egyes tagjára. Legalább azt javasoljuk, hogy rendelje hozzá az Olvasó szerepkört az átjáró beállításainak megtekintéséhez. A tulajdonosok és közreműködők kezelhetik az átjáró beállításait, beleértve az átjáró skálázását is.

   • Owner
   • Contributor
   • Reader

Diagnosztikai beállítások engedélyezése munkaterületi API-k monitorozásához

Konfigurálja a beállításokat úgy, hogy összegyűjtsék a munkaterületHez tartozó Azure Monitor-naplókat, és elküldjék őket egy Log Analytics-munkaterületre, hogy a munkaterület csapata figyelhesse saját API-jait, miközben az API platform csapata hozzáférhet az API Management-példány központi naplóihoz. Tekintse meg a következő ábrát:

Az Azure Monitor-naplók munkaterülethez való gyűjtéséhez a szolgáltatás és a munkaterület szintjén is diagnosztikai beállításokra van szükség:

1. Először engedélyezze a diagnosztikai beállításokat szolgáltatásszinten az API Management-átjárónaplók gyűjtéséhez, ha egy beállítás még nincs engedélyezve. Javasoljuk, hogy küldjön naplókat egy Log Analytics-munkaterületre. További információ: Diagnosztikai beállítások konfigurálása az API Managementhez.

2. Ezután engedélyezze a munkaterület szintjén egy diagnosztikai beállítást az API Management-átjáró naplóinak ugyanarra a Log Analytics-munkaterületre való küldéséhez. Ez a beállítás a munkaterülethez társított összes munkaterület-átjáró naplóit gyűjti.

   Important

   A szolgáltatásszintű diagnosztikai beállítás konfigurálja a naplózást az API Management-példányon, beleértve azokat a munkaterületeket is, amelyeken engedélyezve van a munkaterületszintű diagnosztikai beállítás. Ha nem engedélyezi a munkaterületszintű diagnosztikai beállításokat, a munkaterület átjárónaplói nem lesznek összegyűjtve vagy összesítve a Log Analyticsben.

   Note

   Alapértelmezés szerint a munkaterület csapatának azon tagjai, akikhez a beépített munkaterület RBAC-szerepkörök vannak hozzárendelve, nem rendelkeznek engedéllyel a munkaterület diagnosztikai beállításainak szerkesztésére. Az API-platform csapata rendelkezik ezekkel az engedélyekkel.

A munkaterület diagnosztikai beállításainak konfigurálása a munkaterület szintű átjárónaplók gyűjtéséhez:

1. Jelentkezzen be az Azure Portalra, és keresse meg az API Management-példányt.

2. A bal oldali menü API-k csoportjában válassza a Munkaterületek> lehetőséget a munkaterület nevére.

3. A munkaterületek bal oldali menüjében, a Figyelés csoportban válassza a Diagnosztikai beállítások>+ Diagnosztikai beállítás hozzáadása lehetőséget.

4. A Diagnosztikai beállítás lapon adja meg vagy válassza ki a beállítás részleteit:

   1. Diagnosztikai beállítás neve: Adjon meg egy leíró nevet.
   2. Kategóriacsoportok: Igény szerint válasszon a forgatókönyvhöz.
   3. A Kategóriák csoportban válassza az ApiManagement Gatewayhez kapcsolódó naplókat a munkaterület API-jaihoz tartozó átjárónaplók gyűjtéséhez.
   4. A Céladatok csoportban válassza ki a naplók küldését a szolgáltatásszintű diagnosztikai beállításban és más munkaterületszintű diagnosztikai beállításokban megadott Azure Log Analytics-munkaterületre.
   5. Válassza az Mentésgombot.

Note

• Jelenleg csak átjárónaplók gyűjthetők a munkaterületekhez.
• A munkaterületszintű naplók eléréséhez navigáljon a munkaterület bal oldali menüjében található figyelési>naplókhoz .

A munkaterület használatának első lépései

A munkaterületen betöltött szerepkörüktől függően előfordulhat, hogy a felhasználók api-k, termékek, előfizetések és egyéb erőforrások létrehozására vonatkozó engedélyekkel rendelkeznek, vagy csak olvasási hozzáféréssel rendelkeznek némelyikhez vagy mindegyikhez.

Az API-k munkaterületen való kezelésének, védelmének és közzétételének megkezdéséhez tekintse meg az alábbi útmutatást.

Resource	Guide
APIs	Oktatóanyag: Az első API importálása és közzététele
Products	Oktatóanyag: Termék létrehozása és közzététele
Subscriptions	Előfizetések az Azure API Managementben Előfizetések létrehozása az API Managementben
Policies	Oktatóanyag: AZ API átalakítása és védelme Szabályzatok az Azure API Managementben API Management-szabályzatok beállítása vagy szerkesztése
Névvel ellátott értékek	Titkos kódok kezelése elnevezett értékekkel
Backends	Háttérrendszerek használata az Azure API Managementben
Szabályzattöredékek	Szabályzatkonfigurációk újrafelhasználása az API Management-szabályzatdefiníciókban
Schemas	Tartalom ellenőrzése
Groups	Csoportok létrehozása és használata fejlesztői fiókok kezeléséhez
Notifications	Értesítések és értesítési sablonok konfigurálása

Kapcsolódó tartalom

• További információ az Azure API Management munkaterületeiről.
• Virtuális hálózat használata az Azure API Management bejövő vagy kimenő forgalmának védelméhez