Справочник по модели данных шаблона в службе управления API Azure

В этой статье описываются представления сущностей и типов для распространенных элементов, используемых в моделях данных для шаблонов портала разработчика в службе управления API Azure.

Дополнительные сведения о работе с шаблонами см. в статье Настройка портала разработчика в службе управления API Azure с помощью шаблонов.

Примечание

Следующая документация относится к нерекомендуемому порталу разработчика. Вы по-прежнему можете использовать его в обычном режиме до прекращения его поддержки в октябре 2023 года, когда он будет удален изо всех служб Управления API. Нерекомендуемый портал будет получать только критические обновления системы безопасности. Дополнительные сведения см. в следующих статьях:

• Как перейти на новый портал разработчика
• Обзор нового портала разработчика в службе "Управление API" Azure
• Доступ к новому порталу разработчика и его настройка

Доступность

Важно!

Эта функция доступна в ценовых категориях Премиум, Стандартный, Базовый и Разработка службы "Управление API".

Сведения о доступности функций на уровнях версии 2 (предварительная версия) см. в обзоре уровней версии 2.

Справка

• API
• Сводные данные API
• Приложение
• Вложение
• Пример кода
• Комментарий
• Фильтрация
• Header
• HTTP-запрос
• HTTP-ответ
• Проблема
• Операция
• Меню операций
• Элемент меню операций
• Разбивка на страницы
• Параметр
• Продукт
• Поставщик
• Представление
• Подписка
• Сводка по подписке
• Сведения об учетной записи пользователя
• Вход пользователя
• Регистрация пользователя

API

Сущность API имеет следующие свойства:

