Tworzenie obszaru roboczego i zarządzanie nim w usłudze Azure API Management

DOTYCZY: Premium | Premium, wersja 2

Skonfiguruj obszar roboczy , aby umożliwić zespołowi interfejsów API zarządzanie własnymi interfejsami API i tworzenie ich produktów przy jednoczesnym zapewnieniu zespołowi platformy interfejsu API narzędzi do obserwowania, zarządzania i obsługi platformy API Management. Po utworzeniu obszaru roboczego i przypisaniu uprawnień współpracownicy obszaru roboczego mogą tworzyć własne interfejsy API, produkty, subskrypcje i powiązane zasoby oraz zarządzać nimi.

Note

• Najnowsze funkcje obszaru roboczego są wspierane w wersji 2023-09-01-preview lub nowszej interfejsu API REST systemu API Management.
• Aby zapoznać się z zagadnieniami dotyczącymi cen, zobacz Cennik usługi API Management.

Wykonaj kroki opisane w tym artykule, aby:

• Tworzenie obszaru roboczego usługi API Management i kojarzenie bramy obszaru roboczego przy użyciu witryny Azure Portal
• Opcjonalnie wyizoluj bramę obszaru roboczego w sieci wirtualnej platformy Azure
• Przypisywanie uprawnień do obszaru roboczego

Note

• Obecnie tworzenie bramy obszaru roboczego jest długotrwałą operacją, która może potrwać do 3 godzin lub więcej.
• Kojarzenie wielu obszarów roboczych z bramą obszaru roboczego jest dostępne tylko dla bram obszarów roboczych utworzonych po 15 kwietnia 2025 r. Dowiedz się więcej o wspólnych bramach obszarów roboczych.

Prerequisites

• Instancja usługi API Management. Jeśli chcesz, utwórz go w obsługiwanej warstwie.
• Rola właściciela lub współautora w grupie zasobów, w której wdrożono wystąpienie usługi API Management, lub równoważne uprawnienia do tworzenia zasobów w grupie zasobów.
• (Opcjonalnie) Podsieć w nowej lub istniejącej sieci wirtualnej platformy Azure w celu odizolowania ruchu przychodzącego i wychodzącego bramy obszaru roboczego. Aby uzyskać informacje o opcjach konfiguracji i wymaganiach, zobacz Wymagania dotyczące zasobów sieciowych dla bram obszarów roboczych.

Tworzenie obszaru roboczego — portal

1. Zaloguj się do witryny Azure Portal i przejdź do wystąpienia usługi API Management.

2. W menu po lewej stronie w obszarze Interfejsy API wybierz pozycję Obszary robocze>+ Dodaj.

3. Na karcie Podstawy wprowadź opisową nazwę wyświetlaną, nazwę zasobu i opcjonalny opis obszaru roboczego. Wybierz Dalej.

4. Na karcie Brama skonfiguruj ustawienia bramy obszaru roboczego.

   

   • Wybierz pozycję Utwórz nową , aby utworzyć nową bramę obszaru roboczego, lub wybierz pozycję Użyj istniejącej , aby skojarzyć obszar roboczy z istniejącą bramą, która ma wdrożone inne obszary robocze.

   • Jeśli zdecydujesz się utworzyć nową bramę:

     • W Szczegółach bramy wprowadź nową nazwę bramy i wybierz liczbę Jednostek skali. Koszty bramy są oparte na liczbie jednostek. Aby uzyskać więcej informacji, zobacz Cennik usługi API Management.

     • W obszarze Sieć wybierz konfigurację sieci dla bramy obszaru roboczego.

       Important

       Starannie zaplanuj konfigurację sieci obszaru roboczego. Po utworzeniu obszaru roboczego nie można zmienić konfiguracji sieci.

     • Jeżeli wybierzesz opcję Dostęp publiczny dla ruchu przychodzącego, dostęp prywatny dla ruchu wychodzącego (integracja z siecią wirtualną) lub opcję Dostęp prywatny dla ruchu przychodzącego, dostęp prywatny dla ruchu wychodzącego (integracja z siecią wirtualną), wybierz sieć wirtualną i podsieć, aby odizolować bramę obszaru roboczego lub utworzyć nową. Aby uzyskać informacje o wymaganiach dotyczących sieci, zobacz Wymagania dotyczące zasobów sieciowych dla bram obszarów roboczych.

5. Wybierz Dalej. Po zakończeniu walidacji wybierz pozycję Utwórz.

   Note

   Utworzenie nowej bramy obszaru roboczego, jeśli zostanie wybrana, może potrwać do kilku godzin. Aby śledzić postęp wdrażania w Azure Portal, przejdź do grupy zasobów bramy. W menu po lewej stronie w obszarze Ustawienia wybierz pozycję Wdrożenia.

