Microsoft Graph の接続を作成、更新、削除するCreate, update, and delete connections in the Microsoft Graph

外部サービスから Microsoft Search サービスへの接続は、Microsoft Graph の externalConnection リソースで表されます。Connections from external services to the Microsoft Search service are represented by the externalConnection resource in Microsoft Graph.

重要

Microsoft Graph のコネクタは現在パブリック プレビューの状態です。Microsoft Graph connectors are currently in public preview status. コネクタ機能にアクセスするには、テナントの対象指定リリース オプションを有効にする必要があります。To gain access to connectors functionality, you must turn on the Targeted release option in your tenant. 詳細については、「 コネクタのプレビュープログラム」を参照してください。See more details on the connectors preview program.

Microsoft Graph のコネクタ プラットフォームでは、外部データを Microsoft Graph に簡単に追加できます。The Microsoft Graph connectors platform offers a simple way to add your external data into the Microsoft Graph. 接続は、管理者が単体として管理できる外部データの論理的なコンテナーです。A connection is a logical container for your external data that an administrator can manage as a single unit.

接続が作成されると、オンプレミスのコンテンツ ソースや外部の SaaS サービスなどの外部データ ソースからコンテンツを追加できます。Once a connection has been created, you can add your content from any external data source such as an on-premises content source or an external SaaS service. 作成した接続、または明示的に 承認された接続のみ表示および管理できます。You can only view and manage the connections you created or were explicitly authorized to manage. 検索管理者は、テナント内のすべての接続を最新の管理センターから表示および管理できます。A search admin can view and manage all the connections in the tenant from the Modern Admin Center.

サンプル カスタム ヘルプデスク システムのチケット コネクタの構造Sample custom helpdesk system Tickets Connector Structure

サンプル カスタム ヘルプデスク システムのチケット コネクタの構造Sample custom helpdesk system Tickets Connector Structure

カスタム チケット コネクタを含む接続の管理ビュー

カスタム チケット コネクタを含む接続の管理ビューAdmin View of Connections including the custom Tickets Connector

必要な接続を自由に作成することができますが、コネクタのすべてのインスタンスに対して 1 つの接続を作成するのが最も一般的です。You can model a connection anyway you want, but creating one connection for every instance of your connector is the most common model. たとえば、Microsoft Windows ファイル共有コネクタを設定する たびに、新しい接続が作成されます。For example, each time you set up the Microsoft Windows file share connector, a new connection is created. 1 つの接続を作成して、データ ソースからすべてのアイテムを追加することもできます。You can also create a single connection to add all items from your data source. たとえば、1 つの接続を作成して、ヘルプデスク システムの複数チームですべてのチケットとインシデントを追加します。For example, creating a single connection to add all the tickets and incidents across multiple teams from your helpdesk system.

状態と操作States and operations

次のいずれかの状態のときに接続を使用できます。Your connection can exist in one of the following states.

状態State 説明Description
下書きDraft 空の接続がプロビジョニングされています。An empty connection is provisioned. データ ソース、スキーマ、または設定がまだ構成されていません。The data source, schema, or any settings have not been configured yet.
準備完了Ready この接続は、登録されているスキーマでプロビジョニングされ、取り込みの準備ができています。The connection is provisioned with registered schema and is ready for ingestion.
現在不使用Obsolete これは、API などの依存機能が使用されていない場合に発生します。This occurs when a dependent feature, such as an API, has been deprecated. 接続の削除の操作のみ可能です。Deleting the connection is the only valid operation.
LimitExceededLimitExceeded すべての接続に対して、1 つの接続またはテナント レベルのクォータの上限に達した場合、その状態を終了するまでアイテムを追加することはできません。If you hit the maximum limit of a single connection or the tenant level quota across all connections, you cannot add more items until you exit the state.

次の表は、各状態で使用できる操作を示しています。The following table specifies which operations are available in each state.

操作Operation 下書きDraft 準備完了Ready 現在不使用Obsolete LimitExceededLimitExceeded
接続の作成Create connection ✔️ ✔️
接続の読み取りRead connection ✔️ ✔️ ✔️ ✔️
接続の更新Update connection ✔️ ✔️ ✔️
接続の削除Delete connection ✔️ ✔️ ✔️ ✔️
スキーマの作成Create schema ✔️
スキーマの読み取りRead schema ✔️ ✔️ ✔️
スキーマの更新Update schema
スキーマの削除Delete schema
アイテムの作成Create item ✔️
アイテムの読み取りRead item ✔️ ✔️ ✔️
アイテムの更新Update item ✔️ ✔️
アイテムの削除Delete item ✔️ ✔️

接続を使用すると、アプリケーションでインデックスが作成されるアイテムのスキーマを定義できます。また、インデックスにアイテムを追加したり、更新したり、インデックスから削除したりするためのサービスのエンドポイントを提供します。A connection allows your application to define a schema for items that will be indexed, and provides an endpoint for your service to add, update, or delete items from the index. 接続の作成は、 アプリケーションで検索インデックスにアイテムを追加する最初のステップです。Creating a connection is the first step for an application to add items to the search index.

接続を作成するCreate a connection

アプリケーションで検索インデックスにアイテムを追加する前に、次の手順を使用して接続を作成および構成する必要があります。Before an application can add items to the search index, it must create and configure a connection using the following steps.

重要

登録したスキーマは、既存の接続に対しては変更できません。After a schema has been registered, it cannot be changed for an existing connection.

接続を更新するUpdate a connection

接続を更新することにより、既存の接続の表示名や説明を変更できます。You can change the display name or description of an existing connection by updating the connection.

接続を削除するDelete a connection

接続を削除したり、その接続を介してインデックスが作成されたアイテムをすべて削除できます。You can delete a connection, and remove all items that were indexed via that connection.

次の手順Next steps