Apis - List By Service

API Management サービス インスタンスのすべての API を一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis?api-version=2019-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis?$filter={$filter}&$top={$top}&$skip={$skip}&tags={tags}&expandApiVersionSet={expandApiVersionSet}&api-version=2019-12-01

URI パラメーター

Name In Required Type Description
resourceGroupName
path True
  • string

リソース グループの名前。

serviceName
path True
  • string

API 管理サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント要求で使用される API のバージョン。

$filter
query
  • string

| フィールド | 使用法 | サポートされている演算子 | サポートされている機能 |
|-------------|-------------|-------------|-------------|
|名前 |フィルタ |ge, ル, eq, ネ, gt, lt |部分文字列、含む、で始まる、で終わる |
|表示名 |フィルタ |ge, ル, eq, ネ, gt, lt |部分文字列、含む、で始まる、で終わる |
|説明 |フィルタ |ge, ル, eq, ネ, gt, lt |部分文字列、含む、で始まる、で終わる |
|サービスUrl |フィルタ |ge, ル, eq, ネ, gt, lt |部分文字列、含む、で始まる、で終わる |
|パス |フィルタ |ge, ル, eq, ネ, gt, lt |部分文字列、含む、で始まる、で終わる |

$skip
query
  • integer
int32

スキップするレコードの数。

$top
query
  • integer
int32

返されるレコードの数。

expandApiVersionSet
query
  • boolean

応答に完全な ApiVersionSet リソースを含める

tags
query
  • string

応答にタグを含めます。

応答

Name Type Description
200 OK

Api のページ結果応答。

Other Status Codes

操作が失敗した理由を示すエラー応答です。

セキュリティ

azure_auth

Azure アクティブ ディレクトリ OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementListApis

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis?api-version=2019-12-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
      "type": "Microsoft.ApiManagement/service/apis",
      "name": "a1",
      "properties": {
        "displayName": "api1",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "api1",
        "protocols": [
          "https"
        ],
        "isCurrent": true,
        "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533",
      "type": "Microsoft.ApiManagement/service/apis",
      "name": "5a73933b8f27f7cc82a2d533",
      "properties": {
        "displayName": "api1",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "api1",
        "protocols": [
          "https"
        ],
        "isCurrent": true,
        "apiVersion": "v1",
        "apiVersionSetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api",
      "type": "Microsoft.ApiManagement/service/apis",
      "name": "echo-api",
      "properties": {
        "displayName": "Echo API",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "echo",
        "protocols": [
          "https"
        ],
        "isCurrent": true
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0",
      "type": "Microsoft.ApiManagement/service/apis",
      "name": "5a7390baa5816a110435aee0",
      "properties": {
        "displayName": "Swagger Petstore Extensive",
        "apiRevision": "1",
        "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
        "serviceUrl": "http://petstore.swagger.wordnik.com/api",
        "path": "vvv",
        "protocols": [
          "https"
        ],
        "isCurrent": true
      }
    }
  ],
  "nextLink": ""
}

定義

ApiCollection

ページ API リスト表現。

ApiContract

API の詳細。

ApiType

API の種類。

ApiVersionSetContractDetails

API バージョン・セットには、関連する API バージョンのセットに共通の構成が含まれています。

AuthenticationSettingsContract

API 認証設定。

ErrorFieldContract

エラー フィールド コントラクト。

ErrorResponse

エラー応答。

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

SubscriptionKeyParameterNamesContract

サブスクリプション キー パラメーター名の詳細。

ApiCollection

ページ API リスト表現。

Name Type Description
nextLink
  • string

次のページのリンクがある場合。

value

ページ値。

ApiContract

API の詳細。

Name Type Description
id
  • string

リソースの ID

name
  • string

リソース名。

properties.apiRevision
  • string

API のリビジョンについて説明します。 値が指定されていない場合、デフォルトのリビジョン 1 が作成されます。

properties.apiRevisionDescription
  • string

API リビジョンの説明。

properties.apiVersion
  • string

API がバージョン対応の場合、API のバージョン識別子を示します。

properties.apiVersionDescription
  • string

API バージョンの説明。

properties.apiVersionSet

バージョン セットの詳細

properties.apiVersionSetId
  • string

関連する ApiVersionSet のリソース識別子。

properties.authenticationSettings

この API に含まれる認証設定のコレクション。

properties.description
  • string

API の説明。 HTML 書式設定タグを含めることができます。

properties.displayName
  • string

API 名。 1 ~ 300 文字の長さである必要があります。

properties.isCurrent
  • boolean

API リビジョンが現在の API リビジョンであるかどうかを示します。

properties.isOnline
  • boolean

ゲートウェイ経由で API リビジョンにアクセスできるかどうかを示します。

properties.path
  • string

API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。

properties.protocols
  • string[]

この API の操作を呼び出すことができるプロトコルを記述します。

properties.serviceUrl
  • string

この API を実装するバックエンド サービスの絶対 URL。 2000 文字を超える長さにすることはできません。

properties.sourceApiId
  • string

ソース API の API 識別子。

properties.subscriptionKeyParameterNames

API が使用可能になるプロトコル。

properties.subscriptionRequired
  • boolean

API にアクセスするために API または製品サブスクリプションが必要かどうかを指定します。

properties.type

API の種類。

type
  • string

API 管理リソースのリソースの種類。

ApiType

API の種類。

Name Type Description
http
  • string
soap
  • string

ApiVersionSetContractDetails

API バージョン・セットには、関連する API バージョンのセットに共通の構成が含まれています。

Name Type Description
description
  • string

API バージョン セットの説明。

id
  • string

既存の API バージョン セットの識別子。 新しいバージョン セットを作成するには、この値を省略します。

name
  • string

API バージョン セットの表示名。

versionHeaderName
  • string

バージョン管理Scheme が に設定されている場合に API バージョンを示headerす HTTP ヘッダー パラメーターの名前。

versionQueryName
  • string

バージョン管理Scheme が に設定されている場合に API バージョンをquery示すクエリ パラメーターの名前。

versioningScheme enum:
  • Header
  • Query
  • Segment

HTTP 要求内の API バージョン識別情報の場所を決定する値。

AuthenticationSettingsContract

API 認証設定。

Name Type Description
oAuth2

OAuth2 認証設定

openid

OpenID 接続認証設定

ErrorFieldContract

エラー フィールド コントラクト。

Name Type Description
code
  • string

プロパティ レベルのエラー コード。

message
  • string

プロパティ レベルエラーの人間が判読できる表現。

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

検証エラーが発生した場合に、要求で送信される無効なフィールドのリスト。

error.message
  • string

エラーの人間が読み取り可能な表現。

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

Name Type Description
authorizationServerId
  • string

OAuth 承認サーバーの識別子。

scope
  • string

操作のスコープ。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

Name Type Description
bearerTokenSendingMethods
  • string[]

サーバーにトークンを送信する方法。

openidProviderId
  • string

OAuth 承認サーバーの識別子。

SubscriptionKeyParameterNamesContract

サブスクリプション キー パラメーター名の詳細。

Name Type Description
header
  • string

サブスクリプション キー ヘッダー名。

query
  • string

サブスクリプション キーのクエリ文字列パラメーター名。