synchronizationSchema リソースの種類

[アーティクル]
06/01/2021

名前空間: microsoft.graph

重要

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

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

以下のセクションでは、同期スキーマの高レベルのコンポーネントについて説明します。

ディレクトリ定義

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

同期ルール

同期ルールは、同期セットアップのコアです。同期エンジンは、同期の実行方法を定義します。同期の対象となるオブジェクト、ソースディレクトリのオブジェクトをターゲットディレクトリ内のオブジェクトと一致する方法、ソースディレクトリからターゲットディレクトリに同期するときに属性を変換する方法などです。

オブジェクトマッピング

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

メソッド

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

プロパティ

プロパティ	型	説明
id	String	スキーマの一意の識別子。
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"
}