synchronizationJob の作成
名前空間: microsoft.graph
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
既定の同期スキーマを使用して新しい同期ジョブを作成します。 ジョブは無効状態で作成されます。 同期を開始するには、Start ジョブを呼び出します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Synchronization.ReadWrite.All | 注意事項なし。 |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | Application.ReadWrite.OwnedBy | Synchronization.ReadWrite.All |
アプリケーション プロビジョニングまたは HR ドリブン プロビジョニングを構成するには、呼び出し元のユーザーにも少なくとも アプリケーション管理者 または クラウド アプリケーション管理者ディレクトリ ロールを割り当てる必要があります。
Microsoft Entra Cloud Sync を構成するには、呼び出し元のユーザーにも少なくとも ハイブリッド ID 管理者 ディレクトリ ロールを割り当てる必要があります。
HTTP 要求
POST /servicePrincipals/{id}/synchronization/jobs/
要求ヘッダー
名前 | 種類 | 説明 |
---|---|---|
Authorization | string | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
要求本文で、作成する synchronizationJob オブジェクトの JSON 表現を指定します。 必要なプロパティは templateId
のみです。
templateId
プロパティは、このアプリケーション/サービス プリンシパル用に作成されたテンプレートの 1 つと一致する必要があります。 使用可能なテンプレートを見つけるには、 リスト テンプレートを使用します。
応答
成功した場合は、応答コード 201 Created
と、応答本文に synchronizationJob オブジェクトを返します。
例
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/servicePrincipals/{id}/synchronization/jobs
Content-type: application/json
{
"templateId": "BoxOutDelta"
}
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "{jobId}",
"templateId": "BoxOutDelta",
"schedule": {
"expiration": null,
"interval": "P10675199DT2H48M5.4775807S",
"state": "Disabled"
},
"status": {
"countSuccessiveCompleteFailures": 0,
"escrowsPruned": false,
"synchronizedEntryCountByType": [],
"code": "NotConfigured",
"lastExecution": null,
"lastSuccessfulExecution": null,
"lastSuccessfulExecutionWithExports": null,
"steadyStateFirstAchievedTime": "0001-01-01T00:00:00Z",
"steadyStateLastAchievedTime": "0001-01-01T00:00:00Z",
"quarantine": null,
"troubleshootingUrl": null
}
}
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示