Skapa och hantera en arbetsyta i Azure API Management
GÄLLER FÖR: Premium
Konfigurera en arbetsyta för att göra det möjligt för ett API-team att hantera och produktisera sina egna API:er, samtidigt som API-plattformsteamet får verktyg för att observera, styra och underhålla API Management-plattformen. När du har skapat en arbetsyta och tilldelat behörigheter kan arbetsytemedarbetarna skapa och hantera sina egna API:er, produkter, prenumerationer och relaterade resurser.
Kommentar
- De senaste funktionerna för arbetsytor stöds i API Management REST API version 2023-09-01-preview eller senare.
- Prisöverväganden finns i PRISSÄTTNING FÖR API Management.
Följ stegen i den här artikeln för att:
- Skapa en API Management-arbetsyta och en arbetsytegateway med hjälp av Azure Portal
- Du kan också isolera arbetsytegatewayen i ett virtuellt Azure-nätverk
- Tilldela behörigheter till arbetsytan
Kommentar
- Att skapa en arbetsytegateway är för närvarande en tidskrävande åtgärd som kan ta upp till 3 timmar eller mer att slutföra.
- Vi introducerar möjligheten att associera flera arbetsytor med en arbetsytegateway, vilket hjälper organisationer att hantera API:er med arbetsytor till en lägre kostnad. Den här funktionen lanseras från och med december 2024 och den kanske inte är tillgänglig för alla berättigade tjänster före januari. Läs mer
Förutsättningar
- En API Management-instans. Om du behöver det skapar du en på en nivå som stöds.
- Rollen Ägare eller Deltagare i resursgruppen där API Management-instansen distribueras eller motsvarande behörigheter för att skapa resurser i resursgruppen.
- (Valfritt) Ett befintligt eller nytt virtuellt Azure-nätverk och undernät för att isolera arbetsytegatewayens inkommande och utgående trafik. Konfigurationsalternativ och krav finns i Nätverksresurskrav för arbetsytegatewayer.
Skapa en arbetsyta – portalen
Logga in på Azure Portal och gå till din API Management-instans.
I den vänstra menyn går du till API:er och väljer Arbetsytor>+ Lägg till.
På fliken Grundläggande anger du ett beskrivande visningsnamn, resursnamn och valfri beskrivning för arbetsytan. Välj Nästa.
På fliken Gateway konfigurerar du inställningar för arbetsytegatewayen:
I Gatewayinformation anger du ett gatewaynamn och väljer antalet skalningsenheter. Gatewaykostnaderna baseras på antalet enheter som du väljer. Mer information finns i PRISSÄTTNING FÖR API Management.
I Nätverk väljer du en nätverkskonfiguration för din arbetsytegateway.
Viktigt!
Planera din arbetsytas nätverkskonfiguration noggrant. Du kan inte ändra nätverkskonfigurationen när du har skapat arbetsytan.
Om du väljer en nätverkskonfiguration som innehåller privat inkommande eller privat utgående nätverksåtkomst väljer du ett virtuellt nätverk och undernät för att isolera arbetsytegatewayen eller skapa en ny. Nätverkskrav finns i Nätverksresurskrav för arbetsytegatewayer.
Välj Nästa. När valideringen är klar väljer du Skapa.
Det kan ta från flera minuter till upp till flera timmar att skapa arbetsytan, arbetsytegatewayen och relaterade resurser. Om du vill spåra distributionens förlopp i Azure Portal går du till gatewayens resursgrupp. I den vänstra menyn går du till Inställningar och väljer Distributioner.
När distributionen är klar visas den nya arbetsytan i listan på sidan Arbetsytor . Välj arbetsytan för att hantera dess inställningar och resurser.
Kommentar
- Om du vill visa värdnamnet för gateway-körningen och annan gatewayinformation väljer du arbetsytan i portalen. Under Distribution + infrastruktur väljer du Gatewayer och väljer namnet på arbetsytans gateway.
- När arbetsytegatewayen skapas kommer körningsanrop till arbetsytans API:er inte att lyckas.
Tilldela användare till arbetsytan – portalen
När du har skapat en arbetsyta tilldelar du behörigheter till användare för att hantera arbetsytans resurser. Varje arbetsyteanvändare måste tilldelas både en RBAC-roll med tjänstomfattning och en RBAC-roll med arbetsytans omfattning eller beviljas motsvarande behörigheter med hjälp av anpassade roller.
För att hantera arbetsytegatewayen rekommenderar vi även att du tilldelar arbetsyteanvändare en RBAC-roll som tillhandahålls av Azure till arbetsytegatewayen.
Kommentar
För enklare hantering konfigurerar du Microsoft Entra-grupper för att tilldela arbetsytebehörigheter till flera användare.
- En lista över inbyggda arbetsyteroller finns i Använda rollbaserad åtkomstkontroll i API Management.
- Anvisningar för hur du tilldelar en roll finns i Tilldela Azure-roller med hjälp av portalen.
Tilldela en tjänstomfattningsroll
Logga in på Azure Portal och gå till din API Management-instans.
I den vänstra menyn väljer du Åtkomstkontroll (IAM)>+ Lägg till.
Tilldela någon av följande tjänstomfattande roller till varje medlem i arbetsytan:
- API Management Service Workspace API Developer
- API Management Service Workspace API Product Manager
Tilldela en roll med arbetsytans omfattning
På menyn för DIN API Management-instans går du till API:er och väljer Arbetsytor> namnet på den arbetsyta som du skapade.
I fönstret Arbetsyta väljer du Åtkomstkontroll (IAM)>+ Lägg till.
Tilldela någon av följande arbetsyteomfattande roller till medlemmarna i arbetsytan så att de kan hantera arbetsyte-API:er och andra resurser.
- API Management-arbetsyteläsare
- Api Management Workspace-deltagare
- API Management Workspace API Developer
- API Management Workspace API Product Manager
Tilldela en gateway-begränsad roll
Logga in på Azure Portal och gå till din API Management-instans.
I den vänstra menyn, under API:er, väljer du Arbetsytor> namnet på din arbetsyta.
På arbetsytans vänstra meny väljer du Gateways och väljer arbetsytegatewayen.
I den vänstra menyn väljer du Åtkomstkontroll (IAM)>+ Lägg till.
Tilldela en av följande roller till varje medlem i arbetsytan. Vi rekommenderar åtminstone att du tilldelar rollen Läsare för att visa gatewayens inställningar. Ägare och deltagare kan hantera gatewayens inställningar, inklusive skalning av gatewayen.
- Ägare
- Deltagare
- Läsare
Kom igång med din arbetsyta
Beroende på deras roll på arbetsytan kan användarna ha behörighet att skapa API:er, produkter, prenumerationer och andra resurser, eller så kan de ha skrivskyddad åtkomst till vissa eller alla av dem.
Information om hur du kommer igång med att hantera, skydda och publicera API:er på en arbetsyta finns i följande vägledning.