Direct beheer API Management REST API

  • Artikel

Azure API Management biedt een REST API voor direct beheer voor het uitvoeren van bewerkingen op geselecteerde entiteiten, zoals gebruikers, groepen, producten en abonnementen. De API voor direct beheer kan bepaalde limieten van de op Azure Resource Manager gebaseerde API omzeilen, zoals aanvraagbeperking.

Belangrijk

In deze sectie wordt beschreven hoe u toegang instellen tot de REST API voor direct beheer API Management. Deze API heeft een ander verificatiemechanisme dan Azure Resource Manager en gebruikt een andere basis-URL.

Toegang tot de REST API voor direct beheer inschakelen

Toegang tot de direct management API Management REST API moet worden verleend voordat aanroepen kunnen worden uitgevoerd.

  1. Navigeer naar uw Azure API Management-exemplaar in de Azure Portal.

  2. Selecteer Beheer-API in de sectie Implementatie en infrastructuur van het menu aan de linkerkant.

    Selecteer Management-API in de Azure Portal

  3. Selecteer in API Management REST API inschakelen de optie Ja.

    Belangrijk

    Als Enable API Management REST API niet is geselecteerd, mislukken aanroepen naar de REST API voor dat service-exemplaar.

    API Management-API inschakelen in de Azure Portal

Standaardmediatype

Het standaardmediatype voor aanvragen en antwoorden is application/json. Waar vermeld, ondersteunen sommige bewerkingen andere inhoudstypen. Als er geen extra inhoudstype wordt vermeld voor een specifieke bewerking, is application/jsonhet mediatype .

Verificatie

Elke aanvraag voor de API Management REST API moet vergezeld gaan van een Authorization header met een geldig gedeeld toegangstoken, zoals wordt weergegeven in het volgende voorbeeld.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Dit toegangstoken kan programmatisch worden gegenereerd of vanuit de API Management portal voor uitgevers. Zie Handmatig een toegangstoken maken en Programmatisch een toegangstoken maken voor instructies over het genereren en ophalen van het toegangstoken.

Basis-URL

De basis-URL van de API Management REST API voor direct beheer voldoet aan de volgende sjabloon.

https://{servicename}.management.azure-api.net

Deze sjabloon bevat de volgende parameter.

  • {serviceName} is de servicenaam zoals deze is opgegeven tijdens het maken van de service, bijvoorbeeld https://contosoapi.management.azure-api.net.

Alle URL's die door de API Management REST API worden geretourneerd, zijn relatief ten opzichte van deze basis-URL en alle aanvragen voor de REST API moeten deze basis-URL-sjabloon gebruiken.

Versiequeryparameter

Alle bewerkingen verwachten een api-version queryparameter met een waarde in de indeling van YYYY-MM-DD, bijvoorbeeld 2021-08-01.

Notitie

Tijdens een previewperiode voor een API Management REST API -preview toegevoegd aan de versiequeryparameter, bijvoorbeeld 2021-04-01-preview.

Als deze queryparameter niet wordt doorgegeven in de queryreeks van een aanvraag, retourneert de server een statuscode van 400 Bad Request. Zie API Management REST API-referentie voor een lijst met ondersteunde versies.

Volgende stappen