servicePrincipal: delta

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

获取新创建、更新或删除的服务主体,而无需执行整个资源集合的完全读取。 有关详细信息,请参阅 使用增量查询跟踪Microsoft Graph 数据中的更改

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

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

权限

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

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

HTTP 请求

若要开始跟踪更改,请通过在 servicePrincipal 资源上包括 delta 函数来发出请求。

GET /servicePrincipals/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 查询参数来帮助自定义响应。

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

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

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

请求标头

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

请求正文

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

响应

如果成功,此方法在响应正文中返回响应 200 OK 代码和 servicePrincipal 集合对象。 响应还包括 nextLink URL 或 deltaLink URL。

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

  • @odata.deltaLink如果返回 URL,则不再有有关要返回的资源的现有状态的数据。 持久保存并使用 @odata.deltaLink URL 来了解将来对资源的更改。

请参阅:

示例

请求

GET https://graph.microsoft.com/beta/servicePrincipals/delta

响应

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

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#servicePrincipals",
  "@odata.nextLink":"https://graph.microsoft.com/beta/servicePrincipals/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
     {
      "accountEnabled": true,
      "addIns": [
        {
          "id": "id-value",
          "type": "type-value",
          "properties": [
            {
              "key": "key-value",
              "value": "value-value"
            }
          ]
        }
      ],
      "appDisplayName": "appDisplayName-value",
      "appId": "appId-value",
      "appOwnerOrganizationId": "appOwnerOrganizationId-value",
      "appRoleAssignmentRequired": true
    }
  ]
}