Поделиться через

Создание рабочей области и управление ею в службе управления API Azure

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: Premium

Настройте рабочую область, чтобы команда API могли управлять и создавать собственные API, предоставляя команде платформы API средства для наблюдения, управления и обслуживания платформы Управление API. После создания рабочей области и назначения разрешений сотрудники рабочей области могут создавать и управлять собственными API, продуктами, подписками и связанными ресурсами.

Примечание.

  • Последние функции рабочей области поддерживаются в Управление API REST API версии 2023-09-01-preview или более поздней версии.
  • Сведения о ценах см. в Управление API ценах.

Выполните действия, описанные в этой статье, чтобы:

  • Создание рабочей области Управление API и шлюза рабочей области с помощью портал Azure
  • При необходимости изолируйте шлюз рабочей области в виртуальной сети Azure.
  • Назначение разрешений рабочей области

Примечание.

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

Необходимые компоненты

  • Экземпляр управления API. Если вам нужно, создайте его на поддерживаемом уровне.
  • Роль владельца или участника в группе ресурсов, в которой развернут экземпляр Управление API, или эквивалентные разрешения на создание ресурсов в группе ресурсов.
  • (Необязательно) Существующая или новая виртуальная сеть Azure и подсеть для изоляции входящего и исходящего трафика шлюза рабочей области. Сведения о параметрах и требованиях к конфигурации см. в разделе "Требования к сетевым ресурсам" для шлюзов рабочих областей.

Создание рабочей области — портал

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

  2. В меню слева в разделе API выберите "Рабочие области>+ Добавить".

  3. На вкладке "Основные сведения" введите описательное отображаемое имя, имя ресурса и необязательное описание рабочей области. Выберите Далее.

  4. На вкладке "Шлюз" настройте параметры для шлюза рабочей области:

    • В сведениях о шлюзе введите имя шлюза и выберите количество единиц масштабирования. Затраты на шлюз зависят от количества единиц, которые вы выбрали. Дополнительные сведения см. в статье о ценах службы "Управление API".

    • В сети выберите конфигурацию сети для шлюза рабочей области.

      Внимание

      Тщательно спланируйте конфигурацию сети рабочей области. После создания рабочей области нельзя изменить конфигурацию сети.

    • Если выбрать конфигурацию сети, включающую частный входящий или частный исходящий сетевой доступ, выберите виртуальную сеть и подсеть , чтобы изолировать шлюз рабочей области или создать новую. Требования к сети см. в разделе "Требования к сетевым ресурсам" для шлюзов рабочих областей.

  5. Выберите Далее. После завершения проверки щелкните Создать.

Создание рабочей области, шлюза рабочей области и связанных ресурсов может занять от нескольких минут до нескольких часов. Чтобы отслеживать ход развертывания в портал Azure, перейдите в группу ресурсов шлюза. В меню слева в разделе "Параметры" выберите "Развертывания".

После завершения развертывания новая рабочая область появится в списке на странице "Рабочие области ". Выберите рабочую область для управления параметрами и ресурсами.

Примечание.

  • Чтобы просмотреть имя узла среды выполнения шлюза и другие сведения о шлюзе, выберите рабочую область на портале. В разделе "Развертывание и инфраструктура" выберите шлюзы и выберите имя шлюза рабочей области.
  • Во время создания шлюза рабочей области вызовы среды выполнения к API рабочей области не будут успешными.

Назначение пользователей рабочей области на портале

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

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

Примечание.

Чтобы упростить управление, настройте группы Microsoft Entra для назначения разрешений рабочей области нескольким пользователям.

Назначение роли, назначаемой службой

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

  2. В меню слева выберите элемент Управления доступом (IAM)>+ Добавить.

  3. Назначьте одну из следующих ролей в области обслуживания каждому члену рабочей области:

    • Разработчик API рабочей области службы Управление API
    • Управление API API рабочей области службы Product Manager

Назначение роли с областью действия рабочей области

  1. В меню для экземпляра Управление API в разделе API выберите "Рабочие области>" имя созданной рабочей области.

  2. В окне рабочей области выберите Элемент управления доступом (IAM)>+ Добавить.

  3. Назначьте одну из следующих ролей в области рабочей области членам рабочей области, чтобы они могли управлять API рабочих областей и другими ресурсами.

    • средство чтения рабочей области Управление API
    • Участник рабочей области Управление API
    • Разработчик API рабочей области Управление API
    • Управление API API рабочей области Product Manager

Назначение роли с областью действия шлюза

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

  2. В меню слева в разделе API выберите "Рабочие области> " имя рабочей области.

  3. В меню слева рабочей области выберите шлюзы и выберите шлюз рабочей области.

  4. В меню слева выберите элемент Управления доступом (IAM)>+ Добавить.

  5. Назначьте одну из следующих ролей каждому члену рабочей области. Как минимум, рекомендуется назначить роль читателя для просмотра параметров шлюза. Владельцы и участники могут управлять параметрами шлюза, включая масштабирование шлюза.

    • Владелец
    • Участник
    • Читатель

Начало работы с рабочей областью

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

Чтобы приступить к управлению, защите и публикации API в рабочей области, ознакомьтесь со следующими рекомендациями.

Ресурс Руководство
Программные интерфейсы Учебник. Импорт и публикация первого API
Продукты Руководство по создавать и публиковать продукт;
Подписки Подписки в службе управления API Azure

Создание подписок в Управление API
Политики Руководство. Преобразование и защита API

Политики в службе управления API Azure

Установка или изменение политик Управление API
Именованные значения Управление секретами с помощью именованных значений
Серверные компоненты Использование серверных компонентов в Azure Управление API
Фрагменты политики Повторное использование конфигураций политик в определениях политик Управление API
Схемы Проверка содержимого
Группы Создание и использование групп для управления учетными записями разработчиков
Notifications Настройка уведомлений и шаблонов уведомлений

Связанный контент