Een werkruimte maken en beheren in Azure API Management
VAN TOEPASSING OP: Premium
Stel een werkruimte in om een API-team in staat te stellen hun eigen API's te beheren en te productiseren, terwijl het API-platformteam de hulpprogramma's biedt om het API Management-platform te observeren, te beheren en te onderhouden. Nadat u een werkruimte hebt gemaakt en machtigingen hebt toegewezen, kunnen werkruimtemedewerkers hun eigen API's, producten, abonnementen en gerelateerde resources maken en beheren.
Notitie
- De nieuwste werkruimtefuncties worden ondersteund in API Management REST API versie 2023-09-01-preview of hoger.
- Zie prijzen voor API Management voor prijsoverwegingen.
Volg de stappen in dit artikel om:
- Een API Management-werkruimte en een werkruimtegateway maken met behulp van Azure Portal
- De werkruimtegateway in een virtueel Azure-netwerk optioneel isoleren
- Machtigingen toewijzen aan de werkruimte
Notitie
- Het maken van een werkruimtegateway is momenteel een langdurige bewerking die maximaal 3 uur of langer kan duren.
- We introduceren de mogelijkheid om meerdere werkruimten te koppelen aan een werkruimtegateway, zodat organisaties API's met werkruimten tegen lagere kosten kunnen beheren. Deze functie wordt vanaf december 2024 geïmplementeerd en is mogelijk niet beschikbaar voor alle in aanmerking komende services vóór januari. Meer informatie
Vereisten
- Een API Management-exemplaar. Als dat nodig is, maakt u er een in een ondersteunde laag.
- De rol Eigenaar of Inzender voor de resourcegroep waarin het API Management-exemplaar wordt geïmplementeerd of gelijkwaardige machtigingen voor het maken van resources in de resourcegroep.
- (Optioneel) Een bestaand of nieuw virtueel Azure-netwerk en subnet om het binnenkomende en uitgaande verkeer van de werkruimtegateway te isoleren. Zie Netwerkresourcevereisten voor werkruimtegateways voor configuratieopties en -vereisten.
Een werkruimte maken - portal
Meld u aan bij Azure Portal en ga naar uw API Management-exemplaar.
Selecteer Werkruimten>+ Toevoegen in het linkermenu onder API's.
Voer op het tabblad Basisinformatie een beschrijvende weergavenaam, resourcenaam en optionele beschrijving voor de werkruimte in. Selecteer Volgende.
Configureer op het tabblad Gateway instellingen voor de werkruimtegateway:
Voer in Gatewaygegevens een gatewaynaam in en selecteer het aantal schaaleenheden. De gatewaykosten zijn gebaseerd op het aantal eenheden dat u selecteert. Zie prijzen voor API Management voor meer informatie.
Selecteer in Netwerk een netwerkconfiguratie voor uw werkruimtegateway.
Belangrijk
Plan de netwerkconfiguratie van uw werkruimte zorgvuldig. U kunt de netwerkconfiguratie niet wijzigen nadat u de werkruimte hebt gemaakt.
Als u een netwerkconfiguratie selecteert die privé-binnenkomende of privé-uitgaande netwerktoegang bevat, selecteert u een virtueel netwerk en subnet om de werkruimtegateway te isoleren of maakt u een nieuwe. Zie Netwerkresourcevereisten voor werkruimtegateways voor netwerkvereisten.
Selecteer Volgende. Nadat de validatie is voltooid, selecteert u Maken.
Het kan enkele minuten tot enkele uren duren om de werkruimte, werkruimtegateway en gerelateerde resources te maken. Als u de voortgang van de implementatie in Azure Portal wilt bijhouden, gaat u naar de resourcegroep van de gateway. Selecteer In het linkermenu onder Instellingen de optie Implementaties.
Nadat de implementatie is voltooid, wordt de nieuwe werkruimte weergegeven in de lijst op de pagina Werkruimten . Selecteer de werkruimte om de instellingen en resources te beheren.
Notitie
- Als u de hostnaam van de gatewayruntime en andere gatewaygegevens wilt weergeven, selecteert u de werkruimte in de portal. Selecteer gateways onder Implementatie en infrastructuur en selecteer de naam van de gateway van de werkruimte.
- Terwijl de werkruimtegateway wordt gemaakt, slagen runtime-aanroepen naar de API's van de werkruimte niet.
Gebruikers toewijzen aan werkruimte - portal
Nadat u een werkruimte hebt gemaakt, wijst u machtigingen toe aan gebruikers om de resources van de werkruimte te beheren. Aan elke werkruimtegebruiker moet zowel een RBAC-rol met servicebereik als een RBAC-rol met werkruimtebereik worden toegewezen, of moet een gelijkwaardige machtiging worden verleend met behulp van aangepaste rollen.
Als u de werkruimtegateway wilt beheren, wordt u aangeraden ook werkruimtegebruikers een RBAC-rol toe te wijzen die is toegewezen aan de werkruimtegateway.
Notitie
Voor eenvoudiger beheer stelt u Microsoft Entra-groepen in om werkruimtemachtigingen toe te wijzen aan meerdere gebruikers.
- Zie Op rollen gebaseerd toegangsbeheer gebruiken in API Management voor een lijst met ingebouwde werkruimterollen.
- Zie Azure-rollen toewijzen met behulp van de portal voor stappen voor het toewijzen van een rol.
Een rol in servicebereik toewijzen
Meld u aan bij Azure Portal en ga naar uw API Management-exemplaar.
Selecteer in het linkermenu Toegangsbeheer (IAM)>+ Toevoegen.
Wijs een van de volgende servicerollen toe aan elk lid van de werkruimte:
- API-ontwikkelaar voor API Management-servicewerkruimte
- API-productbeheer voor API Management-servicewerkruimten
Een rol binnen het bereik van een werkruimte toewijzen
Selecteer in het menu voor uw API Management-exemplaar onder API's de> naam van de werkruimte die u hebt gemaakt.
Selecteer Toegangsbeheer (IAM)>+ Toevoegen in het venster Werkruimte.
Wijs een van de volgende rollen met werkruimtebereik toe aan de leden van de werkruimte, zodat ze werkruimte-API's en andere resources kunnen beheren.
- Api Management-werkruimtelezer
- Inzender voor API Management-werkruimte
- API-ontwikkelaar voor API Management-werkruimte
- API Management Workspace API Product Manager
Een rol in gatewaybereik toewijzen
Meld u aan bij Azure Portal en ga naar uw API Management-exemplaar.
Selecteer in het linkermenu onder API's de> naam van uw werkruimte.
Selecteer Gateways in het linkermenu van de werkruimte en selecteer de werkruimtegateway.
Selecteer in het linkermenu Toegangsbeheer (IAM)>+ Toevoegen.
Wijs een van de volgende rollen toe aan elk lid van de werkruimte. U wordt ten minste aangeraden de rol Lezer toe te wijzen om de instellingen van de gateway weer te geven. Eigenaren en inzenders kunnen de instellingen van de gateway beheren, waaronder het schalen van de gateway.
- Eigenaar
- Inzender
- Lezer
Aan de slag met uw werkruimte
Afhankelijk van hun rol in de werkruimte hebben gebruikers mogelijk machtigingen om API's, producten, abonnementen en andere resources te maken, of hebben ze mogelijk alleen-lezentoegang tot sommige of alle resources.
Zie de volgende richtlijnen om aan de slag te gaan met het beheren, beveiligen en publiceren van API's in een werkruimte.