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

Прямое управление Управление API REST API

  • Статья

Azure Управление API предоставляет REST API прямого управления для выполнения операций с выбранными сущностями, такими как пользователи, группы, продукты и подписки. API прямого управления может обойти определенные ограничения API на основе Resource Manager Azure, например регулирование запросов.

Важно!

В этом разделе описывается, как получить доступ к непосредственному управлению Управление API REST API. Этот API имеет механизм проверки подлинности, отличный от Azure Resource Manager, и использует другой базовый URL-адрес.

Включение доступа к REST API прямого управления

Для успешного выполнения вызовов необходимо предоставить доступ к Управление API REST API прямого управления.

  1. Перейдите к экземпляру Управления API Azure на портале Azure.

  2. Выберите API управления в разделе Развертывание и инфраструктура меню слева.

    Выберите API управления в портал Azure

  3. В разделе Включить УПРАВЛЕНИЕ API REST API выберите Да.

    Важно!

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

    Включение API Управление API в портал Azure

Тип носителя по умолчанию

Для запросов и ответов по умолчанию используется тип носителя application/json. Если указано, некоторые операции поддерживают другие типы содержимого. Если для конкретной операции дополнительный тип содержимого не указывается, в качестве типа носителя используется application/json.

Аутентификация

Каждый запрос к УПРАВЛЕНИЕ API REST API должен сопровождаться заголовкомAuthorization, содержащим допустимый общий маркер доступа, как показано в следующем примере.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Маркер доступа можно создать программным способом или воспользоваться порталом издателя управления API. Инструкции по созданию и получению маркера доступа см. в разделах Создание маркера доступа вручную и Создание маркера доступа программным способом.

Базовый URL-адрес

Базовый URL-адрес прямого управления Управление API REST API соответствует следующему шаблону.

https://{servicename}.management.azure-api.net

Этот шаблон содержит следующий параметр.

  • {serviceName} — это имя службы в виде, указанном во время создания службы, например https://contosoapi.management.azure-api.net.

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

Версия параметра запроса

Все операции, за исключением параметра запроса api-version со значением в формате YYYY-MM-DD, например 2021-08-01.

Примечание

В период предварительной версии для Управление API REST API -preview добавляется к параметру запроса версии, например 2021-04-01-preview.

Если этот параметр запроса не передается в строке запроса запроса, сервер вернет код 400 Bad Requestсостояния . Список поддерживаемых версий см. в Управление API справочнике по REST API.

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