Skapa och hantera en arbetsyta i Azure API Management

GÄLLER FÖR: Basic v2 | Standard v2 | Premium | Premium v2

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.

Följ stegen i den här artikeln för att:

• Skapa en API Management-arbetsyta som är associerad med instansens standardhanterade gateway eller associerad med en ny eller befintlig arbetsytegateway.
• Du kan välja att isolera en arbetsytegateway i ett virtuellt nätverk i Azure.
• Tilldela behörigheter till arbetsytan.

Prerequisites

• En API Management-instans. Om du behöver en skapar du den 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 undernät i ett nytt eller befintligt virtuellt Azure-nätverk för att isolera den inkommande och utgående trafiken till och från en arbetsytegateway. Konfigurationsalternativ och krav finns i Nätverksresurskrav för arbetsytegatewayer.
• (Valfritt, för att associera den standardhanterade gatewayen med en arbetsyta) En REST-klient för att anropa API Managements REST-API.

Skapa en arbetsyta och koppla standardgatewayen - REST API

Du kan skapa en arbetsyta som dirigerar API-trafik via tjänstens standardhanterade gateway i stället för till en arbetsytegateway. Det här alternativet undviker den extra kostnaden och komplexiteten för en separat gatewayresurs. API-trafik dirigerar via tjänstens standardvärdnamn (till exempel <service-name>.azure-api.net).

Använd arbetsytan – Skapa eller uppdatera REST API för att skapa en arbetsyta.

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} med ditt Azure-prenumerations-ID
• {resourceGroupName} med resursgruppens namn på din API Management-instans
• {serviceName} med namnet på din API Management-instans
• {workspaceId} med en unik arbetsyteidentifierare (alfanumeriskt, bindestreck tillåtna)

Ett lyckat svar returnerar HTTP 201 Created med arbetsyteresursen. Som standard dirigerar arbetsytan API-trafik via tjänstens standardvärdnamn.

När arbetsytan har skapats fortsätter du till Tilldela användare till arbetsytan – portalen för att konfigurera åtkomstbehörigheter.

Skapa en arbetsyta och koppla en gateway för arbetsytan – portalen

1. Logga in på Azure Portal och gå till din API Management-instans.

2. I den vänstra menyn går du till API:er och väljer Arbetsytor>+ Lägg till.

3. På fliken Grundläggande anger du ett beskrivande visningsnamn, resursnamn och valfri beskrivning för arbetsytan. Välj Nästa.

4. På fliken Gateway konfigurerar du inställningar för arbetsytegatewayen.

   

   • Välj Skapa ny för att skapa en ny arbetsytegateway eller välj Använd befintlig för att associera arbetsytan med en befintlig gateway som har andra arbetsytor distribuerade på den.

   • Om du väljer att skapa en ny gateway:

     • I Gatewayinformation anger du ett nytt gatewaynamn och väljer antalet skalningsenheter. Gatewaykostnaderna baseras på antalet enheter. Mer information finns i PRISSÄTTNING FÖR API Management.

     • I Nätverk väljer du en nätverkskonfiguration för din arbetsytegateway.

       Important

       Planera din arbetsytas nätverkskonfiguration noggrant. Du kan inte ändra nätverkskonfigurationen när du har skapat arbetsytan.

     • Om du väljer antingen Inkommande offentlig åtkomst, utgående privat åtkomst (integrering av virtuellt nätverk) eller Inkommande privat åtkomst, utgående privat åtkomst (virtuell nätverksinmatning), 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.

5. Välj Nästa. När valideringen är klar väljer du Skapa.

   Note

   Om en ny arbetsytegateway väljs, kan det ta upp till flera timmar att slutföra skapandet. 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.

Tilldela användare till en arbetsyta – 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.

Om arbetsytan använder en resurs för arbetsytegatewayen tilldelar du även arbetsyteanvändare en Azure RBAC-roll som är begränsad till arbetsytegatewayen.

• 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 roll med tjänstomfattning

1. Logga in på Azure Portal och gå till din API Management-instans.

