servicePrincipal: delta
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
リソース コレクション全体の完全な読み取りを実行することなく、新しく作成、更新、または削除されたサービス プリンシパルを取得します。 詳細については、「 デルタ クエリを使用して Microsoft Graph データの変更を追跡する 」を参照してください。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
アクセス許可
この 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
クエリ パラメーター
変更を追跡すると、1 つ以上の デルタ 関数呼び出しのラウンドが発生します。 任意のクエリ パラメーター ($deltatoken と$skiptoken以外) を使用する場合は、最初のデルタ要求でこれを指定する必要があります。 Microsoft Graph は、応答で提供される @odata.nextLink または @odata.deltaLink の URL のトークン部分に指定したパラメーターを自動的にエンコードします。
必要なクエリ パラメーターを前もって 1 回指定しておくだけで済みます。
その後の要求では、前の応答で得られた @odata.nextLink や @odata.deltaLink の URL をコピーして適用します。エンコード済みの必要なパラメーターがこの URL に既に含まれているためです。
| クエリ パラメーター | 種類 | 説明 |
|---|---|---|
| $deltatoken | string | 同じリソース コレクションに対する@odata.deltaLink前のデルタ関数呼び出しの URL で返された状態トークン。変更追跡のラウンドの完了を示します。 このコレクションについて、このトークンを含む、@odata.deltaLink URL 全体を次の変更追跡のラウンドの最初の要求に保存し、適用します。 |
| $skiptoken | string | 前のデルタ関数呼び出しの 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 も含まれます。
URL が返される場合は、セッションに取得するデータの追加ページがあります。
@odata.nextLinkアプリケーションは、応答に URL が含まれるまで、URL を使用@odata.nextLinkして@odata.deltaLink要求を行い続けます。@odata.deltaLinkURL が返された場合、返されるリソースの既存の状態に関するデータはそれ以上ありません。 URL を@odata.deltaLink永続化して使用して、今後のリソースの変更について学習します。
参照:
-
詳細については、Delta Query を使用 する
- 要求の例に対するユーザーの増分変更を取得します。
例
要求
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
}
]
}