directoryRole: delta
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получение только что созданных, обновленных или удаленных ролей каталога без необходимости выполнять полное чтение всей коллекции ресурсов. Дополнительные сведения см. в статье Использование разностного запроса .
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | RoleManagement.Read.Directory | Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Приложение | RoleManagement.Read.Directory | Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory |
HTTP-запрос
Чтобы начать отслеживание изменений, необходимо выполнить запрос, включающий функцию delta для ресурса directoryRole.
GET /directoryRoles/delta
Параметры запроса
При отслеживании изменений выполняется цикл из одного или нескольких вызовов разностных функций. Если вы используете параметры запроса, отличные от $deltatoken
и $skiptoken
, их необходимо указать в начальном запросе delta. Microsoft Graph автоматически кодирует указанные параметры в маркере, входящем в состав URL-адреса @odata.nextLink
или @odata.deltaLink
, включенного в отклик.
Параметры запроса нужно указать только один раз в первом запросе.
Копируйте и применяйте URL-адрес @odata.nextLink
или @odata.deltaLink
из предыдущего ответа в последующих запросах, так как в нем уже содержаться закодированные параметры.
Параметр запроса | Тип | Описание |
---|---|---|
$deltatoken | string |
Маркер состояния, возвращенный в @odata.deltaLink URL-адресе предыдущего вызова разностной функции для той же коллекции ресурсов, что указывает на завершение этого цикла отслеживания изменений. Сохраните URL-адрес @odata.deltaLink с этим токеном и примените его в первом запросе следующего цикла отслеживания изменений для этой коллекции. |
$skiptoken | string |
Маркер состояния, возвращенный в @odata.nextLink URL-адресе предыдущего вызова разностной функции, указывающий, что в той же коллекции ресурсов необходимо отслеживать дальнейшие изменения. |
Необязательные параметры запросов
Этот метод поддерживает параметры запросов OData для настройки ответа.
Вы можете использовать параметр запроса
$select
так же, как в любом другом запросе GET, чтобы задать только те свойства, которые необходимы для эффективной работы. Свойство id возвращается всегда.Существует ограниченная поддержка :
$filter
- Единственное поддерживаемое
$filter
выражение — это отслеживание изменений для конкретных ресурсов по их идентификатору:$filter=id+eq+{value}
или$filter=id+eq+{value1}+or+id+eq+{value2}
. Число идентификаторов, которые можно указать, ограничено максимальной длиной URL-адреса.
- Единственное поддерживаемое
Заголовки запросов
Имя | Описание |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Content-Type | application/json |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успешного выполнения этот метод возвращает код отклика 200 OK
и объект коллекции directoryRole в тексте отклика. Ответ также содержит URL-адрес nextLink или URL-адрес deltaLink.
Если возвращается URL-адрес
@odata.nextLink
, это означает, что во время сеанса получены не все страницы данных. Приложение продолжает отправлять запросы, используя URL-адрес@odata.nextLink
, пока в отклик не будет включен URL-адрес@odata.deltaLink
.Если возвращается URL-адрес
@odata.deltaLink
, это означает, что больше нет данных о текущем состоянии ресурса. Сохраните@odata.deltaLink
и используйте URL-адрес, чтобы узнать об изменениях в ресурсе в будущем.
См. следующие статьи:
-
Дополнительные сведения об использовании разностного запроса
-
Получение добавочных изменений для пользователей для примера запроса.
Пример
Запрос
GET https://graph.microsoft.com/beta/directoryRoles/delta
Отклик
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#directoryRoles",
"@odata.nextLink": "https://graph.microsoft.com/beta/directoryRoles/delta?$skiptoken=pkXMyA5aFCIMmH1Kk1XEAnf2X-fodqXKXF03gYPQknSHRxogVsxvSq_26nhos-O2-shortened",
"value": [
{
"description": "Device Administrators",
"displayName": "Azure AD Joined Device Local Administrator",
"roleTemplateId": "9f06204d-73c1-4d4c-880a-6edb90606fd8",
"id": "f8e85ed8-f66f-4058-b170-3efae8b9c6e5",
"members@delta": [
{
"@odata.type": "#microsoft.graph.user",
"id": "bb165b45-151c-4cf6-9911-cd7188912848",
"@removed": {
"reason": "deleted"
}
}
]
}
]
}