Часто задаваемые вопросы о службе управления API Azure

Ознакомьтесь с ответами на часто задаваемые вопросы, шаблонами и рекомендациями относительно службы управления API Azure.

Примечание

В этой статье предусмотрено использование модуля Azure Az PowerShell, который является рекомендуемым модулем PowerShell для взаимодействия с Azure. Чтобы начать работу с модулем Az PowerShell, ознакомьтесь со статьей Установка Azure PowerShell. Дополнительные сведения см. в статье Перенос Azure PowerShell с AzureRM на Az.

Что означает, если функция пребывает в предварительной версии?

Это значит, что мы активно изучаем отзывы пользователей о работе функции. Функция в предварительной версии фактически завершена, но, возможно, мы внесем важные изменения в ответ на отзывы клиентов. Мы рекомендуем не закладывать в основу рабочей среды функции в предварительной версии.

Как защитить подключение шлюза управления API к внутренним службам?

Существует несколько способов защитить такое подключение. Вы можете:

Как скопировать экземпляр службы управления API в новый экземпляр?

Существует несколько способов сделать это. Вы можете:

Можно ли управлять экземпляром службы управления API программными средствами?

Да, вы можете управлять службой управления API с помощью программных средств:

Как добавить пользователя в группу администраторов?

Группа администраторов— это неизменяемая системная группа. Администраторы подписок Azure принадлежат к этой группе. Вы не сможете добавить пользователя в эту группу. Подробнее см. в статье Как создавать и использовать группы для управления учетными записями разработчика в службе “Управление API” Azure.

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

Почему политика, которую я хочу добавить, недоступна в редакторе политик?

Если в редакторе политик нужная политика отображается серым цветом или недоступна, убедитесь в правильности области ее действия. Каждый оператор предназначен для использования в конкретной области и разделе политики. Разделы политики и области ее действия см. в подразделе об использовании в разделе API Management policies (Политики управления API).

Как настроить несколько сред в одном API?

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

  • разместить различные API в одном клиенте;
  • разместить один и тот же API в разных клиентах.

Можно ли использовать SOAP в управлении API?

Сейчас поддерживается сквозная передача SOAP. Администраторы могут импортировать WSDL-файл своей службы SOAP, и служба управления API Azure создаст внешний интерфейс SOAP. Для служб SOAP доступны документация портала для разработчиков, консоль тестирования, политики и средства анализа.

Можно ли настроить на сервере авторизации OAuth 2.0 систему безопасности служб федерации Active Directory?

Дополнительные сведения о настройке системы безопасности служб федерации Active Directory (AD FS) на сервере авторизации OAuth 2.0 см. в записи блога Using ADFS in API Management (Использование служб федерации Active Directory в службе управления API).

Какой метод маршрутизации использует служба управления API при развертывании в нескольких географических расположениях?

При развертывании в нескольких географических расположениях служба управления API применяет маршрутизацию трафика для повышения производительности. Входящий трафик направляется на ближайший шлюз API. Если регион становится недоступен, входящий трафик автоматически маршрутизируется на следующий ближайший шлюз. Дополнительные сведения о методах маршрутизации см. в статье Методы маршрутизации трафика диспетчером трафика.

Можно ли использовать шаблон Azure Resource Manager, чтобы создать экземпляр службы управления API?

Да. Ознакомьтесь с шаблонами быстрого запуска службы “Управление API” Azure.

Можно ли использовать самозаверяющий сертификат TLS/SSL для сервера?

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

Метод PowerShell

Используйте командлеты PowerShell New-AzApiManagementBackend (для новой серверной части) или Set-AzApiManagementBackend (для существующей серверной части) и задайте для параметра -SkipCertificateChainValidation значение True.

$context = New-AzApiManagementContext -resourcegroup 'ContosoResourceGroup' -servicename 'ContosoAPIMService'
New-AzApiManagementBackend -Context  $context -Url 'https://contoso.com/myapi' -Protocol http -SkipCertificateChainValidation $true

Прямой метод обновления API

  1. Создайте серверную сущность с помощью службы управления API.
  2. Задайте для свойства skipCertificateChainValidation значение true.
  3. Если вы хотите запретить использование самозаверяющего сертификата, удалите серверную сущность или задайте для свойства skipCertificateChainValidation значение false.

Почему происходит ошибка проверки подлинности при попытке клонировать репозиторий Git?

Если вы используете диспетчер учетных данных Git или пытаетесь клонировать репозиторий с помощью Visual Studio, вы можете столкнуться с известной проблемой в диалоговом окне учетных данных Windows. Это диалоговое окно ограничивает длину пароля до 127 символов и усекает пароль, созданный корпорацией Майкрософт. Мы работаем над сокращением пароля. Пока для клонирования используйте Git Bash.

Работает ли управление API с Azure ExpressRoute?

Да. Служба управления API работает с Azure ExpressRoute.

Зачем требуется выделенная подсеть в виртуальных сетях типа Resource Manager, если в них развернута служба управления API?

Выделенная подсеть для службы управления API требуется по той причине, что служба основана на классической модели развертывания (уровень PAAS V1). Хотя ее можно развернуть в виртуальной сети Resource Manager (уровень V2), имеются последствия. Классическая модель развертывания в Azure не связана тесно с моделью развертывания с помощью Resource Manager. Поэтому при создании ресурса на уровне V2 уровень V1 не знает об этом, и возможны проблемы. Например, служба управления API может попытаться использовать IP-адрес, который уже выделен сетевому адаптеру (основанному на уровне V2). Дополнительные сведения о различиях между классической моделью и моделью Resource Manager в Azure см. в разделе Развертывание с помощью Azure Resource Manager и классическое развертывание.

Каков минимальный размер подсети, требуемый при развертывании службы управления API в виртуальной сети?

Минимальный размер подсети, необходимой для развертывания службы управления API, — /29 (это минимальный размер подсети, поддерживаемый в Azure).

Можно ли перенести экземпляр службы управления API из одной подписки в другую?

Да. Чтобы узнать, как это сделать, см. статью Перемещение ресурсов в новую группу ресурсов или подписку.

Существуют ли ограничения на импорт API или известные проблемы, связанные с этим процессом?

Известные проблемы и ограничения для форматов Open API (Swagger), WSDL и WADL.

Как Управление API обрабатывает конечные косые черты при вызове внутренних служб?

Исторически и по соглашению URL-адрес, заканчивающийся конечной косой чертой, рассматривается как каталог, например "https://contoso.com/sample/" в то время как тот же URL-адрес без косой чертыhttps://contoso.com/sample" "; указывает на файл. Это не обязательное условие, поэтому некоторые системы рассматривают эти два URL-адреса как уникальные, в то время как другие считают их одним и тем же URL-адресом. Управление API не делает различия, поэтому одна операция "ресурс" будет принимать "ресурс" и "ресурс/". Однако, хотя различие не имеет значения для Управления API, оно может иметь значение для внутреннего узла. Некоторые веб-серверы автоматически перенаправляют URL-адрес, не заканчивающийся косой чертой, на тот же URL-адрес, заканчивающийся косой чертой. Так как Управление API является клиентом серверной части (сервера), автоматическое перенаправление не всегда желательно. При необходимости создайте политику переопределения URL-адресов, чтобы гарантировать, что косая черта всегда добавляется в исходящий внутренний вызов.