Obszary robocze w usłudze Azure API Management

DOTYCZY: Premium

W usłudze API Management obszary robocze umożliwiają zdecentralizowanym zespołom deweloperów interfejsów API zarządzanie własnymi interfejsami API i tworzenie ich produktów, a centralny zespół ds. platformy interfejsu API utrzymuje infrastrukturę usługi API Management. Każdy obszar roboczy zawiera interfejsy API, produkty, subskrypcje i powiązane jednostki, które są dostępne tylko dla współpracowników obszaru roboczego. Dostęp jest kontrolowany za pośrednictwem kontroli dostępu opartej na rolach (RBAC) platformy Azure.

Uwaga

  • Obszary robocze są funkcją w wersji zapoznawczej usługi API Management i podlegają pewnym ograniczeniom.
  • Obszary robocze są obsługiwane w interfejsie API REST usługi API Management w wersji 2022-09-01-preview lub nowszej.
  • Aby zapoznać się z zagadnieniami dotyczącymi cen, zobacz Cennik usługi API Management.
  • Zobacz nadchodzące zmiany powodujące niezgodność dla obszarów roboczych.

Omówienie przykładowego scenariusza

Organizacja, która zarządza interfejsami API przy użyciu usługi Azure API Management, może mieć wiele zespołów programistycznych, które tworzą, definiują, konserwują i tworzą różne zestawy interfejsów API. Obszary robocze umożliwiają tym zespołom używanie usługi API Management do oddzielnego zarządzania interfejsami API i uzyskiwania do nich dostępu, a także niezależnie od zarządzania infrastrukturą usług.

Poniżej przedstawiono przykładowy przepływ pracy do tworzenia i używania obszaru roboczego.

  1. Centralny zespół platformy interfejsu API, który zarządza wystąpieniem usługi API Management, tworzy obszar roboczy i przypisuje uprawnienia współpracownikom obszaru roboczego przy użyciu ról RBAC — na przykład uprawnienia do tworzenia lub odczytywania zasobów w obszarze roboczym.

  2. Centralny zespół ds. platformy interfejsu API używa narzędzi DevOps do tworzenia potoku DevOps dla interfejsów API w tym obszarze roboczym.

  3. Członkowie obszaru roboczego tworzą, publikują, productize i utrzymują interfejsy API w obszarze roboczym.

  4. Centralny zespół platformy interfejsu API zarządza infrastrukturą usługi, taką jak łączność sieciowa, monitorowanie, odporność i wymuszanie zasad wszystkich interfejsów API.

Funkcje obszaru roboczego

Następujące zasoby można zarządzać w wersji zapoznawczej obszarów roboczych.

Interfejsy API i zasady

  • Twórz interfejsy API i operacje interfejsów API oraz zarządzaj nimi, w tym zestawami wersji interfejsu API, poprawkami interfejsu API i zasadami interfejsu API.

  • Stosowanie zasad dla wszystkich interfejsów API w obszarze roboczym.

  • Opis interfejsów API z tagami na poziomie obszaru roboczego.

  • Zdefiniuj nazwane wartości, fragmenty zasad i schematy na potrzeby weryfikacji żądań i odpowiedzi do użycia w zasadach o zakresie obszaru roboczego.

Uwaga

W obszarze roboczym zakresy zasad są następujące: Wszystkie interfejsy API (usługa) Wszystkie interfejsy API (obszar roboczy) >> Operacja interfejsu API produktu >>

Użytkownicy i grupy

  • Organizowanie użytkowników (z poziomu usługi) na grupy w obszarze roboczym.

Produkty i subskrypcje

  • Publikowanie interfejsów API za pomocą produktów. Interfejsy API w obszarze roboczym mogą być częścią produktu na poziomie obszaru roboczego. Widoczność można skonfigurować na podstawie członkostwa użytkowników na poziomie obszaru roboczego lub grupy poziomu usług.

  • Zarządzanie dostępem do interfejsów API za pomocą subskrypcji. Subskrypcje żądane do interfejsu API lub produktu w obszarze roboczym są tworzone w tym obszarze roboczym.

  • Publikowanie interfejsów API i produktów za pomocą portalu dla deweloperów.

  • Zarządzaj administracyjnymi powiadomieniami e-mail dotyczącymi zasobów w obszarze roboczym.

