Vytvoření a správa pracovního prostoru ve službě Azure API Management

PLATÍ PRO: Basic v2 | Standard v2 | Premium | Premium v2

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.

Note

  • Novinka! Funkce pracovních prostorů je nyní k dispozici na úrovních Basic v2 a Standard v2, kromě úrovní Premium a Premium v2. Pracovní prostory na úrovních v2 je možné přidružit buď k výchozí spravované bráně služby API Management, nebo k samostatnému prostředku brány pracovního prostoru, což poskytuje flexibilitu při konfiguraci a škálování pracovních prostorů. Informace o plánu podpory vrstev pracovních prostorů najdete v blogovém příspěvku.
  • Podrobnosti o cenách najdete v části API Management pricing.

Postupujte podle kroků v tomto článku:

  • Vytvořte pracovní prostor služby API Management přidružený k výchozí spravované bráně instance nebo přidružený k nové nebo existující bráně pracovního prostoru.
  • Volitelně můžete izolovat bránu pracovního prostoru ve Azure virtuální síti.
  • Přiřaďte oprávnění k pracovnímu prostoru.

Note

Prerequisites

  • Instance služby API Management. Pokud ji potřebujete, vytvořte ji v podporované vrstvě.
  • Role 'Vlastník' nebo 'Přispěvatel' ve skupině prostředků, ve které je nasazená instance API Management, nebo ekvivalentní oprávnění k vytváření prostředků ve skupině prostředků.
  • (Volitelné) Podsíť v nové nebo existující Azure virtuální síti za účelem izolace 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.
  • (Volitelné, pro přidružení výchozí spravované brány k pracovnímu prostoru) Klient REST pro volání rozhraní REST API služby API Management.

Vytvoření pracovního prostoru a přidružení výchozí spravované brány – REST API

Můžete vytvořit pracovní prostor, který směruje provoz rozhraní API přes výchozí spravovanou bránu služby místo do brány pracovního prostoru. Tato možnost eliminuje dodatečné náklady a složitost spojené se samostatným prostředkem brány. Provoz rozhraní API směruje přes výchozí název hostitele služby (například <service-name>.azure-api.net).

Note

V současné době se vytvoření pracovního prostoru a přidružení výchozí spravované brány podporuje pouze v úrovních v2 a prostřednictvím rozhraní REST API api služby API Management.

Pomocí pracovního prostoru – Vytvoření nebo aktualizace rozhraní REST API vytvořte pracovní prostor.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}?api-version=2024-05-01
Authorization: Bearer {token}
Content-Type: application/json

{
  "properties": {
    "displayName": "my workspace",
    "description": "Workspace using default managed gateway",
    "serveOn": "workspaceAndDefault"
  }
}

Replace:

  • {subscriptionId} s ID vašeho předplatného Azure
  • {resourceGroupName} s názvem skupiny prostředků vaší instance služby API Management
  • {serviceName} s názvem vaší instance služby API Management
  • {workspaceId} s jedinečným identifikátorem pracovního prostoru (alfanumerické znaky, povoleny jsou i spojovníky)

Úspěšná odpověď vrátí HTTP 201 Created spolu s prostředkem pracovního prostoru. Ve výchozím nastavení pracovní prostor směruje provoz API přes výchozí název hostitele této služby.

Po vytvoření pracovního prostoru pokračujte přiřazením uživatelů k pracovnímu prostoru – portálu a nakonfigurujte přístupová oprávnění.

Vytvoření pracovního prostoru a přidružení brány pracovního prostoru – portál

  1. Přihlaste se k webu Azure Portal a přejděte do instance služby API Management.

  2. V nabídce vlevo v části Rozhraní API vyberte Pracovní prostory> + Přidat.

  3. Na kartě Základy zadejte popisný název pro zobrazení, název prostředku a volitelný popis pracovního prostoru. Vyberte Další.

  4. Na kartě Brána nakonfigurujte nastavení pro bránu pracovního prostoru.

    Snímek obrazovky s vytvořením brány pracovního prostoru na portálu

    • Vyberte Vytvořit novou pro vytvoření nové brány pracovního prostoru, nebo vyberte Použít existující pro přidružení pracovního prostoru k existující bráně, kde jsou nasazeny další pracovní prostory.

    • Pokud se rozhodnete vytvořit novou bránu:

      • V podrobnostech brány zadejte nový název brány a vyberte počet jednotek škálování. Náklady na vstupní bránu jsou kalkulované na základě počtu jednotek. 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.

        Important

        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 příchozí veřejný přístup, odchozí privátní přístup (integrace virtuální sítě) nebo příchozí privátní přístup, odchozí privátní přístup (injektáž virtuální sítě), vyberte virtuální síť a podsíť pro izolaci brány pracovního prostoru nebo vytvořte nový. Požadavky na síť najdete v tématu Požadavky na síťové prostředky pro brány pracovních prostorů.

  5. Vyberte Další. Po dokončení ověření vyberte Vytvořit.

    Note

    Vytvoření nové brány pracovního prostoru, pokud je vybrána, může trvat až několik hodin. Pokud chcete sledovat průběh nasazení v portálu Azure, 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.

Note

  • 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í za běhu do 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 pracovního prostoru s rozsahem služby i role RBAC s rozsahem pracovního prostoru, nebo mu musí být pomocí vlastních rolí udělena ekvivalentní oprávnění.

Pokud pracovní prostor používá prostředek brány pracovního prostoru, přiřaďte uživatelům pracovního prostoru také roli RBAC poskytovanou službou Azure s rozsahem vymezeným pro bránu pracovního prostoru.

