Gateway Api - List By Service

サービス:

API Management

API バージョン:

2021-08-01

ゲートウェイに関連付けられている API のコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis?api-version=2021-08-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/apis?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01

URI パラメーター

名前	/	必須	型	説明
gatewayId	path	True	string	ゲートウェイ エンティティ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
resourceGroupName	path	True	string	リソース グループの名前。
serviceName	path	True	string	API Management サービスの名前。 正規表現パターン: ^[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	|フィールド |使用法 |サポートされている演算子 |サポートされている関数 | |-------------|-------------|-------------|-------------| |name |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
$skip	query		integer int32	スキップするレコードの数。
$top	query		integer int32	返されるレコードの数。

応答

名前	型	説明
200 OK	ApiCollection	応答本文には、ゲートウェイ内の Api エンティティのコレクションが含まれています。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

ApiManagementListGatewayApis

要求のサンプル

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for GatewayApi ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
     */
    /**
     * Sample code: ApiManagementListGatewayApis.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListGatewayApis(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.gatewayApis().listByService("rg1", "apimService1", "gw1", null, null, null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_gateway_apis.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.gateway_api.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
        gateway_id="gw1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
func ExampleGatewayAPIClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewGatewayAPIClient().NewListByServicePager("rg1", "apimService1", "gw1", &armapimanagement.GatewayAPIClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.APICollection = armapimanagement.APICollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.APIContract{
		// 		{
		// 			Name: to.Ptr("57681820a40f7eb6c49f6aca"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/gateways/apis"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/57681820a40f7eb6c49f6aca"),
		// 			Properties: &armapimanagement.APIContractProperties{
		// 				Description: to.Ptr("description_57681820a40f7eb6c49f6acc"),
		// 				APIRevision: to.Ptr("1"),
		// 				IsCurrent: to.Ptr(true),
		// 				Path: to.Ptr("suffix_57681820a40f7eb6c49f6ace"),
		// 				DisplayName: to.Ptr("api_57681820a40f7eb6c49f6acb"),
		// 				Protocols: []*armapimanagement.Protocol{
		// 					to.Ptr(armapimanagement.ProtocolHTTPS)},
		// 					ServiceURL: to.Ptr("http://contoso/57681820a40f7eb6c49f6acd"),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists a collection of the APIs associated with a gateway.
 *
 * @summary Lists a collection of the APIs associated with a gateway.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
 */
async function apiManagementListGatewayApis() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const gatewayId = "gw1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.gatewayApi.listByService(
    resourceGroupName,
    serviceName,
    gatewayId
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
// this example is just showing the usage of "GatewayApi_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementGatewayResource created on azure
// for more information of creating ApiManagementGatewayResource, please refer to the document of ApiManagementGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string gatewayId = "gw1";
ResourceIdentifier apiManagementGatewayResourceId = ApiManagementGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, gatewayId);
ApiManagementGatewayResource apiManagementGateway = client.GetApiManagementGatewayResource(apiManagementGatewayResourceId);

