你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Apis - List By Service

参考

服务:: API Management

API 版本:: 2021-08-01

列出 API 管理服务实例的所有 API。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis?api-version=2021-08-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=2021-08-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。
serviceName	path	True	string	API 管理服务的名称。正则表达式模式: `^[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 \| \|displayName \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|description \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|serviceUrl \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|路径 \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|isCurrent \|filter \|eq， ne \| \|
$skip	query		integer int32	要跳过的记录数。
$top	query		integer int32	要返回的记录数。
expandApiVersionSet	query		boolean	在响应中包含完整的 ApiVersionSet 资源
tags	query		string	在响应中包含标记。

响应

名称	类型	说明
200 OK	ApiCollection	分页 API 的结果响应。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementListApis

示例请求

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

import com.azure.core.util.Context;

/** Samples for Api ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApis.json
     */
    /**
     * Sample code: ApiManagementListApis.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListApis(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apis().listByService("rg1", "apimService1", null, null, 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

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_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.api.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApis.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

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/ApiManagementListApis.json
func ExampleAPIClient_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.NewAPIClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.APIClientListByServiceOptions{Filter: nil,
		Top:                 nil,
		Skip:                nil,
		Tags:                nil,
		ExpandAPIVersionSet: 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](4),
		// 	Value: []*armapimanagement.APIContract{
		// 		{
		// 			Name: to.Ptr("a1"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1"),
		// 			Properties: &armapimanagement.APIContractProperties{
		// 				APIRevision: to.Ptr("1"),
		// 				APIVersionSetID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4"),
		// 				IsCurrent: to.Ptr(true),
		// 				Path: to.Ptr("api1"),
		// 				DisplayName: to.Ptr("api1"),
		// 				Protocols: []*armapimanagement.Protocol{
		// 					to.Ptr(armapimanagement.ProtocolHTTPS)},
		// 					ServiceURL: to.Ptr("http://echoapi.cloudapp.net/api"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("5a73933b8f27f7cc82a2d533"),
		// 				Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a73933b8f27f7cc82a2d533"),
		// 				Properties: &armapimanagement.APIContractProperties{
		// 					APIRevision: to.Ptr("1"),
		// 					APIVersion: to.Ptr("v1"),
		// 					APIVersionSetID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/c48f96c9-1385-4e2d-b410-5ab591ce0fc4"),
		// 					IsCurrent: to.Ptr(true),
		// 					Path: to.Ptr("api1"),
		// 					DisplayName: to.Ptr("api1"),
		// 					Protocols: []*armapimanagement.Protocol{
		// 						to.Ptr(armapimanagement.ProtocolHTTPS)},
		// 						ServiceURL: to.Ptr("http://echoapi.cloudapp.net/api"),
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("echo-api"),
		// 					Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api"),
		// 					Properties: &armapimanagement.APIContractProperties{
		// 						APIRevision: to.Ptr("1"),
		// 						IsCurrent: to.Ptr(true),
		// 						Path: to.Ptr("echo"),
		// 						DisplayName: to.Ptr("Echo API"),
		// 						Protocols: []*armapimanagement.Protocol{
		// 							to.Ptr(armapimanagement.ProtocolHTTPS)},
		// 							ServiceURL: to.Ptr("http://echoapi.cloudapp.net/api"),
		// 						},
		// 					},
		// 					{
		// 						Name: to.Ptr("5a7390baa5816a110435aee0"),
		// 						Type: to.Ptr("Microsoft.ApiManagement/service/apis"),
		// 						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5a7390baa5816a110435aee0"),
		// 						Properties: &armapimanagement.APIContractProperties{
		// 							Description: to.Ptr("A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"),
		// 							APIRevision: to.Ptr("1"),
		// 							IsCurrent: to.Ptr(true),
		// 							Path: to.Ptr("vvv"),
		// 							DisplayName: to.Ptr("Swagger Petstore Extensive"),
		// 							Protocols: []*armapimanagement.Protocol{
		// 								to.Ptr(armapimanagement.ProtocolHTTPS)},
		// 								ServiceURL: to.Ptr("http://petstore.swagger.wordnik.com/api"),
		// 							},
		// 					}},
		// 				}
	}
}

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

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

/**
 * This sample demonstrates how to Lists all APIs of the API Management service instance.
 *
 * @summary Lists all APIs of the API Management service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApis.json
 */
async function apiManagementListApis() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.api.listByService(resourceGroupName, serviceName)) {
    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

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/ApiManagementListApis.json
// this example is just showing the usage of "Api_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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiResource
ApiCollection collection = apiManagementService.GetApis();

// invoke the operation and iterate over the result
await foreach (ApiResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApiData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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/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
      }
    }
  ],
  "count": 4,
  "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	联系人/组织的电子邮件地址。必须采用电子邮件地址格式
name	string	联系人/组织的标识名称
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	相对 URL，用于唯一标识此 API 及其在 API 管理服务实例中的所有资源路径。可将其追加到在服务实例创建过程中指定的 API 终结点基 URL，构成此 API 的公共 URL。
properties.protocols	Protocol[]	说明可在哪些协议上调用此 API 中的操作。
properties.serviceUrl	string	实现此 API 的后端服务的绝对 URL。长度不能超过 2000 个字符。
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	HTTP 标头参数的名称，如果 versioningScheme 设置为 `header`，则指示 API 版本。
versionQueryName	string	如果 versioningScheme 设置为 `query`，则指示 API 版本的查询参数的名称。
versioningScheme	enum: Header Query Segment	一个值，该值确定 API 版本标识符在 HTTP 请求中的位置。

AuthenticationSettingsContract

API 身份验证设置。

名称	类型	说明
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 身份验证设置
openid	OpenIdAuthenticationSettingsContract	OpenID Connect 身份验证设置

bearerTokenSendingMethods

如何将令牌发送到服务器。

名称	类型	说明
authorizationHeader	string	访问令牌将使用持有者架构在授权标头中传输
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	订阅密钥查询字符串参数名称。