servicePrincipal: deltaservicePrincipal: delta

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

リソースコレクション全体の完全な読み取りを実行せずに、新しく作成、更新、または削除されたサービスプリンシパルを取得します。Get newly created, updated, or deleted service principals without having to perform a full read of the entire resource collection. 詳細については、「デルタクエリの使用」を参照してください。See Using Delta Query for details.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Directory.Read.All、Directory.ReadWrite.All、Directory.AccessAsUser.AllDirectory.Read.All, Directory.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Application.ReadWrite.All、Directory.Read.AllApplication.ReadWrite.All, Directory.Read.All

HTTP 要求HTTP request

変更の追跡を開始するには、servicePrincipal リソースにデルタ関数を含む要求を行います。To begin tracking changes, you make a request including the delta function on the servicePrincipal resource.

GET /servicePrincipals/delta

クエリ パラメーターQuery parameters

変更の追跡では、1回以上のデルタ関数呼び出しが発生します。Tracking changes incurs a round of one or more delta function calls. 任意のクエリ パラメーター ($deltatoken$skiptoken以外) を使用する場合は、最初のデルタ要求でこれを指定する必要があります。If you use any query parameter (other than $deltatoken and $skiptoken), you must specify it in the initial delta request. Microsoft Graph は、応答で提供される nextLink または deltaLink の URL のトークン部分に指定したパラメーターを自動的にエンコードします。Microsoft Graph automatically encodes any specified parameters into the token portion of the nextLink or deltaLink URL provided in the response. 必要なクエリ パラメーターを前もって 1 回指定しておくだけで済みます。You only need to specify any desired query parameters once upfront. その後の要求では、前の応答で得られた nextLinkdeltaLink の URL をコピーして適用します。エンコード済みの必要なパラメーターがこの URL に既に含まれているためです。In subsequent requests, copy and apply the nextLink or deltaLink URL from the previous response, as that URL already includes the encoded, desired parameters.

クエリ パラメーターQuery parameter 種類Type 説明Description
$deltatoken$deltatoken stringstring 同じリソースコレクションに対する前deltaLinkデルタ関数呼び出しの URL で返された状態トークン。変更追跡のラウンドが終了したことを示します。A state token returned in the deltaLink URL of the previous delta function call for the same resource collection, indicating the completion of that round of change tracking. そのコレクションの次のdeltaLinkラウンドの変更追跡の最初の要求で、このトークンを含む URL 全体を保存して適用します。Save and apply the entire deltaLink URL including this token in the first request of the next round of change tracking for that collection.
$skiptoken$skiptoken stringstring 前のデルタ関数呼び出しのnextLink URL で状態トークンが返され、同じリソースコレクションに追跡すべき変更が他にもあることを示します。A state token returned in the nextLink URL of the previous delta function call, indicating there are further changes to be tracked in the same resource collection.

オプションのクエリ パラメーターOptional query parameters

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。This method supports OData Query Parameters to help customize the response.

  • 任意の GET リクエストと同様に $select クエリ パラメーターを使用して、最善のパフォーマンスを得るために必要なプロパティのみを指定することができます。Id プロパティは常に返されます。You can use a $select query parameter as in any GET request to specify only the properties your need for best performance. The id property is always returned.

  • $filter に対するサポートには制限があります。There is limited support for $filter:

    • サポートされ$filterている唯一の式は、id: $filter=id+eq+{value}または$filter=id+eq+{value1}+or+id+eq+{value2}を使用して特定のリソースの変更を追跡することです。The only supported $filter expression is for tracking changes for specific resources, by their id: $filter=id+eq+{value} or $filter=id+eq+{value1}+or+id+eq+{value2}. 指定できる id の数は、URL の最大の長さによって制限されます。The number of ids you can specify is limited by the maximum URL length.

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization Bearer <token>Bearer <token>
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、この200 OKメソッドは応答コードと、応答本文でserviceprincipalコレクションオブジェクトを返します。If successful, this method returns 200 OK response code and servicePrincipal collection object in the response body. 応答には、nextLink URL または deltaLink URL も含まれます。The response also includes a nextLink URL or a deltaLink URL.

  • URL が返される場合は、セッションに取得するデータの追加ページがあります。nextLinkIf a nextLink URL is returned, there are additional pages of data to be retrieved in the session. アプリケーションはdeltaLink URL が応答に含まれるまでnextLink URLを使用して要求を続けます。The application continues making requests using the nextLink URL until a deltaLink URL is included in the response.

  • URL が返される場合、返されるリソースの既存の状態に関するデータはありません。If a deltaLink URL is returned, there is no more data about the existing state of the resource to be returned. 今後のリソースのdeltaLink変更点については、URL を永続化して使用してください。Persist and use the deltaLink URL to learn about changes to the resource in the future.

参照先:See:

Example

要求Request
GET https://graph.microsoft.com/beta/servicePrincipals/delta
応答Response

注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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
    }
  ]
}