Product Api - List By Product

Возвращает коллекцию API, связанных с продуктом.

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

Параметры URI

Name In Required Type Description
productId
path True
  • string

Идентификатор продукта. Должен быть уникальным в текущем экземпляре службы Управление API.

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 подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True
  • string

Версия API, используемая с клиентским запросом.

$filter
query
  • string

| | полей | использования Поддерживаемые операторы | Поддерживаемые функции |
|-------------|-------------|-------------|-------------|
| | имени фильтрация | 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 |
| | пути фильтрация | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query
  • integer
int32

Количество записей, которые будут пропущены.

$top
query
  • integer
int32

Количество возвращаемых записей.

Ответы

Name Type Description
200 OK

Текст ответа содержит коллекцию сущностей Api в продукте.

Other Status Codes

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementListProductApis

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca",
      "type": "Microsoft.ApiManagement/service/products/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.

ErrorFieldContract

Контракт поля ошибки.

ErrorResponse

Ответ на ошибку.

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

ApiCollection

Представление списка API со страницами.

Name Type Description
count
  • integer

Общее число записей на всех страницах.

nextLink
  • string

Ссылка на следующую страницу, если она есть.

value

Значения страницы.

ApiContactInformation

Контактные данные API

Name Type Description
email
  • string

Адрес электронной почты контактного лица или организации. Должен быть в формате адреса электронной почты.

name
  • string

Идентифицирующие имя контактного лица или организации

url
  • string

URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса

ApiContract

Сведения об API.

Name Type Description
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

Сведения о наборе версий

properties.apiVersionSetId
  • string

Идентификатор ресурса для связанного набора ApiVersionSet.

properties.authenticationSettings

Коллекция параметров проверки подлинности, включенных в этот API.

properties.contact

Контактные данные api.

properties.description
  • string

Описание API. Может содержать теги форматирования HTML.

properties.displayName
  • string

Имя API. Должно содержать от 1 до 300 символов.

properties.isCurrent
  • boolean

Указывает, является ли редакция API текущей редакцией API.

properties.isOnline
  • boolean

Указывает, доступна ли редакция API через шлюз.

properties.license

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

properties.path
  • string

Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.

properties.protocols
  • string[]

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

properties.serviceUrl
  • string

Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может быть длиннее 2000 символов.

properties.sourceApiId
  • string

Идентификатор API исходного API.

properties.subscriptionKeyParameterNames

Протоколы, через которые предоставляется API.

properties.subscriptionRequired
  • boolean

Указывает, требуется ли API или подписка на продукт для доступа к API.

properties.termsOfServiceUrl
  • string

URL-адрес условий обслуживания для API. ДОЛЖЕН быть в формате URL-адреса.

properties.type

Тип API.

type
  • string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft. служба хранилища/storageAccounts"

ApiLicenseInformation

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

Name Type Description
name
  • string

Имя лицензии, используемое для API

url
  • string

URL-адрес лицензии, используемой для API. ДОЛЖЕН быть в формате URL-адреса

ApiType

Тип API.

Name Type Description
graphql
  • string
http
  • string
soap
  • string
websocket
  • string

ApiVersionSetContractDetails

Набор версий API содержит общую конфигурацию для набора версий API, связанных с

Name Type Description
description
  • string

Описание набора версий API.

id
  • string

Идентификатор существующего набора версий API. Пропустите это значение, чтобы создать новый набор версий.

name
  • string

Отображаемое имя набора версий API.

versionHeaderName
  • string

Имя параметра заголовка HTTP, указывающего версию API, если задано значение headerversioningScheme.

versionQueryName
  • string

Имя параметра запроса, указывающего версию API, если параметр versioningScheme имеет значение query.

versioningScheme enum:
  • Header
  • Query
  • Segment

Значение, определяющее расположение идентификатора версии API в HTTP-запросе.

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

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

Name Type Description
authorizationServerId
  • string

Идентификатор сервера авторизации OAuth.

scope
  • string

область операций.

OpenIdAuthenticationSettingsContract

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

Name Type Description
bearerTokenSendingMethods
  • string[]

Отправка маркера на сервер.

openidProviderId
  • string

Идентификатор сервера авторизации OAuth.

SubscriptionKeyParameterNamesContract

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

Name Type Description
header
  • string

Имя заголовка ключа подписки.

query
  • string

Имя параметра строки запроса ключа подписки.