synchronizationTemplate リソースの種類

名前空間: microsoft.graph

重要

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

特定のアプリケーションに対して事前に構成された同期設定を提供します。 これらの設定は、テンプレートに基づく すべての同期ジョブ に既定で使用されます。 アプリケーション開発者はテンプレートを指定します。だれでもテンプレートを取得して、 同期スキーマを含む既定の設定を確認できます。

アプリケーションに複数のテンプレートを指定し、既定のテンプレートを指定できます。 関心のあるアプリケーションで複数のテンプレートを使用できる場合は、アプリケーション固有のガイダンスを探して、ニーズに最も適したテンプレートを決定します。

メソッド

メソッド 戻り値の型 説明
List synchronizationTemplate コレクション アプリケーションまたはアプリケーション インスタンス (サービス プリンシパル) で使用できるテンプレートを一覧表示します。
Get synchronizationTemplate synchronizationTemplate オブジェクトのプロパティとリレーションシップを読み取ります。
Update synchronizationTemplate synchronizationTemplate オブジェクトのプロパティとリレーションシップを更新します。

プロパティ

プロパティ 説明
id String 一意のテンプレート識別子。
applicationId 文字列型 (String) このテンプレートが属するアプリケーションの識別子。
default ブール型 true このテンプレートをアプリケーションの既定値にすることをお勧めします。
説明 String テンプレートの説明。
検出 String true このテンプレートがアプリケーション インスタンス (サービス プリンシパル) で使用できるテンプレートのコレクションに表示される場合。
factoryTag String 同期エンジンでサポートされている既知のファクトリ タグの 1 つ。 factoryTag は、このテンプレートに基づいてジョブを処理するときに使用する実装を同期エンジンに通知します。
metadata synchronizationMetadataEntry コレクション その他の拡張プロパティ。 明示的に説明しない限り、メタデータ値は変更しないでください。

リレーションシップ

リレーションシップ 説明
スキーマ synchronizationSchema このテンプレートに基づくジョブの既定の同期スキーマ。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "applicationId": "String (identifier)",
  "default": true,
  "description": "String",
  "discoverable": true,
  "factoryTag": "String",
  "id": "String (identifier)",
  "metadata": [
    {
      "@odata.type": "microsoft.graph.synchronizationMetadataEntry"
    }
  ],
  "schema": {
    "@odata.type": "microsoft.graph.synchronizationSchema"
  }
}