synchronizationJob を再起動する

名前空間: microsoft.graph

停止した同期ジョブを再起動し、ディレクトリ内のすべてのオブジェクトを強制的に再処理します。 必要に応じて、既存の同期状態と以前のエラーをクリアします。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Synchronization.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション Application.ReadWrite.OwnedBy Synchronization.ReadWrite.All

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーがグループの所有者またはメンバーであるか、サポートされている Microsoft Entra ロール またはサポートされているロールのアクセス許可を持つカスタム ロールが割り当てられている必要があります。 この操作では、次の最小特権ロールがサポートされています。

  • アプリケーション管理者
  • クラウド アプリケーション管理者
  • ハイブリッド ID 管理者 - Microsoft Entra Cloud Sync を構成する

HTTP 要求

{servicePrincipalId} は、サービス プリンシパル オブジェクトの ID を 参照します。 id は、Microsoft Entra 管理センターのアプリ登録でエンタープライズ アプリケーションの オブジェクト ID と呼ばれます。

サービス プリンシパルは、 その ID または appId を使用してアドレス指定できます。 idappId は、Microsoft Entra 管理センターのアプリ登録では、それぞれ オブジェクト IDアプリケーション (クライアント) ID と呼ばれます。

POST /servicePrincipals/{servicePrincipalId}/synchronization/jobs/{jobId}/restart
POST /servicePrincipals(appId='{appId}')/synchronization/jobs/{jobId}/restart

要求ヘッダー

名前 説明
Authorization string ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

要求本文で、次のパラメーターを持つ JSON オブジェクトを指定します。

パラメーター 説明
criteria synchronizationJobRestartCriteria 再起動条件

応答

成功した場合は、 204 No Content 応答を返します。 応答本文では何も返されません。

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/v1.0/servicePrincipals/{id}/synchronization/jobs/{jobId}/restart
Authorization: Bearer <token>
Content-type: application/json

{
   "criteria": {
       "resetScope": "Watermark, Escrows, QuarantineState"
   }
}

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content