フィードバック 編集

directoryRole: delta

  • [アーティクル]

名前空間: microsoft.graph

リソース コレクション全体の完全な読み取りを実行することなく、新しく作成、更新、または削除されたディレクトリ ロールを取得します。 詳細については、「 Delta Query の使用 」を参照してください。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション RoleManagement.Read.Directory, Directory.Read.All, RoleManagement.ReadWrite.Directory, Directory.ReadWrite.All

HTTP 要求

変更の追跡を開始するには、directoryRole リソースの デルタ 関数を含む要求を行います。

GET /directoryRoles/delta

クエリ パラメーター

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

クエリ パラメーター 種類 説明
$deltatoken string 同じリソース コレクションの前の デルタ 関数呼び出しの URL で@odata.deltaLink返された 状態トークン。変更のラウンド追跡が完了したことを示します。 このコレクションについて、このトークンを含む、@odata.deltaLink URL 全体を次の変更追跡のラウンドの最初の要求に保存し、適用します。
$skiptoken string 前の 差分 関数呼び出しの URL で@odata.nextLink返された 状態トークン。同じリソース コレクションで追跡する変更がさらに存在することを示します。

OData クエリ パラメーター

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

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

  • $filter に対するサポートには制限があります。

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

要求ヘッダー

名前 説明
Authorization Bearer <token>
Content-Type application/json

要求本文

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

応答

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

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

  • URL が返される場合、返されるリソースの既存の状態に関するデータはありません。 URL を保存 @odata.deltaLink し、次の 差分 呼び出しで適用して、今後のリソースの変更について学習します。

例

要求

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

関連項目