servicePrincipal: delta

リソース コレクション全体の完全な読み取りを実行することなく、新しく作成、更新、または削除されたサービス プリンシパルを取得します。 詳細については、「 デルタ クエリを使用して Microsoft Graph データの変更を追跡する 」を参照してください。

この API は、次の国内クラウド展開で使用できます。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

HTTP 要求

変更の追跡を開始するには、servicePrincipal リソースに delta 関数を含めて要求を行います。

GET /servicePrincipals/delta

クエリ パラメーター

変更を追跡すると、1 つ以上の デルタ 関数呼び出しのラウンドが発生します。 任意のクエリ パラメーター ($deltatoken と$skiptoken以外) を使用する場合は、最初のデルタ要求でこれを指定する必要があります。 Microsoft Graph は、応答で提供される @odata.nextLink または @odata.deltaLink の URL のトークン部分に指定したパラメーターを自動的にエンコードします。 必要なクエリ パラメーターを前もって 1 回指定しておくだけで済みます。 その後の要求では、前の応答で得られた @odata.nextLink や @odata.deltaLink の URL をコピーして適用します。エンコード済みの必要なパラメーターがこの URL に既に含まれているためです。

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

このメソッドは、応答をカスタマイズするための OData クエリ パラメーターをサポートします。

• GET 要求と同様に、 $select クエリ パラメーターを使用して、最適なパフォーマンスを得るために必要なプロパティのみを指定できます。 id プロパティは常に返されます。

• $filterのサポートは限られています。

  • サポートされている $filter 式は、ID ( $filter=id+eq+{value} または $filter=id+eq+{value1}+or+id+eq+{value2}) によって、特定のリソースの変更を追跡することです。 指定できる ID の数は、URL の最大長によって制限されます。

要求ヘッダー

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと servicePrincipal コレクション オブジェクトを応答本文に返します。 応答には、nextLink URL または deltaLink URL も含まれます。

• @odata.nextLink URL が返された場合、セッションで取得するデータのページが増えます。 アプリケーションは、応答に@odata.deltaLink URL が含まれるまで、@odata.nextLink URL を使用して要求を行い続けます。

• @odata.deltaLink URL が返された場合、返されるリソースの既存の状態に関するデータはそれ以上ありません。 @odata.deltaLink URL を永続化して使用して、今後のリソースの変更について学習します。

参照:

• 詳細については、Delta Query を使用 する
  
• 要求の例に対するユーザーの増分変更を取得します。
  

例

要求

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

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.ServicePrincipals.Delta.GetAsDeltaGetResponseAsync();

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
delta, err := graphClient.ServicePrincipals().Delta().GetAsDeltaGetResponse(context.Background(), nil)

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.servicePrincipals().delta().get();

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/servicePrincipals/delta')
	.get();

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->servicePrincipals()->delta()->get()->wait();

Import-Module Microsoft.Graph.Applications

Get-MgServicePrincipalDelta

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.service_principals.delta.get()

応答

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

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