synchronizationJob リソースの種類

名前空間: microsoft.graph

重要

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

同期を実行するには、定期的にバックグラウンドで実行し、1 つのディレクトリで変更をポーリングし、別のディレクトリにプッシュします。 同期ジョブは常に、テナント内のアプリケーションの特定のインスタンスに固有です。 同期ジョブのセットアップの一環として、ターゲット ディレクトリ内のオブジェクトの読み取りおよび書き込みを承認し、ジョブの同期スキーマをカスタマイズする必要があります。

メソッド

メソッド	戻り値の型	説明
リスト	synchronizationJob コレクション	特定のアプリケーション インスタンス (サービス プリンシパル) の既存のジョブを一覧表示します。
SynchronizationJob を取得する	synchronizationJob	synchronizationJob オブジェクトのプロパティとリレーションシップを読み取る。
Create	synchronizationJob	特定のアプリケーションの新しいジョブを作成します。
開始	なし	同期を開始します。 ジョブが一時停止状態の場合は、ジョブが一時停止した時点から続行されます。 ジョブが検疫内にある場合、検疫の状態はクリアされます。
Restart	なし	ジョブを強制的に最初から実行し、ディレクトリ内のすべてのオブジェクトを再処理します。
Pause	なし	同期を一時的に停止します。 ジョブの状態を含むすべての進行状況が保持され 、Start 呼び出しが行われたときにジョブが終了した場所からジョブが続行されます。
Delete	なし	同期を停止し、ジョブに関連付けられているすべての状態を完全に削除します。
synchronizationSchema を取得する	synchronizationSchema	ジョブの有効な同期スキーマを取得します。
synchronizationSchema の更新	なし	ジョブの同期スキーマを更新します。
資格情報を検証する	なし	指定された資格情報をターゲット ディレクトリに対してテストします。
provisionOnDemand	synchronizationJobApplicationParameters コレクション	準備されるオブジェクトと実行される同期ルールを表します。 このリソースは、主にオンデマンド プロビジョニングに使用されます。

プロパティ

プロパティ	型	説明
id	String	一意の同期ジョブ識別子。 読み取り専用です。
schedule	synchronizationSchedule	ジョブの実行に使用するスケジュール。 読み取り専用です。
status	synchronizationStatus	ジョブの状態。ジョブが最後に実行された時間、現在のジョブの状態、およびエラーが含まれます。
synchronizationJobSettings	keyValuePair	ジョブに関連付けられている設定。 一部の設定はテンプレートから継承されます。
templateId	String	このジョブが 基づく 同期テンプレートの識別子。

リレーションシップ

リレーションシップ	型	説明
schema	synchronizationSchema	ジョブ用に構成された同期スキーマ。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "id": "String (identifier)",
  "schedule": {"@odata.type": "microsoft.graph.synchronizationSchedule"},
  "status": {"@odata.type": "microsoft.graph.synchronizationStatus"},
  "synchronizationJobSettings": {"@odata.type": "microsoft.graph.keyValuePair"},
  "templateId": "String"
}