synchronizationSchema リソースの種類

名前空間: microsoft.graph

重要

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

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

次のセクションでは、同期スキーマの高レベルのコンポーネントについて説明します。 詳細については、「Microsoft Entra スキーマと属性マッピングについて - Active Directory から Microsoft Entra ID へ」を参照してください。

ディレクトリ定義

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

同期ルール

同期ルール は、同期セットアップの中核となる部分です。 これらのライブラリは、同期エンジンに対して、同期を実行する方法を定義します。これには、同期するオブジェクト、ソース ディレクトリのオブジェクトとターゲット ディレクトリのオブジェクトを照合する方法、ソース ディレクトリからターゲット ディレクトリに同期するときに属性がどのように変換されるかなどが定義されています。

オブジェクト マッピング

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

メソッド

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

プロパティ

プロパティ 説明
id 文字列 スキーマの一意識別子。
synchronizationRules synchronizationRule コレクション synchronizationJob または synchronizationTemplate に設定された同期ルールのコレクション。
version 文字列 スキーマのすべての変更時に自動的に更新されるスキーマのバージョン。

リレーションシップ

リレーションシップ 説明
ディレクトリ directoryDefinition コレクション ディレクトリとそのすべてのオブジェクトのコレクションが含まれます。

JSON 表記

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

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