Direkte Verwaltung API Management REST-API

  • Artikel

Azure API Management bietet eine DIREKTE VERWALTUNGS-REST-API zum Ausführen von Vorgängen für ausgewählte Entitäten, z. B. Benutzer, Gruppen, Produkte und Abonnements. Die API für die direkte Verwaltung kann bestimmte Grenzwerte der azure Resource Manager-basierten API umgehen, z. B. die Anforderungsdrosselung.

Wichtig

In diesem Abschnitt wird beschrieben, wie Sie auf die direkte Verwaltung API Management REST-API zugreifen. Diese API verfügt über einen anderen Authentifizierungsmechanismus als Azure Resource Manager und verwendet eine andere Basis-URL.

Aktivieren des Zugriffs auf die REST-API für die direkte Verwaltung

Der Zugriff auf die direkte Verwaltung API Management REST-API muss gewährt werden, bevor Aufrufe erfolgreich ausgeführt werden können.

  1. Navigieren Sie im Azure-Portal zu Ihrer Azure API Management-Instanz.

  2. Wählen Sie im Menü auf der linken Seite im Abschnitt Bereitstellung + Infrastruktur die Option Verwaltungs-API aus.

    Wählen Sie im Azure-Portal Verwaltungs-API aus.

  3. Wählen Sie unter API Management REST-API aktivieren die Option Ja aus.

    Wichtig

    Wenn API Management REST-API aktivieren nicht ausgewählt ist, schlagen Aufrufe der REST-API für diesen Dienst instance fehl.

    Aktivieren der API Management-API im Azure-Portal

Standardmedientyp

Der Standardmedientyp für Anforderungen und Antworten ist application/json. Wenn dies angegeben ist, unterstützen bestimmte Operationen auch andere Inhaltstypen. Wenn kein zusätzlicher Inhaltstyp für eine bestimmte Operation angegeben ist, dann ist der Inhaltstyp application/json.

Authentifizierung

Jede Anforderung an die API Management REST-API muss von einem Authorization Header begleitet werden, der ein gültiges freigegebenes Zugriffstoken enthält, wie im folgenden Beispiel gezeigt.

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

Das Zugriffstoken kann entweder programmgesteuert oder über das API Management-Herausgeberportal generiert werden. Anweisungen zum Generieren und Abrufen des Zugriffstokens finden Sie unter So erstellen Sie manuell ein Zugriffstoken und So erstellen Sie programmgesteuert ein Zugriffstoken.

Basis-URL

Die Basis-URL der direkten Verwaltung API Management REST-API entspricht der folgenden Vorlage.

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

Diese Vorlage enthält die folgenden Parameter.

  • {serviceName} ist der Dienstname, der während der Diensterstellung angegeben wurde, z. B. https://contosoapi.management.azure-api.net.

Alle URLs, die von der API Management REST-API zurückgegeben werden, sind relativ zu dieser Basis-URL, und alle Anforderungen an die REST-API müssen diese Basis-URL-Vorlage verwenden.

Versionsabfrageparameter

Alle Operationen erwarten einen api-version-Abfrageparameter mit einem Wert im Format YYYY-MM-DD, z. B. 2021-08-01.

Hinweis

Während eines Vorschauzeitraums für eine API Management REST-API -preview wird an den Versionsabfrageparameter angefügt, z. B2021-04-01-preview. .

Wenn dieser Abfrageparameter nicht in der Abfragezeichenfolge einer Anforderung übergeben wird, gibt der Server den status Code von 400 Bad Requestzurück. Eine Liste der unterstützten Versionen finden Sie unter API Management REST-API-Referenz.

Nächste Schritte