REST API API Management直接管理
Azure API Management には、選択したエンティティ (ユーザー、グループ、製品、サブスクリプションなど) に対して操作を実行するための直接管理 REST API が用意されています。 ダイレクト管理 API は、要求の調整など、Azure Resource Manager ベースの API の特定の制限をバイパスできます。
重要
このセクションでは、REST API API Management直接管理にアクセスする方法について説明します。 この API は、Azure Resource Managerとは異なる認証メカニズムを備え、ベース URL が異なります。
ダイレクト管理 REST API へのアクセスを有効にする
REST API API Management直接管理へのアクセスは、呼び出しを正常に行う前に付与する必要があります。
Azure portal で Azure API Management インスタンスに移動します。
左側のメニューの [デプロイとインフラストラクチャ] セクションから [管理 API] を選択します。
![Azure portalで [管理 API] を選択します](media/apim-management-api-enable-menu.png)
[REST API API Management有効にする] で、[はい] を選択します。
重要
[REST API API Management有効にする] が選択されていない場合、そのサービス インスタンスに対して REST API に対して行われた呼び出しは失敗します。
既定のメディアの種類
要求および応答の既定のメディアの種類は application/json です。 一部の操作では他のコンテンツの種類がサポートされますが、その場合はその旨の説明があります。 特定の操作に対して追加のコンテンツの種類が言及されていない場合、メディアの種類は application/json になります。
認証
次の例に示すように、API Management REST API への各要求には、有効な共有アクセス トークンを含むヘッダーが添付Authorizationされている必要があります。
Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==
このアクセス トークンは、プログラムで生成することも、API Management パブリッシャー ポータル内で生成することもできます。 アクセス トークンを生成および取得する手順については、「アクセス トークンを手動で作成するには」および「アクセス トークンをプログラムで作成するには」を参照してください。
ベース URL
REST API API Management直接管理のベース URL は、次のテンプレートに準拠しています。
https://{servicename}.management.azure-api.net
このテンプレートには、次のパラメーターが含まれます。
-
{serviceName}は、サービスの作成時に指定されたサービス名です (たとえば、https://contosoapi.management.azure-api.net)。
API Management REST API によって返されるすべての URL は、このベース URL に対して相対的であり、REST API に対するすべての要求でこの基本 URL テンプレートを使用する必要があります。
バージョン クエリ パラメーター
すべての操作では、api-version 形式の値 (たとえば、YYYY-MM-DD) を持つ 2021-08-01 クエリ パラメーターが想定されます。
注意
API Management REST API のプレビュー期間中に、 -preview がバージョン クエリ パラメーター (例: 2021-04-01-preview) に追加されます。
このクエリ パラメーターが要求のクエリ文字列で渡されない場合、サーバーは の状態コード 400 Bad Requestを返します。 サポートされているバージョンの一覧については、「REST API リファレンスAPI Management参照」を参照してください。
次の手順
- 認証の詳細については、こちらを参照してください。