directoryRole：delta

  • 项目

命名空间：microsoft.graph

获取新创建、更新或删除的目录角色，而无需执行整个资源集合的完整读取。 有关详细信息 ，请参阅使用增量查询 。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） RoleManagement.Read.Directory Directory.Read.All、Directory.ReadWrite.All、RoleManagement.ReadWrite.Directory
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 RoleManagement.Read.Directory Directory.Read.All、Directory.ReadWrite.All、RoleManagement.ReadWrite.Directory

HTTP 请求

若要开始跟踪更改，请对 directoryRole 资源发出包含 delta 函数的请求。

GET /directoryRoles/delta

查询参数

跟踪更改会导致一轮或多次 增量 函数调用。 如果要使用任意查询参数（$deltatoken 和 $skiptoken 除外），则必须在最初的 delta 请求中指定它。 Microsoft Graph 自动将指定的任意参数编码为响应中提供的 @odata.nextLink 或 @odata.deltaLink URL 的令牌部分。 只需预先指定所需的任何查询参数一次。 在后续请求中，可以复制并应用之前响应中返回的 @odata.nextLink 或 @odata.deltaLink URL，因为此 URL 已包含所需的编码参数。

查询参数 类型 说明
$deltatoken string 在上一个 delta 函数的 URL 中@odata.deltaLink返回的状态令牌调用同一资源集合，指示完成这一轮更改跟踪。 将此令牌包含在对该集合的下一组更改追踪的首次请求中，并保存和应用整个 @odata.deltaLink URL。
$skiptoken string 在上一个 delta 函数调用的 URL 中@odata.nextLink返回的状态令牌，指示要在同一资源集合中跟踪进一步的更改。

OData 查询参数

此方法支持 OData 查询参数来帮助自定义响应。

  • 像在任何 GET 请求中一样，你可以使用 $select 查询参数以仅指定获取最佳性能所需的属性。 始终返回 id 属性。

  • 提供对 $filter 的有限支持：

    • 唯一支持的 $filter 表达式用于跟踪特定资源的更改，其 ID 为 或 $filter=id+eq+{value}$filter=id+eq+{value1}+or+id+eq+{value2}。 可以指定的 ID 数受最大 URL 长度的限制。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json

请求正文

请勿提供此方法的请求正文。

响应

如果成功，此方法在响应正文中返回响应 200 OK 代码和 directoryRole 集合对象。 该响应还包括 @odata.nextLinkURL 或 @odata.deltaLinkURL。

  • @odata.nextLink如果返回 URL，则会在会话中检索其他数据页。 应用程序继续使用 @odata.nextLink URL 发出请求，直到响应中包含 @odata.deltaLink URL。

  • @odata.deltaLink如果返回 URL，则不会再有有关要返回的资源的现有状态的数据。 保存 @odata.deltaLink URL 并在下一个 增量 调用中应用它，以了解将来对资源的更改。

示例

请求

GET https://graph.microsoft.com/v1.0/directoryRoles/delta

响应

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryRoles",
  "@odata.nextLink": "https://graph.microsoft.com/v1.0/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"
          }
        }
      ]
    }
  ]
}

相关内容