Role RBAC

Kontrola dostępu oparta na rolach platformy Azure służy do konfigurowania uprawnień współpracowników obszaru roboczego do odczytywania i edytowania jednostek w obszarze roboczym. Aby uzyskać listę ról, 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).

Członkowie obszaru roboczego muszą mieć przypisaną zarówno rolę o zakresie usługi, jak i rolę o zakresie obszaru roboczego lub przyznane równoważne uprawnienia przy użyciu ról niestandardowych. Rola o zakresie usługi umożliwia odwoływanie się do niektórych zasobów na poziomie usługi z zasobów na poziomie obszaru roboczego. Na przykład organizuj użytkownika w grupie na poziomie obszaru roboczego, aby kontrolować interfejs API i widoczność produktu.

Uwaga

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

Obszary robocze i inne funkcje usługi API Management

  • Funkcje infrastruktury — funkcje infrastruktury platformy API Management są zarządzane tylko na poziomie usługi, a nie na poziomie obszaru roboczego. Do tych funkcji należą:

    • Łączność z siecią prywatną

    • Bramy interfejsu API, w tym skalowanie, lokalizacje i bramy hostowane samodzielnie

  • Odwołania do zasobów — zasoby w obszarze roboczym mogą odwoływać się do innych zasobów w obszarze roboczym i użytkowników z poziomu usługi. Nie mogą odwoływać się do zasobów z innego obszaru roboczego.

    Ze względów bezpieczeństwa nie można odwoływać się do zasobów na poziomie usługi z zasad na poziomie obszaru roboczego (na przykład nazwanych wartości) lub według nazw zasobów, takich jak backend-id w zasadach set-backend-service .

  • Portal dla deweloperów — obszary robocze są koncepcją administracyjną i nie są udostępniane użytkownikom portalu deweloperów, w tym za pośrednictwem interfejsu użytkownika portalu deweloperów i podstawowego interfejsu API. Interfejsy API i produkty można jednak publikować z obszaru roboczego do portalu deweloperów. W związku z tym każdy zasób używany przez portal dla deweloperów (na przykład interfejs API, produkt, tag lub subskrypcja) musi mieć unikatową nazwę zasobu platformy Azure w usłudze. Nie można mieć żadnych zasobów tego samego typu i o tej samej nazwie zasobu platformy Azure w tym samym obszarze roboczym, w innych obszarach roboczych lub na poziomie usługi.

  • Usuwanie obszaru roboczego — usunięcie obszaru roboczego powoduje usunięcie wszystkich zasobów podrzędnych (interfejsów API, produktów itd.).

Ograniczenia wersji zapoznawczej

Następujące zasoby nie są obecnie obsługiwane w obszarach roboczych:

  • Serwery autoryzacji (dostawcy poświadczeń w menedżerze poświadczeń)

  • Autoryzacje (połączenia z dostawcami poświadczeń w menedżerze poświadczeń)

  • Zaplecza

  • Certyfikaty klienta

  • Bieżące narzędzia DevOps dla usługi API Management

  • Diagnostyka

  • Rejestratory

  • Syntetyczne interfejsy API graphQL

  • Tożsamość zarządzana przypisana przez użytkownika

W związku z tym następujące przykładowe scenariusze nie są obecnie obsługiwane w obszarach roboczych:

  • Monitorowanie interfejsów API przy użyciu konfiguracji specyficznej dla obszaru roboczego

  • Zarządzanie zapleczami interfejsu API i importowanie interfejsów API z usług platformy Azure

  • Weryfikowanie certyfikatów klienta

  • Korzystanie z funkcji menedżera poświadczeń (dawniej nazywanych autoryzacjami)

  • Określanie informacji o serwerze autoryzacji interfejsu API (na przykład w portalu dla deweloperów)

  • Publikowanie interfejsów API obszaru roboczego w bramach hostowanych samodzielnie

Ważne

Wszystkie zasoby w usłudze API Management muszą mieć unikatowe nazwy, nawet jeśli znajdują się w różnych obszarach roboczych.