Vytvoření a správa pracovního prostoru ve službě Azure API Management
PLATÍ PRO: Premium
Nastavte pracovní prostor tak, aby tým rozhraní API mohl spravovat a produktizovat vlastní rozhraní API a současně poskytnout týmu platformy API nástroje pro sledování, řízení a údržbu platformy API Management. Po vytvoření pracovního prostoru a přiřazení oprávnění můžou spolupracovníci pracovního prostoru vytvářet a spravovat vlastní rozhraní API, produkty, předplatná a související prostředky.
Poznámka:
- Nejnovější funkce pracovních prostorů jsou podporované v rozhraní API REST API služby API služby API verze 2023-09-01-preview nebo novější.
- Důležité informace o cenách najdete v tématu s cenami služby API Management.
Postupujte podle kroků v tomto článku:
- Vytvoření pracovního prostoru služby API Management a brány pracovního prostoru pomocí webu Azure Portal
- Volitelně můžete bránu pracovního prostoru izolovat ve virtuální síti Azure.
- Přiřazení oprávnění k pracovnímu prostoru
Poznámka:
- Vytvoření brány pracovního prostoru je v současné době dlouhotrvající operace, která může trvat až 3 hodiny nebo déle.
- Představujeme možnost přidružit více pracovních prostorů k bráně pracovního prostoru a pomáhá organizacím spravovat rozhraní API s pracovními prostory s nižšími náklady. Tato funkce se zavádí od prosince 2024 a nemusí být k dispozici pro všechny oprávněné služby před lednem. Další informace
Požadavky
- Instance služby API Management. Pokud potřebujete, vytvořte ji v podporované vrstvě.
- Role Vlastník nebo Přispěvatel ve skupině prostředků, ve které je nasazená instance SLUŽBY API Management, nebo ekvivalentní oprávnění k vytváření prostředků ve skupině prostředků.
- (Volitelné) Existující nebo nová virtuální síť a podsíť Azure pro izolaci příchozího a odchozího provozu brány pracovního prostoru. Informace o možnostech konfigurace a požadavcích najdete v tématu Požadavky na síťové prostředky pro brány pracovního prostoru.
Vytvoření pracovního prostoru – portál
Přihlaste se k webu Azure Portal a přejděte k vaší instanci služby API Management.
V nabídce vlevo v části Rozhraní API vyberte Pracovní prostory> + Přidat.
Na kartě Základy zadejte popisný zobrazovaný název, název prostředku a volitelný popis pracovního prostoru. Vyberte Další.
Na kartě Brána nakonfigurujte nastavení pro bránu pracovního prostoru:
V podrobnostech brány zadejte název brány a vyberte počet jednotek škálování. Náklady na bránu jsou založené na počtu jednotek, které vyberete. Další informace najdete v tématu o cenách služby API Management.
V části Síť vyberte konfiguraci sítě pro bránu pracovního prostoru.
Důležité
Pečlivě naplánujte konfiguraci sítě pracovního prostoru. Po vytvoření pracovního prostoru nemůžete změnit konfiguraci sítě.
Pokud vyberete konfiguraci sítě, která zahrnuje privátní příchozí nebo privátní odchozí síťový přístup, vyberte virtuální síť a podsíť a izolujte bránu pracovního prostoru nebo vytvořte novou. Požadavky na síť najdete v tématu Požadavky na síťové prostředky pro brány pracovních prostorů.
Vyberte Další. Po dokončení ověření vyberte Vytvořit.
Vytvoření pracovního prostoru, brány pracovního prostoru a souvisejících prostředků může trvat několik minut až několik hodin. Pokud chcete sledovat průběh nasazení na webu Azure Portal, přejděte do skupiny prostředků brány. V nabídce vlevo v části Nastavení vyberte Nasazení.
Po dokončení nasazení se nový pracovní prostor zobrazí v seznamu na stránce Pracovní prostory . Vyberte pracovní prostor a spravujte jeho nastavení a prostředky.
Poznámka:
- Pokud chcete zobrazit název hostitele modulu runtime brány a další podrobnosti o bráně, vyberte pracovní prostor na portálu. V části Nasazení a infrastruktura vyberte Brány a vyberte název brány pracovního prostoru.
- Během vytváření brány pracovního prostoru nebudou volání modulu runtime rozhraní API pracovního prostoru úspěšná.
Přiřazení uživatelů k pracovnímu prostoru – portál
Po vytvoření pracovního prostoru přiřaďte uživatelům oprávnění ke správě prostředků pracovního prostoru. Každému uživateli pracovního prostoru musí být přiřazena role RBAC v oboru služby i role RBAC s oborem pracovního prostoru nebo udělená ekvivalentní oprávnění pomocí vlastních rolí.
Pokud chcete spravovat bránu pracovního prostoru, doporučujeme také uživatelům pracovního prostoru přiřadit roli RBAC zadanou v Azure s oborem brány pracovního prostoru.
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.
- Seznam předdefinovaných rolí pracovního prostoru najdete v tématu Použití řízení přístupu na základě role ve službě API Management.
- Postup přiřazení role najdete v tématu Přiřazení rolí Azure pomocí portálu.
Přiřazení role s vymezeným oborem služby
Přihlaste se k webu Azure Portal a přejděte k vaší instanci služby API Management.
V nabídce vlevo vyberte Řízení přístupu (IAM)>+ Přidat.
Každému členu pracovního prostoru přiřaďte jednu z následujících rolí vymezených službou:
- Vývojář rozhraní API pro pracovní prostor služby API management
- Product Manager rozhraní API pro pracovní prostor služby API management
Přiřazení role s vymezeným pracovním prostorem
V nabídce vaší instance služby API Management v části Rozhraní API vyberte Pracovní prostory> název pracovního prostoru, který jste vytvořili.
V okně Pracovního prostoru vyberte Řízení přístupu (IAM)>+ Přidat.
Přiřaďte členům pracovního prostoru jednu z následujících rolí vymezených pracovním prostorem, aby mohli spravovat rozhraní API pracovního prostoru a další prostředky.
- Čtenář pracovního prostoru služby API Management
- Přispěvatel pracovního prostoru služby API Management
- Vývojář rozhraní API pro pracovní prostor služby API Management
- API Management Workspace API Product Manager
Přiřazení role s vymezeným oborem brány
Přihlaste se k webu Azure Portal a přejděte k vaší instanci služby API Management.
V nabídce vlevo v části Rozhraní API vyberte Pracovní prostory> název vašeho pracovního prostoru.
V levé nabídce pracovního prostoru vyberte Brány a vyberte bránu pracovního prostoru.
V nabídce vlevo vyberte Řízení přístupu (IAM)>+ Přidat.
Každému členu pracovního prostoru přiřaďte jednu z následujících rolí. Pokud chcete zobrazit nastavení brány, doporučujeme minimálně přiřadit roli Čtenář . Vlastníci a přispěvatelé můžou spravovat nastavení brány, včetně škálování brány.
- Vlastník
- Přispěvatel
- Čtenář
Začínáme s pracovním prostorem
V závislosti na své roli v pracovním prostoru můžou mít uživatelé oprávnění vytvářet rozhraní API, produkty, předplatná a další prostředky nebo mají přístup jen pro čtení k některým nebo všem z nich.
Pokud chcete začít spravovat, chránit a publikovat rozhraní API v pracovním prostoru, přečtěte si následující doprovodné materiály.