2. I den vänstra menyn väljer du Åtkomstkontroll (IAM)>+ Lägg till.

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

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

2. I fönstret Arbetsyta väljer du Åtkomstkontroll (IAM)>+ Lägg till.

3. 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 Läsare för Arbetsyta
   • Api Management Workspace-deltagare
   • API Management Workspace API Developer
   • API Management Workspace API Product Manager

Tilldela en gateway-avgränsad roll

1. Logga in på Azure Portal och gå till din API Management-instans.

2. I den vänstra menyn, under API:er, väljer du Arbetsytor> namnet på din arbetsyta.

3. På arbetsytans vänstra meny väljer du Gateways och väljer arbetsytegatewayen.

4. I den vänstra menyn väljer du Åtkomstkontroll (IAM)>+ Lägg till.

5. Tilldela en av följande roller till varje medlem i arbetsytan. Tilldela minst rollen Läsare för att visa gatewayens inställningar. Ägare och deltagare kan hantera gatewayens inställningar, inklusive skalning av gatewayen.

   • Owner
   • Contributor
   • Reader

Aktivera diagnostikinställningar för övervakning av API:er för arbetsytor

Konfigurera inställningar för att samla in Azure Monitor loggar för arbetsytan och skicka dem till en Log Analytics arbetsyta. Arbetsyteteamet kan övervaka sina egna API:er medan API-plattformsteamet kan komma åt centraliserade loggar för API Management-instansen. Se följande diagram:

För att samla in Azure Monitor loggar för arbetsytan behöver du diagnostikinställningar på både tjänst- och arbetsytenivå:

1. Aktivera först en diagnostikinställning på tjänstnivå för insamling av API Management-gatewayloggar, om en inställning inte redan är aktiverad. Skicka loggar till en Log Analytics-arbetsyta. Mer information finns i Konfigurera diagnostikinställningar för API Management.

2. Aktivera sedan en diagnostikinställning på arbetsyta för att skicka API Management-gatewayloggar till samma Log Analytics arbetsyta. Den här inställningen samlar in loggar för alla arbetsytegatewayer som är associerade med arbetsytan.

   Important

   En diagnostikinställning på tjänstnivå konfigurerar loggning över API Management-instansen, inklusive arbetsytor som har en diagnostikinställning på arbetsytenivå aktiverad. Om du inte aktiverar en diagnostikinställning på arbetsytan samlas inte arbetsytans gatewayloggar in eller aggregeras till Log Analytics.

   Note

   Som standard har medlemmar i arbetsyteteamet som tilldelats de inbyggda RBAC-rollerna för arbetsytan inte behörighet att redigera diagnostikinställningar på en arbetsyta. API-plattformsteamet har dessa behörigheter.

Så här konfigurerar du en diagnostikinställning för arbetsytan för insamling av gatewayloggar på arbetsytenivå:

1. Logga in på Azure Portal och gå till din API Management-instans.

2. I den vänstra menyn, under API:er, väljer du Arbetsytor> namnet på din arbetsyta.

3. I den vänstra menyn på arbetsytorna går du till Övervakning och väljer Diagnostikinställningar>+ Lägg till diagnostikinställning.

4. I Diagnostikinställning anger eller väljer du information för inställningen:

   1. Namn på diagnostikinställning: Ange ett beskrivande namn.
   2. Kategorigrupper: Om du vill kan du göra ett val för ditt scenario.
   3. Under Kategorier väljer du Loggar relaterade till ApiManagement Gateway för att samla in gatewayloggar för API:er på den här arbetsytan.
   4. Under Målinformation väljer du att skicka loggar till samma Azure Log Analytics-arbetsyta som anges i diagnostikinställningen på tjänstnivå och i andra diagnostikinställningar på arbetsytan.
   5. Välj Spara.

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 dessa resurser.

Information om hur du kommer igång med att hantera, skydda och publicera API:er på en arbetsyta finns i följande vägledning.

Relaterat innehåll

• Läs mer om arbetsytor i Azure API Management.
• Använda ett virtuellt nätverk för att skydda inkommande eller utgående trafik för Azure API Management