Po zakończeniu wdrażania nowy obszar roboczy zostanie wyświetlony na liście na stronie Obszary robocze . Wybierz obszar roboczy, aby zarządzać swoimi ustawieniami i zasobami.

Note

• Aby wyświetlić nazwę hosta środowiska uruchomieniowego bramy i inne szczegóły bramy, wybierz obszar roboczy w portalu. W obszarze Wdrażanie i infrastruktura wybierz pozycję Bramy i wybierz nazwę bramy obszaru roboczego.
• Gdy tworzona jest brama obszaru roboczego, wywołania w czasie wykonywania do interfejsów API obszaru roboczego nie powiodą się.

Przypisywanie użytkowników do obszaru roboczego — portal

Po utworzeniu obszaru roboczego przypisz użytkownikom uprawnienia do zarządzania zasobami obszaru roboczego. Każdy użytkownik obszaru roboczego musi mieć przypisaną zarówno rolę RBAC obszaru roboczego w zakresie usługi, jak i rolę RBAC w zakresie obszaru roboczego lub przyznane równoważne uprawnienia przy użyciu ról niestandardowych.

Aby skutecznie zarządzać bramą obszaru roboczego, zdecydowanie zalecamy przypisanie użytkownikom tej bramy roli RBAC dostarczanej przez Azure, której zakres jest przypisany do bramy obszaru roboczego.

Note

Aby ułatwić zarządzanie, skonfiguruj grupy entra firmy Microsoft w celu przypisania uprawnień obszaru roboczego do wielu użytkowników.

• Aby uzyskać listę wbudowanych ról obszaru roboczego, zobacz How to use role-based access control in API Management (Jak używać kontroli dostępu opartej na rolach w usłudze API Management).
• Aby uzyskać instrukcje przypisywania roli, zobacz Przypisywanie ról platformy Azure przy użyciu portalu.

Przypisz rolę o zakresie usługi

1. Zaloguj się do witryny Azure Portal i przejdź do wystąpienia usługi API Management.

2. W menu po lewej stronie wybierz pozycję Kontrola dostępu (zarządzanie dostępem i tożsamościami)>+ Dodaj.

3. Przypisz jedną z następujących ról o zakresie usługi do każdego członka obszaru roboczego:

   • Deweloper interfejsu API w obszarze roboczym zarządzania usługą API
   • Menedżer produktu interfejsu API obszaru roboczego usługi API zarządzania interfejsem API

Przypisywanie roli o zakresie obszaru roboczego

1. W menu wystąpienia API Management, w obszarze Interfejsy API, wybierz Obszary robocze> i nazwę utworzonego obszaru roboczego.

2. W oknie Obszar roboczy wybierz pozycję Kontrola dostępu (zarządzanie dostępem i tożsamościami)>+ Dodaj.

3. Przypisz jedną z następujących ról o zakresie obszaru roboczego członkom obszaru roboczego, aby mogli zarządzać interfejsami API i innymi zasobami obszaru roboczego.

   • Czytelnik obszaru roboczego usługi API Management
   • Współautor obszaru roboczego usługi API Management
   • Api Workspace API Developer (Deweloper interfejsu API obszaru roboczego usługi API Management)
   • Menedżer produktu API w przestrzeni zarządzania API

Przypisz rolę związaną z bramą

1. Zaloguj się do witryny Azure Portal i przejdź do wystąpienia usługi API Management.

2. W menu po lewej stronie, w sekcji API, wybierz Obszary robocze i nazwę swojego obszaru roboczego.

3. W menu po lewej stronie obszaru roboczego wybierz pozycję Bramy i wybierz bramę obszaru roboczego.

4. W menu po lewej stronie wybierz pozycję Kontrola dostępu (zarządzanie dostępem i tożsamościami)>+ Dodaj.

5. Przypisz jedną z następujących ról do każdego członka obszaru roboczego. Zalecamy przypisanie roli Czytelnik co najmniej po to, aby wyświetlić ustawienia bramy. Właściciele i współautorzy mogą zarządzać ustawieniami bramy, w tym skalowaniem bramy.

   • Owner
   • Contributor
   • Reader

Włącz ustawienia diagnostyczne na potrzeby monitorowania interfejsów API obszaru roboczego

Skonfiguruj ustawienia w celu zbierania dzienników usługi Azure Monitor dla obszaru roboczego i wysyłania ich do obszaru roboczego usługi Log Analytics, aby zespół obszaru roboczego mógł monitorować własne interfejsy API, podczas gdy zespół platformy interfejsu API może uzyskiwać dostęp do scentralizowanych dzienników dla wystąpienia usługi API Management. Zobacz następujący diagram:

