Pracovní prostory ve službě Azure API Management

PLATÍ PRO: Premium

Ve službě API Management umožňují pracovní prostory decentralizovaným vývojovým týmům rozhraní API spravovat a produktizovat vlastní rozhraní API, zatímco centrální tým platformy API udržuje infrastrukturu služby API Management. Každý pracovní prostor obsahuje rozhraní API, produkty, předplatná a související entity, které jsou přístupné jenom spolupracovníkům pracovního prostoru. Přístup se řídí prostřednictvím řízení přístupu na základě role (RBAC) v Azure.

Poznámka:

  • Pracovní prostory jsou funkcí služby API Management ve verzi Preview a podléhají určitým omezením.
  • Pracovní prostory jsou podporované v rozhraní API REST API služby API služby API verze 2022-09-01-preview nebo novější.
  • Důležité informace o cenách najdete v tématu s cenami služby API Management.
  • Podívejte se na nadcházející zásadní změny pracovních prostorů.

Přehled ukázkových scénářů

Organizace, která spravuje rozhraní API pomocí služby Azure API Management, může mít několik vývojových týmů, které vyvíjejí, definují, spravují a produktizují různé sady rozhraní API. Pracovní prostory umožňují těmto týmům používat službu API Management ke správě a přístupu k jejich rozhraním API samostatně a nezávisle na správě infrastruktury služeb.

Následuje ukázkový pracovní postup pro vytvoření a použití pracovního prostoru.

  1. Centrální tým platformy API, který spravuje instanci služby API Management, vytvoří pracovní prostor a přiřadí oprávnění spolupracovníkům pracovního prostoru pomocí rolí RBAC – například oprávnění k vytváření nebo čtení prostředků v pracovním prostoru.

  2. Centrální tým platformy API používá nástroje DevOps k vytvoření kanálu DevOps pro rozhraní API v daném pracovním prostoru.

  3. Členové pracovního prostoru vyvíjejí, publikují, produktizují a spravují rozhraní API v pracovním prostoru.

  4. Centrální tým platformy API spravuje infrastrukturu služby, jako je síťové připojení, monitorování, odolnost a vynucování zásad all-API.

Funkce pracovního prostoru

Následující prostředky je možné spravovat ve verzi Preview pracovních prostorů.

Rozhraní API a zásady

  • Vytváření a správa rozhraní API a operací rozhraní API, včetně sad verzí rozhraní API, revizí rozhraní API a zásad rozhraní API

  • Použijte zásadu pro všechna rozhraní API v pracovním prostoru.

  • Popis rozhraní API se značkami na úrovni pracovního prostoru

  • Definujte pojmenované hodnoty, fragmenty zásad a schémata pro ověřování požadavků a odpovědí pro použití v zásadách s oborem pracovního prostoru.

Poznámka:

Obory zásad v pracovním prostoru jsou následující: Všechna rozhraní API (služba) > Všechna rozhraní API (pracovní prostor) > Rozhraní API > produktu >

Uživatelé a skupiny

  • Uspořádejte uživatele (z úrovně služby) do skupin v pracovním prostoru.

Produkty a předplatná

  • Publikování rozhraní API s produkty Rozhraní API v pracovním prostoru můžou být pouze součástí produktu na úrovni pracovního prostoru. Viditelnost lze nakonfigurovat na základě členství uživatele v úrovni pracovního prostoru nebo skupiny na úrovni služby.

  • Správa přístupu k rozhraním API s předplatnými Předplatná požadovaná pro rozhraní API nebo produkt v rámci pracovního prostoru se v daném pracovním prostoru vytvoří.

  • Publikujte rozhraní API a produkty pomocí portálu pro vývojáře.

  • Správa e-mailových oznámení pro správu souvisejících s prostředky v pracovním prostoru

Role RBAC

Azure RBAC slouží ke konfiguraci oprávnění spolupracovníků pracovního prostoru ke čtení a úpravě entit v pracovním prostoru. Seznam rolí najdete v tématu Použití řízení přístupu na základě role ve službě API Management.

Členové pracovního prostoru musí mít přiřazenou roli s oborem služby i roli s oborem pracovního prostoru nebo musí mít přiřazená ekvivalentní oprávnění pomocí vlastních rolí. Role vymezená službou umožňuje odkazovat na určité prostředky na úrovni služby z prostředků na úrovni pracovního prostoru. Uspořádejte například uživatele do skupiny na úrovni pracovního prostoru, abyste mohli řídit viditelnost rozhraní API a produktů.

Poznámka:

Pro snadnější správu nastavte skupiny Microsoft Entra tak, aby přiřadily oprávnění pracovního prostoru více uživatelům.

Pracovní prostory a další funkce služby API Management

  • Funkce infrastruktury – Funkce infrastruktury platformy API Management se spravují jenom na úrovni služby, ne na úrovni pracovního prostoru. Patří k nim:

    • Připojení k privátní síti

    • Brány rozhraní API, včetně škálování, umístění a bran v místním prostředí

  • Odkazy na prostředky – Prostředky v pracovním prostoru můžou odkazovat na jiné prostředky v pracovním prostoru a uživatele z úrovně služby. Nemůžou odkazovat na prostředky z jiného pracovního prostoru.

    Z bezpečnostních důvodů není možné odkazovat na prostředky na úrovni služby ze zásad na úrovni pracovního prostoru (například pojmenované hodnoty) nebo podle názvů prostředků, například backend-id v zásadách set-back-end-service .

  • Portál pro vývojáře – Pracovní prostory jsou konceptem správy a nezobrazují se jako uživatelé portálu pro vývojáře, včetně uživatelského rozhraní portálu pro vývojáře a základního rozhraní API. Rozhraní API a produkty se ale dají publikovat z pracovního prostoru na portálu pro vývojáře. Z tohoto důvodu musí mít všechny prostředky používané portálem pro vývojáře (například rozhraní API, produkt, značka nebo předplatné) jedinečný název prostředku Azure ve službě. Ve stejném pracovním prostoru, v jiných pracovních prostorech ani na úrovni služby nemůže existovat žádné prostředky stejného typu a se stejným názvem prostředku Azure.

  • Odstranění pracovního prostoru – Odstraněním pracovního prostoru se odstraní všechny jeho podřízené prostředky (rozhraní API, produkty atd.).

Omezení verze Preview

V pracovních prostorech se v současné době nepodporují následující prostředky:

  • Autorizační servery (zprostředkovatelé přihlašovacích údajů ve Správci přihlašovacích údajů)

  • Autorizace (připojení k poskytovatelům přihlašovacích údajů ve Správci přihlašovacích údajů)

  • Back-endy

  • Klientské certifikáty

  • Aktuální nástroje DevOps pro API Management

  • Diagnostika

  • Protokolovací nástroje

  • Syntetická rozhraní GraphQL API

  • Spravovaná identita přiřazená uživatelem

V pracovních prostorech se proto v současné době nepodporují následující ukázkové scénáře:

  • Monitorování rozhraní API s konfigurací specifickou pro pracovní prostor

  • Správa back-endů rozhraní API a import rozhraní API ze služeb Azure

  • Ověřování klientských certifikátů

  • Použití správce přihlašovacích údajů (dříve označované jako autorizace)

  • Zadání informací o autorizačním serveru rozhraní API (například pro portál pro vývojáře)

  • Publikování rozhraní API pracovního prostoru na brány v místním prostředí

Důležité

Všechny prostředky ve službě API Management musí mít jedinečné názvy, i když jsou umístěné v různých pracovních prostorech.