Свойство	Тип	Описание
id	строка	Идентификатор ресурса. Однозначно идентифицирует API в текущем экземпляре службы управления API. Значение является допустимым относительным URL-адресом в формате apis/{id}, где {id} — идентификатор API. Это свойство доступно только для чтения.
name	строка	Имя API. Не может быть пустым. Максимальная длина составляет 100 символов.
description	строка	Описание API. Не может быть пустым. Может содержать теги форматирования HTML. Максимальная длина составляет 1000 символов.
serviceUrl	строка	Абсолютный URL-адрес внутренней службы, реализующей этот API.
path	строка	Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.
protocols	массив чисел	Описывает, на каких протоколах могут вызываться операции в данном API. Допустимые значения: 1 - http, 2 - https или оба.
authenticationSettings	Параметры проверки подлинности сервера авторизации	Коллекция параметров проверки подлинности, входящих в этот API.
subscriptionKeyParameterNames	object	Необязательное свойство, которое может использоваться для указания пользовательских имен для параметров запроса и (или) заголовка, содержащих ключ подписки. Это свойство должно содержать хотя бы одно из двух следующих свойств. { "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

Сводные данные API

Сущность API summary имеет следующие свойства:

Свойство	Тип	Описание
id	строка	Идентификатор ресурса. Однозначно идентифицирует API в текущем экземпляре службы управления API. Значение является допустимым относительным URL-адресом в формате apis/{id}, где {id} — идентификатор API. Это свойство доступно только для чтения.
name	строка	Имя API. Не может быть пустым. Максимальная длина составляет 100 символов.
description	строка	Описание API. Не может быть пустым. Может содержать теги форматирования HTML. Максимальная длина составляет 1000 символов.

Приложение

Сущность application имеет следующие свойства:

Свойство	Тип	Описание
Id	строка	Уникальный идентификатор приложения.
Title	строка	Название приложения.
Description	строка	Описание приложения.
Url	URI	URI для приложения.
Version	строка	Сведения о версии приложения.
Requirements	строка	Описание требований для приложения.
State	number	Текущее состояние приложения. — 0: зарегистрировано. — 1: отправлено. — 2: опубликовано. — 3: отклонено. — 4: не опубликовано.
RegistrationDate	Дата и время	Дата и время регистрации приложения.
CategoryId	number	Категория приложения (финансы, развлечения и т. д.)
DeveloperId	строка	Уникальный идентификатор разработчика, отправившего приложение.
Attachments	коллекция сущностей Вложение	Вложения для приложения, например снимки экрана или значки.
Icon	Вложение	Значок для приложения.

Вложение

Сущность attachment имеет следующие свойства:

Свойство	Тип	Описание
UniqueId	строка	Уникальный идентификатор вложения.
Url	строка	URL-адрес ресурса.
Type	строка	Тип вложения.
ContentType	строка	Тип носителя вложения.

Пример кода

Свойство	Тип	Описание
title	строка	Имя операции.
snippet	строка	Это свойство является устаревшим и не должно использоваться.
brush	строка	Какая расцветка синтаксиса кода будет использоваться при отображении примера кода. Допустимые значения: plain, php, java, xml, objc, python, ruby и csharp.
template	строка	Имя данного шаблона примера кода.
body	строка	Заполнитель для части примера фрагмента кода.
method	строка	Метод HTTP, используемый для операции.
scheme	строка	Протокол, используемый для запроса операции.
path	строка	Путь к операции.
query	строка	Пример строки запроса с заданными параметрами.
host	строка	URL-адрес шлюза службы управления API для API, содержащего эту операцию.
headers	Коллекция сущностей Заголовок.	Заголовки для этой операции.
parameters	коллекция сущностей Параметр	Параметры, определенные для этой операции.

Комментарий

Сущность API имеет следующие свойства:

Свойство	Тип	Описание
Id	number	Идентификатор комментария.
CommentText	строка	Текст комментария. Может содержать теги HTML.
DeveloperCompany	строка	Название компании, где работает разработчик.
PostedOn	Дата и время	Дата и время, когда был оставлен комментарий.

Проблема

Сущность issue имеет следующие свойства.

Свойство	Тип	Описание
Id	строка	Уникальный идентификатор проблемы.
ApiID	строка	Идентификатор API, в котором была обнаружена эта проблема.
Title	строка	Название проблемы.
Description	строка	Описание проблемы.
SubscriptionDeveloperName	строка	Имя разработчика, который сообщил о проблеме.
IssueState	строка	Текущее состояние проблемы. Возможные значения: Proposed, Opened, Closed.
ReportedOn	Дата и время	Дата и время, когда была обнаружена проблема.
Comments	коллекция сущностей Комментарий	Комментарии к этой проблеме.
Attachments	коллекция сущностей Вложение	Все вложения, добавленные к проблеме.
Services	коллекция сущностей API	API, на которые подписан пользователь, отправивший проблему.

Фильтрация

Сущность filtering имеет следующие свойства:

Свойство	Тип	Описание
Pattern	строка	Текущий поисковый запрос или null при его отсутствии.
Placeholder	строка	Текст, отображаемый в поле поиска, если не указан поисковый запрос.

Заголовок

В этом разделе описывается представление parameter.

Свойство	Тип	Описание
name	строка	Имя параметра.
description	строка	Описание параметра.
value	строка	Значение заголовка.
typeName	строка	Тип данных значения заголовка.
options	строка	Параметры.
required	Логическое	Указывает, требуется ли заголовок.
readOnly	Логическое	Указывает, доступен ли заголовок только для чтения.

HTTP-запрос

В этом разделе описывается представление request.

Свойство	Тип	Описание
description	строка	Описание запроса операции.
headers	коллекция сущностей Заголовок	Заголовки запросов.
parameters	массив параметров	коллекция параметров запросов операций
representations	массив представлений	коллекция представлений запросов операций

HTTP-ответ

В этом разделе описывается представление response.

Свойство	Тип	Описание
statusCode	положительное целое число	Код состояния ответа операции.
description	строка	Описание ответа операции.
representations	массив представлений	коллекция представлений ответов операций

Операция

Сущность operation имеет следующие свойства:

Свойство	Тип	Описание
id	строка	Идентификатор ресурса. Однозначно идентифицирует операцию в текущем экземпляре службы управления API. Значение является допустимым относительным URL-адресом в формате apis/{aid}/operations/{id}, где {aid} — идентификатор API, а {id} — идентификатор операции. Это свойство доступно только для чтения.
name	строка	Имя операции. Не может быть пустым. Максимальная длина составляет 100 символов.
description	строка	Описание операции. Не может быть пустым. Может содержать теги форматирования HTML. Максимальная длина составляет 1000 символов.
scheme	строка	Описывает, на каких протоколах могут вызываться операции в данном API. Допустимые значения: http, https или оба (http и https).
uriTemplate	строка	Шаблон относительного URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: customers/{cid}/orders/{oid}/?date={date}
host	строка	URL-адрес шлюза управления API, на котором размещен API.
httpMethod	строка	Метод HTTP операции.
request	HTTP-запрос	Сущность, содержащая сведения о запросе.
responses	массив ответов HTTP	массив сущностей ответов HTTP операции

Меню операций

Сущность operation menu имеет следующие свойства:

Свойство	Тип	Описание
ApiId	строка	Идентификатор текущего API.
CurrentOperationId	строка	Идентификатор текущей операции.
Action	строка	Тип меню.
MenuItems	коллекция сущностей Элемент меню операций	Операции для текущего API.

Элемент меню операций

Сущность operation menu item имеет следующие свойства:

Свойство	Тип	Описание
Id	строка	Идентификатор операции.
Title	строка	Описание операции.
HttpMethod	строка	Метод HTTP, используемый для операции.

Разбивка на страницы

Сущность paging имеет следующие свойства:

Свойство	Тип	Описание
Page	number	Номер текущей страницы.
PageSize	number	Максимальное число результатов, отображаемых на одной странице.
TotalItemCount	number	Число элементов для отображения.
ShowAll	Логическое	Указывает, следует ли показывать все результаты на одной странице.
PageCount	number	Число страниц с результатами.

Параметр

В этом разделе описывается представление parameter.

Свойство	Тип	Описание
name	строка	Имя параметра.
description	строка	Описание параметра.
value	строка	Значение параметра.
options	Массив строк	Значения, определяемые для параметров запроса.
required	Логическое	Указывает, является ли параметр обязательным.
kind	number	Указывает, является ли этот параметр параметром пути (1) или параметром строки запроса (2).
typeName	строка	Тип параметра.

Продукт

Сущность product имеет следующие свойства:

Свойство	Тип	Описание
Id	строка	Идентификатор ресурса. Однозначно идентифицирует продукт в текущем экземпляре службы управления API. Значение является допустимым относительным URL-адресом в формате products/{pid}, где {pid} — идентификатор продукта. Это свойство доступно только для чтения.
Title	строка	Имя продукта. Не может быть пустым. Максимальная длина составляет 100 символов.
Description	строка	Описание продукта. Не может быть пустым. Может содержать теги форматирования HTML. Максимальная длина составляет 1000 символов.
Terms	строка	Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления.
ProductState	number	Указывает, опубликован ли продукт. Опубликованные продукты доступны разработчикам на портале разработчика. Неопубликованные продукты видны только администраторам. Допустимые значения для состояния продукта: - 0 - Not Published - 1 - Published - 2 - Deleted
AllowMultipleSubscriptions	Логическое	Указывает, может ли пользователь одновременно иметь несколько подписок на этот продукт.
MultipleSubscriptionsCount	number	Максимальное число подписок для этого продукта, которые может иметь пользователь.

Поставщик

Сущность provider имеет следующие свойства:

Свойство	Тип	Описание
Properties	словарь строк	Свойства для этого поставщика проверки подлинности.
AuthenticationType	строка	Тип поставщика (идентификатор Microsoft Entra, вход в Facebook, учетная запись Google, учетная запись Майкрософт, Twitter).
Caption	строка	Отображаемое имя поставщика.

Представление

В этом разделе описывается representation.

Свойство	Тип	Описание
contentType	строка	Указывает зарегистрированный или пользовательский тип содержимого для этого представления, например application/xml.
sample	строка	Пример представления.

Подписка

Сущность subscription имеет следующие свойства:

Свойство	Тип	Описание
Id	строка	Идентификатор ресурса. Однозначно идентифицирует подписку в текущем экземпляре службы управления API. Значение является допустимым относительным URL-адресом в формате subscriptions/{sid}, где {sid} — идентификатор подписки. Это свойство доступно только для чтения.
ProductId	строка	Идентификатор ресурса продукта, на который оформлена подписка. Значение является допустимым относительным URL-адресом в формате products/{pid}, где {pid} — идентификатор продукта.
ProductTitle	строка	Имя продукта. Не может быть пустым. Максимальная длина составляет 100 символов.
ProductDescription	строка	Описание продукта. Не может быть пустым. Может содержать теги форматирования HTML. Максимальная длина составляет 1000 символов.
ProductDetailsUrl	строка	Относительный URL-адрес страницы сведений о продукте.
state	строка	Состояние подписки. Возможны следующие состояния. —- 0 - suspended: подписка заблокирована, и подписчик не может вызвать ни один API продукта. — - 1 - active: подписка активна. — - 2 - expired: срок действия подписки истек, и она была деактивирована. — - 3 - submitted: запрос разработчика на подписку выполнен, но еще не был утвержден или отклонен. —- 4 - rejected: администратор отклонил запрос на подписку. — - 5 - cancelled: подписка была отменена разработчиком или администратором.
DisplayName	строка	Отображаемое имя подписки.
CreatedDate	dateTime	Дата создания подписки в формате ISO 8601: 2014-06-24T16:25:00Z.
CanBeCancelled	Логическое	Указывает, может ли текущий пользователь отменить подписку.
IsAwaitingApproval	Логическое	Указывает, ожидает ли подписка утверждения.
StartDate	dateTime	Дата начала действия подписки в формате ISO 8601: 2014-06-24T16:25:00Z.
ExpirationDate	dateTime	Время истечения срока действия подписки в формате ISO 8601: 2014-06-24T16:25:00Z.
NotificationDate	dateTime	Дата уведомления для подписки в формате ISO 8601: 2014-06-24T16:25:00Z.
primaryKey	строка	Первичный ключ подписки. Максимальная длина составляет 256 символов.
secondaryKey	строка	Вторичный ключ подписки. Максимальная длина составляет 256 символов.
CanBeRenewed	Логическое	Указывает, можно ли обновить подписку для текущего пользователя.
HasExpired	Логическое	Указывает, истек ли срок действия подписки.
IsRejected	Логическое	Указывает, отклонен ли запрос на подписку.
CancelUrl	строка	Относительный URL-адрес для отмены подписки.
RenewUrl	строка	Относительный URL-адрес для возобновления подписки.

Сводка по подписке

Сущность subscription summary имеет следующие свойства:

Свойство	Тип	Описание
Id	строка	Идентификатор ресурса. Однозначно идентифицирует подписку в текущем экземпляре службы управления API. Значение является допустимым относительным URL-адресом в формате subscriptions/{sid}, где {sid} — идентификатор подписки. Это свойство доступно только для чтения.
DisplayName	строка	Отображаемое имя подписки

Сведения об учетной записи пользователя

Сущность user account info имеет следующие свойства:

Свойство	Тип	Описание
FirstName	строка	Имя. Не может быть пустым. Максимальная длина составляет 100 символов.
LastName	строка	Фамилия. Не может быть пустым. Максимальная длина составляет 100 символов.
Email	строка	Электронная почта. Не может быть пустым и должно быть уникальным в пределах экземпляра службы. Максимальная длина составляет 254 символа.
Password	строка	Пароль учетной записи пользователя.
NameIdentifier	строка	Идентификатор учетной записи, совпадающий с адресом электронной почты пользователя.
ProviderName	строка	Имя поставщика проверки подлинности.
IsBasicAccount	Логическое	Значение true, если эта учетная запись зарегистрирована с использованием электронной почты и пароля. Значение false, если учетная запись зарегистрирована с помощью поставщика.

Вход пользователя

Сущность user sign in имеет следующие свойства:

Свойство	Тип	Описание
Email	строка	Электронная почта. Не может быть пустым и должно быть уникальным в пределах экземпляра службы. Максимальная длина составляет 254 символа.
Password	строка	Пароль учетной записи пользователя.
ReturnUrl	строка	URL-адрес страницы, на которой пользователь щелкнул ссылку входа.
RememberMe	Логическое	Указывает, следует ли сохранять сведения о текущем пользователе.
RegistrationEnabled	Логическое	Указывает, включена ли регистрация.
DelegationEnabled	Логическое	Указывает, включен ли делегированный вход.
DelegationUrl	строка	URL-адрес делегированного входа, если он включен.
SsoSignUpUrl	строка	Единый URL-адрес входа для пользователя, если он имеется.
AuxServiceUrl	строка	Если текущий пользователь является администратором, это ссылка на экземпляр службы на портале Azure.
Providers	коллекция сущностей Поставщик	Поставщики проверки подлинности для этого пользователя.
UserRegistrationTerms	строка	Условия, которые пользователь должен принять перед входом.
UserRegistrationTermsEnabled	Логическое	Указывает, включены ли условия использования.

Регистрация пользователя

Сущность user sign up имеет следующие свойства:

Свойство	Тип	Описание
PasswordConfirm	Логическое	Значение, используемое элементом управления для регистрации.
Password	строка	Пароль учетной записи пользователя.
PasswordVerdictLevel	number	Значение, используемое элементом управления для регистрации.
UserRegistrationTerms	строка	Условия, которые пользователь должен принять перед входом.
UserRegistrationTermsOptions	number	Значение, используемое элементом управления для регистрации.
ConsentAccepted	Логическое	Значение, используемое элементом управления для регистрации.
Email	строка	Электронная почта. Не может быть пустым и должно быть уникальным в пределах экземпляра службы. Максимальная длина составляет 254 символа.
FirstName	строка	Имя. Не может быть пустым. Максимальная длина составляет 100 символов.
LastName	строка	Фамилия. Не может быть пустым. Максимальная длина составляет 100 символов.
UserData	строка	Значение, используемое элементом управления регистрацией.
NameIdentifier	строка	Значение, используемое элементом управления для регистрации.
ProviderName	строка	Имя поставщика проверки подлинности.

Дальнейшие действия

Дополнительные сведения о работе с шаблонами см. в статье Настройка портала разработчика в службе управления API Azure с помощью шаблонов.