API Management RESTAPI Management REST

Azure API Management には、ユーザー、グループ、製品、サブスクリプションなど、選択したエンティティに対して操作を実行するための REST API が用意されています。Azure API Management provides a REST API for performing operations on selected entities, such as users, groups, products, and subscriptions. このリファレンスには、API Management REST API を扱ううえでのガイドのほか、利用できる各操作の具体的なリファレンス情報がエンティティ別に記載されています。This reference provides a guide for working with the API Management REST API, as well as specific reference information for each available operation, grouped by entity.

重要

このセクションでは、Azure リソース プロバイダーとは異なる認証メカニズムを使用して API 管理 REST API にアクセスする方法について説明します。This section describes how to access the API Management REST API using a different authentication mechanism than Azure Resource provider. 詳細については、次の「前提条件」セクションを参照してください。For more information, see the following Prerequisites section.

REST API の操作の詳細については、API 管理 .NET REST API サンプルと Azure API 管理 REST API の概要に関するビデオを参照してください。For more information about working with the REST API, see the API Management .NET REST API Sample and the Getting Started with Azure API Management REST API video.

このトピックの内容In this topic

REST API へのアクセスを有効にするEnable access to the REST API

API 管理 REST API を正常に呼び出すには、事前に REST API へのアクセスが許可されている必要があります。Access to the API Management REST API must be granted before calls can be successfully made.

  1. Azure ポータルにサインインし、API 管理サービス インスタンスに移動します。Sign into the Azure Portal and navigate to your API Management service instance.

  2. メニューから [管理 API] をクリックします。Click on Management API from the menu.
    API 管理 [REST を有効にする] メニューAPI Management Enable REST menu

  3. [API 管理 REST API を有効にする] チェックボックスを選択します。Select the Enable API Management REST API checkbox.
    API 管理 [REST を有効にする] チェック ボックスAPI Management Enable REST checkbox

重要

[API Management REST API を有効にする] チェック ボックスがオフの場合、このサービス インスタンスの REST API の呼び出しは失敗します。If the Enable API Management REST API checkbox is not checked, calls made to the REST API for that service instance will fail.

既定のメディアの種類Default media type

要求および応答の既定のメディアの種類は application/json です。The default media type for requests and responses is application/json. 一部の操作では他のコンテンツの種類がサポートされますが、その場合はその旨の説明があります。Where noted, some operations support other content types. 特定の操作に対して追加のコンテンツの種類が言及されていない場合、メディアの種類は application/json になります。If no additional content type is mentioned for a specific operation, then the media type is application/json.

[認証]Authentication

次の例に示すように、API Management REST Authorization API への各要求には、有効な共有アクセス トークンを含むヘッダーが付属している必要があります。Each request to the API Management REST API must be accompanied by an Authorization header containing a valid shared access token, as shown in the following example.

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

このアクセス トークンは、プログラムで生成することも、API Management パブリッシャー ポータル内で生成することもできます。This access token can be generated programmatically or from within the API Management publisher portal. アクセス トークンの生成と取得の手順については、「アクセストークンを手動で作成するには」および「アクセス トークンをプログラムで作成するには」を参照してください。For instructions on generating and retrieving the access token, see To manually create an access token and To programmatically create an access token.

ベース URLBase URL

API 管理 REST API のベース URL は、次のテンプレートに準拠しています。The Base URL of the API Management REST API conforms to the following template.

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

このテンプレートには、次のパラメーターが含まれます。This template contains the following parameter.

  • {serviceName} は、サービスの作成時に指定されたサービス名です (たとえば、https://contosoapi.management.azure-api.net)。{serviceName} is the service name as it was specified during service creation, for example https://contosoapi.management.azure-api.net.

API 管理 REST API によって返されるすべての URL はこの基本 URL に関連しており、REST API へのすべての要求はこのベース URL テンプレートを使用する必要があります。All URLs returned by the API Management REST API are relative to this base URL, and all requests to the REST API must use this base URL template.

バージョン クエリ パラメーターVersion Query Parameter

すべての操作では、api-version 形式の値 (たとえば、YYYY-MM-DD) を持つ 2014-02-14 クエリ パラメーターが想定されます。All operations expect an api-version query parameter with a value in the format of YYYY-MM-DD, for example 2014-02-14.

注意

API Management のプレビュー期間中は、バージョン クエリ パラメーターに -preview が追加されます (2014-02-14-preview など)。During the preview period for API Management, -preview is appended to the version query parameter, for example 2014-02-14-preview.

要求のクエリ文字列でこのクエリ パラメーターが渡されない場合、サーバーは状態コード 400 Bad Request を返します。If this query parameter is not passed in the query string of a request, the server will return a status code of 400 Bad Request. サポートされているバージョンの一覧については、次のAPI 管理 REST API バージョン履歴セクションを参照してください。For a list of supported versions, see the following API Management REST API version history section.

次のステップNext steps