Aby zebrać dzienniki usługi Azure Monitor dla obszaru roboczego, ustawienia diagnostyczne są wymagane zarówno na poziomie usługi, jak i obszaru roboczego:

1. Najpierw włącz ustawienie diagnostyczne na poziomie usługi dla zbierania dzienników bramy usługi API Management, jeśli ustawienie nie jest jeszcze włączone. Zalecamy wysyłanie dzienników do obszaru roboczego usługi Log Analytics. Aby uzyskać więcej informacji, zobacz Konfigurowanie ustawień diagnostycznych dla usługi API Management.

2. Następnie włącz ustawienie diagnostyki na poziomie obszaru roboczego , aby wysyłać dzienniki bramy usługi API Management do tego samego obszaru roboczego usługi Log Analytics. To ustawienie zbiera dzienniki dla wszystkich bram obszaru roboczego skojarzonych z obszarem roboczym.

   Important

   Ustawienie diagnostyczne na poziomie usługi konfiguruje rejestrowanie w instancji API Management, obejmując obszary robocze z aktywowanym ustawieniem diagnostycznym na poziomie obszaru roboczego. Jeśli nie włączysz ustawienia diagnostycznego na poziomie obszaru roboczego, dzienniki bramy obszaru roboczego nie zostaną zebrane ani zagregowane w usłudze Log Analytics.

   Note

   Domyślnie członkowie zespołu obszaru roboczego przypisyli wbudowane role RBAC obszaru roboczego nie mają uprawnień do edytowania ustawień diagnostycznych w obszarze roboczym. Zespół platformy interfejsu API ma te uprawnienia.

Aby skonfigurować ustawienie diagnostyczne obszaru roboczego dla kolekcji dzienników bramy na poziomie obszaru roboczego:

1. Zaloguj się do witryny Azure Portal i przejdź do wystąpienia usługi API Management.

2. W menu po lewej stronie, w sekcji API, wybierz Obszary robocze i nazwę swojego obszaru roboczego.

3. W menu po lewej stronie obszarów roboczych w obszarze Monitorowanie wybierz pozycję Ustawienia>diagnostyczne+ Dodaj ustawienie diagnostyczne.

4. Na stronie Ustawienia diagnostyczne wprowadź lub wybierz szczegóły ustawienia:

   1. Nazwa ustawienia diagnostycznego: wprowadź opisową nazwę.
   2. Grupy kategorii: opcjonalnie wybierz swój scenariusz.
   3. W obszarze Kategorie wybierz Dzienniki powiązane z bramą API Management, aby zebrać dzienniki bramy dla interfejsów API w tym obszarze roboczym.
   4. W obszarze Szczegóły miejsca docelowego wybierz opcję wysyłania dzienników do tego samego obszaru roboczego usługi Azure Log Analytics określonego w ustawieniu diagnostycznym na poziomie usługi i w innych ustawieniach diagnostycznych na poziomie obszaru roboczego.
   5. Wybierz Zapisz.

Note

• Obecnie tylko dzienniki bramy można zbierać dla obszarów roboczych.
• Uzyskaj dostęp do dzienników na poziomie obszaru roboczego, przechodząc do obszaru Monitorowanie>dzienników w menu po lewej stronie obszaru roboczego.

Wprowadzenie do obszaru roboczego

W zależności od roli w obszarze roboczym użytkownicy mogą mieć uprawnienia do tworzenia interfejsów API, produktów, subskrypcji i innych zasobów lub mogą mieć dostęp tylko do odczytu do niektórych lub wszystkich z nich.

Aby rozpocząć zarządzanie, ochronę i publikowanie interfejsów API w obszarze roboczym, zapoznaj się z poniższymi wskazówkami.

Resource	Guide
APIs	Samouczek: importowanie i publikowanie pierwszego interfejsu API
Products	Samouczek: Tworzenie i publikowanie produktu
Subscriptions	Subskrypcje w usłudze Azure API Management Tworzenie subskrypcji w usłudze API Management
Policies	Samouczek: Jak przekształcić i chronić swój interfejs API Zasady w usłudze Azure API Management Ustawianie lub edytowanie zasad usługi API Management
Nazwane wartości	Zarządzaj sekretami przy użyciu nazwanych wartości
Backends	Korzystanie z zapleczy w usłudze Azure API Management
Fragmenty zasad	Ponowne wykorzystanie konfiguracji zasad w definicjach zasad API Management
Schemas	Weryfikowanie zawartości
Groups	Tworzenie i używanie grup do zarządzania kontami deweloperów
Notifications	Jak skonfigurować powiadomienia i szablony powiadomień

Treści powiązane

• Dowiedz się więcej o obszarach roboczych w usłudze Azure API Management.
• Zabezpieczanie ruchu przychodzącego lub wychodzącego dla usługi Azure API Management za pomocą sieci wirtualnej