Что такое microsoft graph api
API Microsoft Graph
API Microsoft Graph — это веб-API RESTful, который позволяет получать доступ к ресурсам службы Microsoft Cloud. После регистрации приложения и получения токена проверки подлинности для пользователя или службы можно выполнять запросы к API Microsoft Graph. Дополнительные сведения см. в статье Обзор Microsoft Graph.
Microsoft Graph предоставляет REST API и клиентские библиотеки для доступа к данным в следующих службах Microsoft:
Версии
В настоящее время доступны следующие версии API Microsoft Graph:
Приступая к работе
Для чтения из ресурса (например, пользователя или сообщения электронной почты) или записи в него, создается запрос, который выглядит следующим образом:
Дополнительные сведения об элементах созданного запроса см. в разделе Использование API Microsoft Graph.
Доступны примеры быстрого запуска, которые показывают, как получить доступ к возможностям API Microsoft Graph. В доступных примерах рассматривается доступ к двум службам с использованием одной проверки подлинности: учетная запись Майкрософт и Outlook. При каждом быстром запуске осуществляется доступ к информации из профилей пользователей учетных записей Майкрософт и отображаются события из их календаря. Быстрые запуски можно разделить на четыре этапа:
По завершении быстрого запуска вы получаете готовое к работе приложение. Дополнительные сведения см. в разделе Вопросы и ответы по быстрым запускам в Microsoft Graph. Чтобы приступить к работе с примерами, см. статью Быстрые запуски в Microsoft Graph.
Инструменты
Microsoft Graph Explorer — это веб-инструмент, который можно использовать для создания и тестирования запросов к API Microsoft Graph. Он доступен по адресу https://developer.microsoft.com/graph/graph-explorer.
Postman — это еще один инструмент, который позволяет выполнять запросы к API Microsoft Graph. Скачать его можно по адресу https://www.getpostman.com. Для взаимодействия с Microsoft Graph в Postman используется коллекция Microsoft Graph Postman.
Дальнейшие действия
Дополнительные сведения о Microsoft Graph, включая инструкции и руководства по работе, см. в следующих статьях:
Обзор Microsoft Graph
Microsoft Graph открывает доступ к данным и средствам искусственного интеллекта в Microsoft 365. Благодаря этому вы получите единую модель программируемости, которую можно использовать для доступа к колоссальному объему данных в Microsoft 365, Windows 10 и Enterprise Mobility + Security. Используйте многочисленные данные в Microsoft Graph и создавайте приложения с миллионной аудиторией для организаций и пользователей.
Данные и службы для расширения возможностей платформы Microsoft 365
Три основных компонента платформы Microsoft 365 упрощают доступ к данным и их поток:
Одновременное использование API Microsoft Graph, соединителей и подключения к данным позволяет расширить возможности платформы Microsoft 365. Благодаря доступу к данным Microsoft Graph и другим наборам данных вы можете получить статистику и аналитику, расширить возможности Microsoft 365 и создавать уникальные интеллектуальные приложения.
Из чего состоит Microsoft Graph?
Microsoft Graph предоставляет интерфейсы REST API и клиентские библиотеки для доступа к данным в нижеуказанных облачных службах Майкрософт:
Что можно делать с помощью Microsoft Graph?
Microsoft Graph позволяет обрабатывать уникальный контекст пользователя и делать его более результативным. Представьте приложение, которое.
В качестве примера выберите первый сценарий поиска участников собрания. С помощью API Microsoft Graph вы можете:
С помощью связей вы можете перейти к другим ресурсам:
Microsoft Graph продолжает открывать возможности платформы Microsoft 365 для разработчиков, но исключительно при наличии соответствующих разрешений.
Популярные запросы API
Ознакомьтесь с некоторыми из популярных сценариев работы с API Microsoft Graph. Ссылки ведут на песочницу Graph.
| Операция | URL-адрес |
|---|---|
| GET мой профиль | https://graph.microsoft.com/v1.0/me |
| Получение своих файлов | https://graph.microsoft.com/v1.0/me/drive/root/children |
| Получение своей фотографии | https://graph.microsoft.com/v1.0/me/photo/$value |
| Получение своей почты | https://graph.microsoft.com/v1.0/me/messages |
| GET моя почта высокой важности | https://graph.microsoft.com/v1.0/me/messages?$filter=importance%20eq%20’high’ |
| GET события в моем календаре | https://graph.microsoft.com/v1.0/me/events |
| GET мой руководитель | https://graph.microsoft.com/v1.0/me/manager |
| GET последний пользователь, изменивший файл foo.txt | https://graph.microsoft.com/v1.0/me/drive/root/children/foo.txt/lastModifiedByUser |
| Получение групп Microsoft 365, участником которых я являюсь | https://graph.microsoft.com/v1.0/me/memberOf/$/microsoft.graph.group?$filter=groupTypes/any(a:a%20eq%20’unified’) |
| GET пользователи в моей организации | https://graph.microsoft.com/v1.0/users |
| GET группы в моей организации | https://graph.microsoft.com/v1.0/groups |
| GET пользователи, связанные со мной | https://graph.microsoft.com/v1.0/me/people |
| GET элементы, популярные в моей компании | https://graph.microsoft.com/beta/me/insights/trending |
| GET мои заметки | https://graph.microsoft.com/v1.0/me/onenote/notebooks |
Перенос данных из внешнего источника контента в Microsoft Graph
Используйте соединители Microsoft Graph для переноса данных, не входящих в Microsoft Cloud, в Microsoft Graph. Примерами таких данных могут быть база данных отдела кадров организации или каталог продуктов, размещенные локально, в общедоступных или частных облаках.
Соединители Microsoft Graph позволяют создавать подключения к внешним источникам данных, индексировать данные и хранить их как внешние настраиваемые элементы и файлы. После индексирования эти элементы могут отображаться в Поиске (Майкрософт), а также для приложений, использующих API Поиска (Майкрософт).
Масштабируемый доступ к данным Microsoft Graph с помощью подключения к данным Microsoft Graph
Используйте подключение к данным Microsoft Graph для получения масштабируемого доступа к данным в Microsoft Graph, предоставляя администраторам точечные разрешения и полный доступ к этим данным. Подключение к данным помогает оптимизировать их доставку в Microsoft Azure.
С помощью средств Azure можно создавать интеллектуальные приложения с такими функциями:
Когда следует использовать API Microsoft Graph или подключение к данным?
Microsoft Graph Data Connect предоставляет новый способ взаимодействия с данными, доступными с помощью интерфейсов API Microsoft Graph. Подключение к данным предоставляет уникальный набор инструментов, которые помогают оптимизировать создание интеллектуальных приложений в рамках облака Майкрософт.
Использование API Microsoft Graph
Microsoft Graph — это соответствующий ограничениям REST веб-API, обеспечивающий доступ к ресурсам службы Microsoft Cloud. После регистрации приложения и получения маркеров аутентификации для пользователя или службы можно отправлять запросы к API Microsoft Graph.
Важно! Изменяется принцип применения политик условного доступа к Microsoft Graph. Вам необходимо обновить свои приложения, чтобы они могли обрабатывать сценарии, в которых выполняется настройка политик условного доступа. Дополнительные сведения и рекомендации см. в статье Руководство для разработчиков по условному доступу в Azure Active Directory.
Пространство имен OData
Вызов метода API REST
Для чтения или записи ресурса, например пользователя или сообщения электронной почты, создайте запрос, показанный ниже:
После создания запроса возвращается ответ, который включает:
Методы HTTP
Чтобы определить функцию запроса, Microsoft Graph использует метод HTTP. API поддерживает перечисленные ниже методы.
Версия
Мы всегда рады отзывам о бета-версиях API. Чтобы оставить отзыв или предложить функцию, посетите наш форум идей для платформы разработчиков Microsoft 365.
Дополнительные сведения о версиях API см. в статье Управление версиями и поддержка.
Ресурс
Ресурс может быть объектом или сложным типом и обычно определяется с помощью свойств. Объекты всегда содержат свойство id, что отличает их от сложных типов.
Для доступа к каждому ресурсу могут потребоваться особые разрешения. Для создания и обновления ресурса часто требуется более высокий уровень разрешений, чем для чтения. Сведения о требуемых разрешениях см. в справочной статье о методе.
Параметры запроса
В качестве параметров запросов могут использоваться системные параметры запроса OData или другие строки, поддерживаемые методом для настройки ответа.
Вы можете использовать необязательные системные параметры запроса OData, чтобы изменять свойства, включаемые в ответ, находить элементы, соответствующие пользовательскому запросу, и указывать дополнительные параметры для метода.
Дополнительные сведения о параметрах запроса OData см. в статье Настройка ответов с помощью параметров запроса.
Инструменты для взаимодействия с Microsoft Graph
Песочница Graph
Песочница Graph — это веб-инструмент, который можно использовать для создания и тестирования запросов с помощью API Microsoft Graph. Песочница Graph доступна по адресу: https://developer.microsoft.com/graph/graph-explorer.
Вы можете получить доступ к демонстрационным данным без входа или войти в свой клиент. Чтобы отправить запрос, выполните следующее:
В следующем примере показан запрос, возвращающий сведения о пользователях в демонстрационном клиенте:
Примеры запросов представлены в песочнице Graph, чтобы вы могли быстрее запускать распространенные запросы. Чтобы просмотреть доступные примеры, выберите Показать другие примеры. Выберите Вкл для набора примеров, который вы хотите просмотреть, и после закрытия окна выбора должен появиться список готовых запросов.
После отправки запроса отображается код состояния и сообщение, а запрос выводится на вкладке Просмотр отклика.
Postman
Postman — это инструмент, который можно использовать для создания и тестирования запросов с помощью API Microsoft Graph. Вы можете скачать Postman по адресу: https://www.getpostman.com/. Чтобы взаимодействовать с Microsoft Graph в Postman, используйте коллекцию Microsoft Graph.
Дальнейшие действия
Все готово для настройки Microsoft Graph. Воспользуйтесь кратким руководством или начните с одного из пакетов SDK или примеров кода.
Microsoft Graph — это единый API для современной работы
Используйте данные и аналитику в Microsoft 365 для создания приложений, взаимодействующих с миллионами пользователей.
Расширенный контекст
Получайте расширенный контекст для приложений, например: на месте ли пользователь, кто его руководитель, с какими документами он работал в последнее время.
Глубокая аналитика
Получайте подробную статистику о тенденциях использования. Узнавайте, какие документы наиболее востребованы, в какое время лучше проводить собрания и с кем пользователи обычно работают.
Обновления в режиме реального времени
Реагируйте на изменения в данных Microsoft Graph в режиме реального времени. Изменяйте расписание собраний на основе ответов, уведомляйте остальных пользователей при изменении файлов и продолжайте процессы после их утверждения.
Широкая аудитория
Создавайте решения для корпоративных пользователей в Azure и Microsoft 365, пользователей служб Office Online (Outlook.com и OneDrive.com) или для всех категорий пользователей.
Последние новости о Microsoft Graph
Новые функции API Bookings Microsoft Graph обеспечивают улучшенную инфраструктуру резервирования
Мы выпустили несколько ключевых новых функций для предоставления инфраструктуры резервирования в API Bookings, чтобы клиенты могли создавать надежные настраиваемые решения.
Интерфейсы API Bookings Microsoft Graph теперь доступны в конечной точке версии 1
Мы рады объявить, что текущий набор API Bookings будет доступен в конечной точке версии 1. Новые функции включают такие возможности, как SMS-уведомления, собрания по сети, настраиваемые вопросы и групповые встречи.
Подключение к данным Microsoft Graph: развенчание заблуждений об областях пользователей
Подключение к данным Microsoft Graph позволяет массово извлекать данные из сред Microsoft 365 с помощью конвейеров Фабрики данных Azure. В этой статье описываются различные сценарии, которые помогут вам понять, как правильно использовать область пользователей в решениях Подключения к данным Microsoft Graph.
Подключение информационных сетей с помощью соединителей партнеров Microsoft Graph
Недавно в блоге «Поиск (Майкрософт)» были опубликованы сведения о текущих и будущих соединителях, которые создают наши привилегированные партнеры. Мы разместили здесь ссылку, чтобы вдохновить вас на создание вашего собственного настраиваемого соединителя.
Презентация общедоступной предварительной версии API задач To Do
На конференции Microsoft Ignite 2021 г. мы анонсировали выпуск закрытой предварительной версии нового API задач в Microsoft Graph. Сегодня мы с удовольствием сообщаем о выходе общедоступной предварительной версии API задач в конечной точке бета-версии.
Объявление о поддержке разностных запросов для API заданий Microsoft Graph
Мы рады сообщить, что API заданий в Microsoft Graph теперь поддерживает разностные запросы для определенных типов образовательных ресурсов, например educationAssignment и educationCategory.
Общие сведения о едином входе Azure AD для приложений Microsoft Teams
Для единого входа отсутствует одно определение, что порождает путаницу. Узнайте о подходах единого входа, используемых в Microsoft Commercial Marketplace (магазине приложений) и в приложении, запущенном в Microsoft Teams, чтобы вы могли начать создание единого входа для приложения Teams.
Присоединяйтесь к программе разработчиков Microsoft 365
Получите готовую песочницу, инструменты и ресурсы, чтобы создавать решения для платформы Microsoft 365, в том числе:
Доступ к данным и методам с помощью Microsoft Graph
Помимо чтения и записи данных с помощью API Microsoft Graph, вы можете использовать шаблоны запросов для просмотра ресурсов в Microsoft Graph. Документ метаданных поможет вам разобраться в модели данных ресурсов и отношений в Microsoft Graph.
Метаданные API Microsoft Graph
Документ метаданных ($metadata) публикуется в корневом каталоге службы. По указанным ниже URL-адресам можно просмотреть сервисный документ для версии 1.0 и бета-версии API Microsoft Graph.
Метаданные API Microsoft Graph 1.0
Метаданные API Microsoft Graph (бета-версия)
Метаданные позволяют разобраться в модели данных Microsoft Graph, в том числе типах объектов, сложных типах и перечислениях, из которых состоят ресурсы, представленные в пакетах запросов и откликов.
С помощью метаданных можно узнать об отношениях между объектами в Microsoft Graph и создать URL-адреса для перехода между ними.
Просмотр коллекции ресурсов
Например, можно получить коллекцию ресурсов user, определенных в клиенте:
При успешном выполнении запроса будет получен отклик 200 OK, который содержит полезные данные с коллекцией ресурсов user. Каждый объект user идентифицируется по свойству id и сопровождается свойствами по умолчанию. Полезные данные, показанные ниже, усечены для краткости.
Microsoft Graph позволяет также просматривать коллекции, переходя к нужному отношению, которым связаны ресурсы. Например, применяя свойство навигации mailFolders объекта user, вы можете запрашивать коллекцию ресурсов mailFolder в почтовом ящике пользователя:
При успешном выполнении запроса будет получен отклик 200 OK, который содержит полезные данные с коллекцией ресурсов mailFolder. Каждый объект mailFolder определяется по его свойству id и сопровождается другими свойствами. Полезные данные, показанные ниже, усечены для краткости.
Просмотр ресурса из коллекции по идентификатору
Еще раз приведем ресурс user в качестве примера. Чтобы просмотреть сведения об определенном пользователе, отправьте HTTPS-запрос GET, указав идентификатор объекта user. Для объекта user в качестве идентификатора можно использовать свойство id или userPrincipalName.
В следующем примере запроса в качестве идентификатора используется значение userPrincipalName.
При успешном выполнении запроса будет получен отклик 200 OK, содержащий полезные данные с представлением ресурса user, как показано ниже.
Чтение определенных свойств ресурса
При успешном выполнении запроса в отклике возвращаются полезные данные и состояние 200 OK, как показано ниже.
Здесь возвращаются не полные наборы свойств для объекта user, а только основные свойства aboutMe, displayName и skills.
Чтение отдельных свойств ресурсов в коллекции
Например, чтобы запросить имена элементов на диске вошедшего пользователя, можно отправить следующий HTTPS-запрос GET.
При успешном ответе возвращаются код состояния 200 OK и полезные данные, содержащие только имена общих файлов, как показано в следующем примере.
Переход от одного ресурса к другому с помощью отношения
Руководитель состоит в отношении directReports со своими подчиненными. Чтобы запросить список подчиненных пользователя, можно использовать приведенный ниже HTTPS-запрос GET для перехода к целевому объекту с помощью отношения.
При успешном выполнении запроса в отклике возвращаются полезные данные и состояние 200 OK, как показано ниже.
Аналогичным образом можно переходить к ресурсам, используя их отношения. Например, отношение user-messages позволяет перейти от пользователя Azure Active Directory (AD) к набору сообщений Outlook. В приведенном ниже примере показано, как это сделать в вызове REST API.
При успешном выполнении запроса в отклике возвращаются полезные данные и состояние 200 OK, как показано ниже.
Вызов действий и функций
Microsoft Graph также поддерживает действия и функции для выполнения с ресурсами действий, отличных от простых операций CRUD (создание, чтение, обновление и удаление). Они часто имеют форму HTTPS-запросов POST, принимающих аргументы для действия или функции. Например, с помощью указанного ниже действия вошедший пользователь ( me ) может отправить сообщение электронной почты.
Вы можете просмотреть все доступные функции в метаданных. Они отображаются как функции или действия.
Использование пакетов SDK Microsoft Graph
Вам нравятся возможности и удобство пакетов SDK? Вы всегда можете вызывать Microsoft Graph с помощью REST API, но мы также предоставляем пакеты SDK для многих популярных платформ. Обзор доступных пакетов SDK см. в разделе Примеры кода и пакеты SDK.