synchronizationJob リソースの種類

名前空間: microsoft.graph

重要

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

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

メソッド

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

プロパティ

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

リレーションシップ

リレーションシップ 型 説明
bulkUpload bulkUpload ジョブの一括アップロード操作。
objectConnections objectConnection コレクション ジョブに含まれるコネクタ データ ストア リンケージ レコード。 パブリック プレビュー中に、既知の objectId を使用して個々の接続を取得するか、その接続を削除してキャッシュされたリンケージをクリアします。 コレクションの一覧はサポートされておらず、 400 Bad Requestが返されます。
スキーマ 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"
}
  • 最終更新: