synchronizationSchema リソースの種類

名前空間: microsoft.graph

重要

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

同期するオブジェクトと同期方法を定義します。 同期スキーマには、特定の同期ジョブのセットアップ情報の大部分が含まれています。 通常、一部の 属性マッピングをカスタマイズするか、 スコープ フィルターを 追加して、特定の条件を満たすオブジェクトのみを同期します。

以降のセクションでは、同期スキーマの大まかなコンポーネントについて説明します。

ディレクトリ定義

ディレクトリ定義は、ディレクトリ とそのオブジェクトに関する同期エンジン情報を提供します。 たとえば、ディレクトリ定義は、Microsoft Entra ディレクトリに user と group という名前のオブジェクトがあり、それらのオブジェクトでサポートされている属性と、それらの属性の型があることを同期エンジンに伝えます。 特定のオブジェクトと属性を同期ルール/オブジェクト マッピングで使用するには、ディレクトリ定義の一部として定義する必要があります。

同期規則

同期規則 は、同期設定の中核です。 同期エンジンでは、同期を実行する方法 (同期する必要があるオブジェクト、ソース ディレクトリのオブジェクトとターゲット ディレクトリ内のオブジェクトとの照合方法、ソースからターゲット ディレクトリへの同期時に属性を変換する方法など) を定義します。

オブジェクト マッピング

オブジェクト マッピングは、同期規則のメイン部分です。 各オブジェクト マッピングは、特定のオブジェクトをソースからターゲット ディレクトリに同期する方法を定義します。 特に、マッピングでは、ソース ディレクトリ内のオブジェクトをターゲット ディレクトリ内のオブジェクトと一致させる方法、オブジェクトをプロビジョニングするかどうかを決定するためにスコープ フィルターを使用する (ある場合)、およびソースからターゲット ディレクトリに同期されるときにオブジェクト属性を変換する方法を定義します。

メソッド

メソッド	戻り値の型	説明
スキーマを取得する	synchronizationSchema	synchronizationSchema オブジェクトのプロパティとリレーションシップを読み取ります。
スキーマの更新	なし	同期スキーマを更新します。
スキーマの削除	なし	カスタマイズしたスキーマを削除し、スキーマを既定の構成にリセットします。
フィルター演算子を一覧表示する	filterOperatorSchema コレクション	スコープ フィルターでサポートされているすべての演算子を一覧表示します。
属性マッピング関数を一覧表示する	attributeMappingFunctionSchema コレクション	属性マッピング式でサポートされているすべての関数を一覧表示します。
属性マッピング式を解析する	parseExpressionResponse	文字列式を attributeMappingSource オブジェクトに解析します。

プロパティ

プロパティ	型	説明
id	文字列	スキーマの一意識別子。
synchronizationRules	synchronizationRule コレクション	synchronizationJob または synchronizationTemplate 用に構成された同期規則のコレクション。
version	String	スキーマのバージョン。スキーマの変更ごとに自動的に更新されます。

リレーションシップ

リレーションシップ	型	説明
ディレクトリ	directoryDefinition コレクション	ディレクトリとそのすべてのオブジェクトのコレクションを格納します。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "@odata.type": "#microsoft.graph.synchronizationSchema",
  "id": "String (identifier)",
  "synchronizationRules": [
    {
      "@odata.type": "microsoft.graph.synchronizationRule"
    }
  ],
  "version": "String"
}