synchronizationJob リソースの種類

名前空間: microsoft.graph

重要

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

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

メソッド

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

プロパティ

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

リレーションシップ

リレーションシップ 説明
bulkUpload bulkUpload ジョブの一括アップロード操作。
スキーマ 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"
}