Note

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.

Přiřazení role s vymezeným oborem služby

  1. Přihlaste se k webu Azure Portal a přejděte do instance služby API Management.

  2. V nabídce vlevo vyberte Řízení přístupu (IAM)>+ Přidat.

  3. 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
    • Produktový manažer API pro pracovní prostor služby správy API

Přiřazení role s vymezeným pracovním prostorem

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

  2. V okně Pracovního prostoru vyberte Řízení přístupu (IAM)>+ Přidat.

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

  1. Přihlaste se k webu Azure Portal a přejděte do instance služby API Management.

  2. V nabídce vlevo v části Rozhraní API vyberte Pracovní prostory> název vašeho pracovního prostoru.

  3. V levé nabídce pracovního prostoru vyberte Brány a vyberte bránu pracovního prostoru.

  4. V nabídce vlevo vyberte Řízení přístupu (IAM)>+ Přidat.

  5. Každému členu pracovního prostoru přiřaďte jednu z následujících rolí. Minimálně přiřaďte roli Čtenář, abyste mohli zobrazit nastavení brány. Vlastníci a přispěvatelé můžou spravovat nastavení brány, včetně škálování brány.

    • Owner
    • Contributor
    • Reader

Povolit nastavení diagnostiky pro monitorování rozhraní API pracovního prostoru

Nakonfigurujte nastavení pro shromažďování Azure Monitor protokolů pro pracovní prostor a jejich odeslání do Log Analytics pracovního prostoru. Tým pracovního prostoru může monitorovat vlastní rozhraní API, zatímco tým platformy API má přístup k centralizovaným záznamům z instance API Management. Podívejte se na následující diagram:

Diagram federovaného protokolování ve službě API Management

Pokud chcete shromažďovat protokoly Azure Monitor pro pracovní prostor, potřebujete nastavení diagnostiky na úrovni služby i pracovního prostoru:

  1. Nejprve povolte nastavení diagnostiky na úrovni služby pro shromažďování protokolů brány služby API Management, pokud nastavení ještě není povolené. Odešle protokoly do pracovního prostoru Log Analytics. Další informace najdete v tématu Konfigurace nastavení diagnostiky pro službu API Management.

  2. Potom povolte nastavení diagnostiky na úrovni pracovního prostoru, aby se protokoly brány služby API Management odesílaly do stejného pracovního prostoru Log Analytics. Toto nastavení shromažďuje protokoly pro všechny brány pracovního prostoru přidružené k tomuto pracovnímu prostoru.

    Important

    Nastavení diagnostiky na úrovni služby konfiguruje protokolování napříč instancí služby API Management, včetně pracovních prostorů s povoleným nastavením diagnostiky na úrovni pracovního prostoru. Pokud nepovolíte nastavení diagnostiky na úrovni pracovního prostoru, nebudou se protokoly brány pracovního prostoru shromažďovat ani agregovat do Log Analytics.

    Note

    Ve výchozím nastavení nemají členové týmu pracovního prostoru, kterým byly přiřazeny vestavěné role RBAC pracovního prostoru, oprávnění k úpravě nastavení diagnostiky v pracovním prostoru. Tým platformy API má tato oprávnění.

Aby bylo možné konfigurovat diagnostické nastavení pracovního prostoru pro sběr protokolů brány na úrovni pracovního prostoru:

  1. Přihlaste se k webu Azure Portal a přejděte do instance služby API Management.

  2. V nabídce vlevo v části Rozhraní API vyberte Pracovní prostory> název vašeho pracovního prostoru.

  3. V levé nabídce pracovních prostorů v části Monitorování vyberte Nastavení>diagnostiky+ Přidat nastavení diagnostiky.

  4. V nastavení diagnostiky zadejte nebo vyberte podrobnosti nastavení:

    1. Název nastavení diagnostiky: Zadejte popisný název.
    2. Skupiny kategorií: Volitelně můžete vybrat svůj scénář.
    3. V části Kategorie vyberte Protokoly související s branou ApiManagement Gateway pro shromažďování protokolů brány pro rozhraní API v tomto pracovním prostoru.
    4. V části Podrobnosti o cíli vyberte, že chcete odesílat protokoly do stejného pracovního prostoru Služby Log Analytics zadaného v nastavení diagnostiky na úrovni služby a v jiných nastaveních diagnostiky na úrovni pracovního prostoru.
    5. Vyberte Uložit.

Note

  • V současné době můžete shromažďovat pouze protokoly brány u pracovních prostorů.
  • K protokolům na úrovni pracovního prostoru se dostanete tak, že v levé nabídce pracovního prostoru přejdete do Monitorování>Protokoly.

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 můžou mít přístup jen pro čtení k některým nebo všem těmto prostředkům.

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.

Resource Guide
APIs Kurz: Import a publikování prvního rozhraní API
Products Kurz: Vytvoření a publikování produktu
Subscriptions Předplatná ve službě Azure API Management

Vytváření předplatných ve službě API Management
Policies Kurz: Transformace a ochrana rozhraní API

Zásady ve službě Azure API Management

Nastavení nebo úprava zásad služby API Management
Pojmenované hodnoty Správa tajemství pomocí pojmenovaných hodnot
Backends Použití back-endů ve službě Azure API Management
Fragmenty zásad Opakované použití konfigurací zásad v definicích zásad služby API Management
Schemas Ověření obsahu
Groups Vytváření a používání skupin ke správě vývojářských účtů
Notifications Konfigurace oznámení a šablon oznámení

Související obsah

  • Last updated on