// invoke the operation and iterate over the result
await foreach (GatewayApiData item in apiManagementGateway.GetGatewayApisByServiceAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/57681820a40f7eb6c49f6aca",
      "type": "Microsoft.ApiManagement/service/gateways/apis",
      "name": "57681820a40f7eb6c49f6aca",
      "properties": {
        "displayName": "api_57681820a40f7eb6c49f6acb",
        "apiRevision": "1",
        "description": "description_57681820a40f7eb6c49f6acc",
        "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd",
        "path": "suffix_57681820a40f7eb6c49f6ace",
        "protocols": [
          "https"
        ],
        "isCurrent": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定義

名前	説明
ApiCollection	ページ API リスト表現。
ApiContactInformation	API の連絡先情報
ApiContract	API の詳細。
ApiLicenseInformation	API ライセンス情報
ApiType	API の種類。
ApiVersionSetContractDetails	API バージョン セットには、関連する一連の API バージョンの共通構成が含まれています
AuthenticationSettingsContract	API 認証の設定。
bearerTokenSendingMethods	サーバーにトークンを送信する方法。
ErrorFieldContract	エラー フィールド コントラクト。
ErrorResponse	エラー応答。
OAuth2AuthenticationSettingsContract	API OAuth2 認証設定の詳細。
OpenIdAuthenticationSettingsContract	API OAuth2 認証設定の詳細。
Protocol	この API の操作を呼び出すことができるプロトコルを記述します。
SubscriptionKeyParameterNamesContract	サブスクリプション キー パラメーター名の詳細。

ApiCollection

ページ API リスト表現。

名前	型	説明
count	integer	すべてのページの合計レコード数。
nextLink	string	次のページ リンク (存在する場合)。
value	ApiContract[]	ページ値。

ApiContactInformation

API の連絡先情報

名前	型	説明
email	string	連絡先/organizationのメール アドレス。 電子メール アドレスの形式にする必要があります
name	string	連絡先/organizationの識別名
url	string	連絡先情報を指す URL。 URL の形式にする必要があります

ApiContract

API の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.apiRevision	string	API のリビジョンについて説明します。 値が指定されていない場合、既定のリビジョン 1 が作成されます
properties.apiRevisionDescription	string	API リビジョンの説明。
properties.apiVersion	string	API がバージョン管理されている場合の API のバージョン識別子を示します
properties.apiVersionDescription	string	API バージョンの説明。
properties.apiVersionSet	ApiVersionSetContractDetails	バージョン セットの詳細
properties.apiVersionSetId	string	関連する ApiVersionSet のリソース識別子。
properties.authenticationSettings	AuthenticationSettingsContract	この API に含まれる認証設定のコレクション。
properties.contact	ApiContactInformation	API の連絡先情報。
properties.description	string	API の説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string	API 名。 1 から 300 文字の長さにする必要があります。
properties.isCurrent	boolean	API リビジョンが現在の API リビジョンであるかどうかを示します。
properties.isOnline	boolean	API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。
properties.license	ApiLicenseInformation	API のライセンス情報。
properties.path	string	API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。
properties.protocols	Protocol[]	この API の操作を呼び出すことができるプロトコルを記述します。
properties.serviceUrl	string	この API を実装するバックエンド サービスの絶対 URL。 2,000 文字を超えることはできません。
properties.sourceApiId	string	ソース API の API 識別子。
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API を使用できるようにするプロトコル。
properties.subscriptionRequired	boolean	API にアクセスするために API または製品サブスクリプションが必要かどうかを指定します。
properties.termsOfServiceUrl	string	API のサービス利用規約への URL。 URL の形式にする必要があります。
properties.type	ApiType	API の種類。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

API ライセンス情報

名前	型	説明
name	string	API に使用されるライセンス名
url	string	API に使用されるライセンスの URL。 URL の形式にする必要があります

ApiType

API の種類。

名前	型	説明
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

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

名前	型	説明
description	string	API バージョン セットの説明。
id	string	既存の API バージョン セットの識別子。 新しいバージョン セットを作成するには、この値を省略します。
name	string	API バージョン セットの表示名。
versionHeaderName	string	versioningScheme が に header設定されている場合に API バージョンを示す HTTP ヘッダー パラメーターの名前。
versionQueryName	string	versioningScheme が に query設定されている場合に API バージョンを示すクエリ パラメーターの名前。
versioningScheme	enum: Header Query Segment	API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。

AuthenticationSettingsContract

API 認証の設定。

名前	型	説明
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 認証設定
openid	OpenIdAuthenticationSettingsContract	OpenID Connect の認証設定

bearerTokenSendingMethods

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

名前	型	説明
authorizationHeader	string	アクセス トークンは、ベアラー スキーマを使用して Authorization ヘッダーで送信されます
query	string	アクセス トークンはクエリ パラメーターとして送信されます。

ErrorFieldContract

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

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

名前	型	説明
authorizationServerId	string	OAuth 承認サーバーの識別子。
scope	string	操作スコープ。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

名前	型	説明
bearerTokenSendingMethods	bearerTokenSendingMethods[]	サーバーにトークンを送信する方法。
openidProviderId	string	OAuth 承認サーバーの識別子。

Protocol

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

名前	型	説明
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

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

名前	型	説明
header	string	サブスクリプション キー ヘッダー名。
query	string	サブスクリプション キー クエリ文字列パラメーター名。