administrativeUnit: delta

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

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

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

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ✅ ✅ ✅

アクセス許可

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

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AdministrativeUnit.Read.All AdministrativeUnit.ReadWrite.All、Directory.Read.All、Directory.ReadWrite.All

重要

職場または学校アカウントを使用してアクセスを委任する場合、サインインしたユーザーがメンバー ユーザーであるか、サポートされている Microsoft Entra ロール、またはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 この操作では、必要最小限の特権のみを提供する次の組み込みロールがサポートされます。

  • ディレクトリ閲覧者 - 基本 プロパティと管理単位のメンバーの読み取り
  • グローバル閲覧者 - メンバーを含む管理単位 のすべてのプロパティを 読み取ります
  • 特権ロール管理者 - メンバーを含む管理単位を完全に管理しますが、制限された管理単位は除きます。 詳細については、「Microsoft Entra ID の制限された管理単位に関するページを参照してください

HTTP 要求

変更の追跡を開始するには、 administrativeUnit リソースに対するデルタ関数を含む要求を作成します。

GET /administrativeUnits/delta

クエリ パラメーター

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

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

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

このメソッドは、応答をカスタマイズするために次の 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 応答コードと応答本文の AdministrativeUnit コレクション オブジェクトを返します。 応答には @odata.nextLink URL または @odata.deltaLink URLも含まれます。

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

  • URL が返される場合、返されるリソースの既存の状態に関するデータはありません。 @odata.deltaLink URL を保持して使用し、今後のリソースの変更を確認します。

詳細と例については、「 デルタ クエリの使用 」および 「ユーザーの増分変更の取得」を参照してください。

例

要求

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

応答

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

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#administrativeunits",
  "@odata.nextLink":"https://graph.microsoft.com/beta/administrativeunits/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
    {
      "displayName": "Management Fast Track",
      "visibility": null,
      "extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType": "School",
      "extension_fe2174665583431c953114ff7268b7b3_Education_StateId": "WA",
      "extension_fe2174665583431c953114ff7268b7b3_Education_Address": "2 Microsoft Way",
      "extension_fe2174665583431c953114ff7268b7b3_Education_City": "Redmond",
      "extension_fe2174665583431c953114ff7268b7b3_Education_State": "WA",
      "extension_fe2174665583431c953114ff7268b7b3_Education_Country": "US",
      "extension_fe2174665583431c953114ff7268b7b3_Education_Zip": "98052",
      "extension_fe2174665583431c953114ff7268b7b3_Education_Phone": "555-123-4567",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource": "SIS",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId": "10002",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalSyncSourceId": "14008",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalName": "Amy Roebuck",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalEmail": "aroebuck@principal.edu",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SchoolZone": "1",
      "id": "8a07f5a8-edc9-4847-bbf2-dde106594bf4",
      "members@delta": [
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "b66ecf79-a093-4d51-86e0-efcc4531f37a"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "5bde3e51-d13b-4db1-9948-fe4b109d11a7"
        },
        {
            "@odata.type": "#microsoft.graph.group",
            "id": "801f2093-de7e-4883-a786-8a5f30874ff4"
        },
        {
            "@odata.type": "#microsoft.graph.group",
            "id": "7e4ec76c-8276-43ef-ba10-9aaa197cb212"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "f5289423-7233-4d60-831a-fe107a8551cc"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "48d31887-5fad-4d73-a9f5-3c356e68a038"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "c03e6eaa-b6ab-46d7-905b-73ec7ea1f755"
        }
      ]
  }
  ]
}