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. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API для использования с клиентским запросом.
$filter	query		string	| Поле | Использование | Поддерживаемые операторы | Поддерживаемые функции | |-------------|-------------|-------------|-------------| | name | фильтр | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | фильтр | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | описание | фильтр | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | фильтр | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | фильтр | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | фильтр | 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

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementListApis

Образец запроса

HTTP

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

Java

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

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_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

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/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

JavaScript

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

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/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	Сведения о параметрах проверки подлинности OAuth2 API.
OpenIdAuthenticationSettingsContract	Сведения о параметрах проверки подлинности OAuth2 API.
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	Полный идентификатор ресурса. Пример : /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. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.
properties.protocols	Protocol[]	Описывает, на каких протоколах могут вызываться операции в данном API.
properties.serviceUrl	string	Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может содержать более 2000 символов.
properties.sourceApiId	string	Идентификатор API исходного API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Протоколы, по которым становится доступным API.
properties.subscriptionRequired	boolean	Указывает, требуется ли api или подписка на продукт для доступа к API.
properties.termsOfServiceUrl	string	URL-адрес условий предоставления услуг для API. ДОЛЖЕН быть в формате URL-адреса.
properties.type	ApiType	Тип API.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Сведения о лицензии API

Имя	Тип	Описание
name	string	Имя лицензии, используемое для API
url	string	URL-адрес лицензии, используемой для API. ДОЛЖЕН быть в формате 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, указывающее версию API, если versioningScheme имеет значение header.
versionQueryName	string	Имя параметра запроса, указывающее версию API, если versioningScheme имеет значение query.
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

Сведения о параметрах проверки подлинности OAuth2 API.

Имя	Тип	Описание
authorizationServerId	string	Идентификатор сервера авторизации OAuth.
scope	string	операции область.

OpenIdAuthenticationSettingsContract

Сведения о параметрах проверки подлинности OAuth2 API.

Имя	Тип	Описание
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Как отправить маркер на сервер.
openidProviderId	string	Идентификатор сервера авторизации OAuth.

Protocol

Описывает, на каких протоколах могут вызываться операции в данном API.

Имя	Тип	Описание
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

Сведения об именах параметров ключа подписки.

Имя	Тип	Описание
header	string	Имя заголовка ключа подписки.
query	string	Имя параметра строки запроса ключа подписки.