administrativeUnit: delta
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получите только что созданные, обновленные или удаленные административные элементы без необходимости выполнять полное чтение всей коллекции ресурсов. Дополнительные сведения см . в разделе Использование разностного запроса для отслеживания изменений в данных Microsoft Graph .
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | AdministrativeUnit.Read.All | AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Приложение | AdministrativeUnit.Read.All | AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Важно!
В делегированных сценариях с рабочими или учебными учетными записями вошедшего пользователя должен быть участником или ему должна быть назначена поддерживаемая роль Microsoft Entra или настраиваемая роль с разрешением поддерживаемой роли. Для этой операции поддерживаются следующие роли с наименьшими привилегиями.
- Читатели каталогов — чтение основных свойств и членов административных единиц
- Global Reader — чтение всех свойств административных единиц, включая членов
- Администратор привилегированных ролей. Полностью управляйте административными единицами, включая членов, но за исключением ограниченных административных единиц. Дополнительные сведения см. в разделе Ограниченные административные единицы управления в Microsoft Entra ID
HTTP-запрос
Чтобы начать отслеживание изменений, необходимо выполнить запрос, включающий функцию delta в ресурсе administrativeUnit .
GET /administrativeUnits/delta
Параметры запроса
При отслеживании изменений выполняется цикл из одного или нескольких вызовов разностных функций. Если вы используете параметры запроса, отличные от $deltatoken
и $skiptoken
, их необходимо указать в начальном запросе delta. Microsoft Graph автоматически кодирует указанные параметры в маркере, входящем в состав URL-адреса @odata.nextLink
или @odata.deltaLink
, включенного в отклик.
Все параметры запроса необходимо указать только один раз.
В последующих запросах скопируйте и примените @odata.nextLink
URL-адрес или @odata.deltaLink
из предыдущего ответа. Этот URL-адрес уже включает закодированные параметры.
Параметр запроса | Тип | Описание |
---|---|---|
$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}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успешного выполнения этот метод возвращает 200 OK
код отклика и объект коллекции administrativeUnit в тексте отклика. Отклик также содержит URL-адрес @odata.nextLink
или @odata.deltaLink
.
Если возвращается URL-адрес
@odata.nextLink
, это означает, что во время сеанса получены не все страницы данных. AdministrativeUnit продолжает выполнять запросы с использованием@odata.nextLink
URL-адреса, пока URL-адрес не@odata.deltaLink
будет включен в ответ.Если возвращается URL-адрес
@odata.deltaLink
, это означает, что больше нет данных о текущем состоянии ресурса. Сохраните@odata.deltaLink
и используйте URL-адрес, чтобы узнать об изменениях в ресурсе в будущем.
Дополнительные сведения и пример см. в разделах Использование разностного запроса и Получение добавочных изменений для пользователей.
Пример
Запрос
GET https://graph.microsoft.com/beta/administrativeUnits/delta
Отклик
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#administrativeunits",
"@odata.nextLink":"https://graph.microsoft.com/beta/administrativeunits/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"displayName": "Management Fast Track",
"visibility": null,
"extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType": "School",
"extension_fe2174665583431c953114ff7268b7b3_Education_StateId": "WA",
"extension_fe2174665583431c953114ff7268b7b3_Education_Address": "2 Microsoft Way",
"extension_fe2174665583431c953114ff7268b7b3_Education_City": "Redmond",
"extension_fe2174665583431c953114ff7268b7b3_Education_State": "WA",
"extension_fe2174665583431c953114ff7268b7b3_Education_Country": "US",
"extension_fe2174665583431c953114ff7268b7b3_Education_Zip": "98052",
"extension_fe2174665583431c953114ff7268b7b3_Education_Phone": "555-123-4567",
"extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource": "SIS",
"extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId": "10002",
"extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalSyncSourceId": "14008",
"extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalName": "Amy Roebuck",
"extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalEmail": "aroebuck@principal.edu",
"extension_fe2174665583431c953114ff7268b7b3_Education_SchoolZone": "1",
"id": "8a07f5a8-edc9-4847-bbf2-dde106594bf4",
"members@delta": [
{
"@odata.type": "#microsoft.graph.user",
"id": "b66ecf79-a093-4d51-86e0-efcc4531f37a"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "5bde3e51-d13b-4db1-9948-fe4b109d11a7"
},
{
"@odata.type": "#microsoft.graph.group",
"id": "801f2093-de7e-4883-a786-8a5f30874ff4"
},
{
"@odata.type": "#microsoft.graph.group",
"id": "7e4ec76c-8276-43ef-ba10-9aaa197cb212"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "f5289423-7233-4d60-831a-fe107a8551cc"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "48d31887-5fad-4d73-a9f5-3c356e68a038"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "c03e6eaa-b6ab-46d7-905b-73ec7ea1f755"
}
]
}
]
}