Megosztás a következőn keresztül:

Közvetlen felügyeleti API Management REST API

  • Cikk

Az Azure API Management közvetlen felügyeleti REST API-t biztosít a kiválasztott entitásokon, például felhasználókon, csoportokon, termékeken és előfizetéseken végzett műveletek végrehajtásához. A közvetlen felügyeleti API megkerülheti az Azure Resource Manager-alapú API bizonyos korlátait, például a kérelmek szabályozását.

Fontos

Ez a szakasz a közvetlen felügyeleti API Management REST API elérését ismerteti. Ez az API más hitelesítési mechanizmussal rendelkezik, mint az Azure Resource Manager, és eltérő alap URL-címet használ.

Hozzáférés engedélyezése a közvetlen felügyeleti REST API-hoz

A hívások sikeres végrehajtása előtt hozzáférést kell biztosítani a közvetlen felügyeleti API Management REST API-hoz.

  1. Lépjen az Azure API Management-példányra a Azure Portal.

  2. A bal oldali menü Üzembe helyezés + infrastruktúra szakaszában válassza a Felügyeleti API lehetőséget.

    Válassza a Felügyeleti API lehetőséget a Azure Portal

  3. Az Enable API Management REST API (API Management REST API engedélyezése) területen válassza az Igen lehetőséget.

    Fontos

    Ha az Enable API Management REST API nincs kiválasztva, az adott szolgáltatáspéldány REST API-jára irányuló hívások sikertelenek lesznek.

    API Management API engedélyezése a Azure Portal

Alapértelmezett médiatípus

A kérések és válaszok alapértelmezett médiatípusa a következő application/json: . Ahol feljegyzettük, egyes műveletek más tartalomtípusokat is támogatnak. Ha egy adott művelethez nem szerepel további tartalomtípus, akkor az adathordozó típusa .application/json

Hitelesítés

A API Management REST API-nak küldött minden kéréshez egy Authorization érvényes közös hozzáférési jogkivonatot tartalmazó fejlécnek kell kísérnie, ahogyan az alábbi példában látható.

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

Ez a hozzáférési jogkivonat programozott módon vagy a API Management közzétevő portálján hozható létre. A hozzáférési jogkivonat létrehozásával és lekérésével kapcsolatos utasításokért lásd: Hozzáférési jogkivonat manuális létrehozása és Hozzáférési jogkivonat programozott módon történő létrehozása.

Kiindulási URL-cím

A közvetlen felügyeleti API Management REST API alap URL-címe megfelel az alábbi sablonnak.

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

Ez a sablon a következő paramétert tartalmazza.

  • {serviceName} A a szolgáltatásnév, ahogyan a szolgáltatás létrehozásakor meg volt adva, például https://contosoapi.management.azure-api.net: .

Az API Management REST API által visszaadott URL-címek ehhez az alap URL-címhez vannak viszonyítva, és a REST API-nak küldött összes kérésnek ezt az alap URL-sablont kell használnia.

Verzió lekérdezési paramétere

Minden művelet olyan api-version lekérdezési paramétert vár, amelynek a formátuma YYYY-MM-DD, például 2021-08-01: .

Megjegyzés

Egy API Management REST API -preview előzetes verziójának időszakában a rendszer hozzáfűzi a verzió lekérdezési paraméteréhez, például 2021-04-01-preview: .

Ha ezt a lekérdezési paramétert nem adja át egy kérés lekérdezési sztringjében, a kiszolgáló a következő állapotkódot 400 Bad Requestadja vissza: . A támogatott verziók listáját lásd: API Management REST API-referencia.

Következő lépések