同期スキーマリソースの種類synchronizationSchema resource type

名前空間: microsoft.graphNamespace: microsoft.graph

重要

/betaMicrosoft Graph のバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。Use of these APIs in production applications is not supported. API が v2.0 で利用できるかどうかを確認するには、 バージョン セレクターを使用します。To determine whether an API is available in v1.0, use the Version selector.

同期されるオブジェクトと、それらの同期方法を定義します。Defines what objects will be synchronized and how they will be synchronized. 同期スキーマには、特定の同期ジョブの設定情報の大部分が含まれています。The synchronization schema contains most of the setup information for a particular synchronization job. 通常、 属性マッピングの一部をカスタマイズするか、特定の条件を満たすオブジェクトのみを同期する スコープフィルター を追加します。Typically, you will customize some of the attribute mappings, or add a scoping filter to synchronize only objects that satisfy a certain condition.

次のセクションでは、同期スキーマの高レベルのコンポーネントについて説明します。The following sections describe the high-level components of the synchronization schema.

ディレクトリ定義Directory definitions

ディレクトリ定義 は、ディレクトリとそのオブジェクトに関する同期エンジン情報を提供します。Directory definitions provide the synchronization engine information about directories and their objects. たとえば、ディレクトリ定義は、Azure AD ディレクトリに、 ユーザーグループという名前のオブジェクトがあり、それらのオブジェクトに対してサポートされている属性、およびそれらの属性の種類があることを同期エンジンに通知します。For example, the directory definition tells the synchronization engine that an Azure AD directory has objects named user and group, which attributes are supported for those objects, and the types for those attributes. 同期ルール/オブジェクトマッピングで特定のオブジェクトおよび属性を使用するためには、それらをディレクトリ定義の一部として定義する必要があります。In order for a particular object and attribute to be used in synchronization rules/object mappings, they have to be defined as part of the directory definition.

同期ルールSynchronization rules

同期ルール は、同期のセットアップの中核となります。Synchronization rules are the core of the synchronization setup. 同期エンジンの同期を実行する方法を定義します。これには、同期する必要があるオブジェクト、ソースディレクトリのオブジェクトをターゲットディレクトリのオブジェクトと照合する方法、ソースからターゲットディレクトリへの同期時に属性を変換する方法などがあります。They define for the synchronization engine how the synchronization should be performed, including what objects should be synchronized, how objects from the source directory should be matched with objects in the target directory, and how attributes should be transformed when they're synchronized from the source to the target directory.

オブジェクトマッピングObject mappings

オブジェクトマッピング は、同期ルールの主な部分です。Object mappings are the main part of the synchronization rule. 各オブジェクトマッピングは、指定されたオブジェクトをソースからターゲットディレクトリへ同期する方法を定義します。Each object mapping defines how a given object should be synchronized from the source to the target directory. 特に、マッピングでは、ソースディレクトリ内のオブジェクトとターゲットディレクトリのオブジェクトとの照合方法を定義します。オブジェクトをプロビジョニングするかどうかを決定するために使用するスコープフィルター、およびソースからターゲットディレクトリへの同期時にオブジェクト属性を変換する方法が定義されています。In particular, the mapping defines how an object in the source directory should be matched with an object in the target directory, what (if any) scoping filters should be used to decide whether to provision an object, and how object attributes should be transformed when they're synchronized from the source to the target directory.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
スキーマを取得するGet schema 同期スキーマsynchronizationSchema 同期スキーマオブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of the synchronizationSchema object.
スキーマを更新するUpdate schema なしNone 同期スキーマを更新します。Update the synchronization schema.
スキーマの削除Delete schema なしNone カスタマイズしたスキーマを削除し、スキーマを既定の構成にリセットします。Delete the customized schema, resetting the schema to the default configuration.
リストフィルター演算子List filter operators Filter演算子スキーマ コレクションfilterOperatorSchema collection スコープフィルターでサポートされているすべての演算子を一覧表示します。List all operators supported in the scoping filters.
リスト属性マッピング関数List attribute mapping functions attributeMappingFunctionSchema コレクションattributeMappingFunctionSchema collection 属性マッピング式でサポートされているすべての関数を一覧表示します。List all functions supported in the attribute mapping expressions.
解析属性マッピング式Parse attribute mapping expression Parseexpression ResponseparseExpressionResponse 文字列式を attributeMappingSource オブジェクトに解析します。Parse a string expression into an attributeMappingSource object.

プロパティProperties

プロパティProperty 種類Type 説明Description
idid StringString スキーマの一意識別子。Unique identifier for the schema.
同期規則synchronizationRules 同期ルール のコレクションsynchronizationRule collection 同期 ジョブ または同期の テンプレート用に構成されている同期ルールのコレクション。A collection of synchronization rules configured for the synchronizationJob or synchronizationTemplate.
versionversion StringString スキーマのバージョンは、すべてのスキーマ変更によって自動的に更新されます。The version of the schema, updated automatically with every schema change.

関係Relationships

リレーションシップRelationship Type 説明Description
移動directories Directorydefinition コレクションdirectoryDefinition collection ディレクトリおよびその中のすべてのオブジェクトのコレクションを格納します。Contains the collection of directories and all of their objects.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。The following is a JSON representation of the resource.

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