名前空間: microsoft.graph.externalConnectors
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
外部ソースから Microsoft Graph にコンテンツを追加するための論理コンテナー。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| externalConnection を作成する | externalConnection | connections コレクションに投稿して、新しい externalConnection を作成します。 |
| externalConnections を一覧表示する | externalConnection コレクション | externalConnection オブジェクト コレクションを取得します。 |
| externalConnection を取得する | externalConnection | externalConnection オブジェクトのプロパティとリレーションシップを読み取ります。 |
| externalConnection を更新する | externalConnection | externalConnection オブジェクトを更新します。 |
| externalConnection を削除する | なし | externalConnection オブジェクトを削除します。 |
| スキーマの作成 | なし またはスキーマ | 接続 スキーマを登録します。 |
| 操作を取得する | connectionOperation | 接続スキーマを作成するための非同期要求の状態を取得します。 |
| externalItem を作成する | externalItem | items コレクションに投稿して、新しい externalItem を作成します。 |
| 接続クォータの取得 | connectionQuota | connectionQuota のプロパティと関係を取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| activitySettings | microsoft.graph.externalConnectors.activitySettings | コネクタ コンテンツを含むアクティビティに関連する構成可能な設定を収集します。 |
| configuration | microsoft.graph.externalConnectors.configuration | 接続の管理と接続内のコンテンツのインデックスを実行できる追加のアプリケーション ID を指定します。 省略可能。 |
| connectorId | 文字列 | Teams アプリ ID。 省略可能。 |
| contentCategory | microsoft.graph.externalConnectors.contentCategory | 外部接続に関連付けられているコンテンツのドメイン カテゴリを指定します。 このプロパティは、取り込まれたコンテンツの性質を通知することで、Microsoft Graph が関連性、ランキング、セマンティック理解を最適化するのに役立ちます。 たとえば、この値を正しく設定することで、クエリの解釈が改善され、Copilot エクスペリエンスが向上します。 有効な値は、 uncategorized、 knowledgeBase、 wikis、 fileRepository、 qna、 crm、 dashboard、 people、 media、 email、 messaging、 meetingTranscripts、 taskManagement、 learningManagement です。 省略可能。 既定値は uncategorized です。 |
| 説明 | String | Microsoft 365 管理センターに表示される接続の説明。 省略可能。 |
| enabledContentExperiences | microsoft.graph.externalConnectors.contentExperienceType コレクション | 接続が参加するコンテンツ エクスペリエンスのリスト。 指定可能な値は search です。 |
| id | 文字列 | 開発者が指定した、Microsoft Entra テナント内の接続の一意の ID。 長さは 3 文字から 32 文字の間である必要があります。 英数字のみを含める必要があります。
Microsoft で始まったり、None、Directory、Exchange、ExchangeArchive、LinkedIn、Mailbox、OneDriveBusiness、SharePoint、Teams、Yammer、Connectors、TaskFabric、PowerBI、Assistant、TopicEngine、MSFT_All_Connectors のいずれかの値にしたりすることはできません。 必須です。 |
| ingestedItemsCount | Int64 | 接続に取り込まれた項目の数。 この値は 15 分ごとに更新されます。 接続状態が draft の場合、 ingestedItemsCount は null になります。 |
| name | String | Microsoft 365 管理センターに表示される接続の表示名。 最大 128 文字。 必須です。 |
| searchSettings | microsoft.graph.externalConnectors.searchSettings | 検索結果の表示テンプレートなど、この接続内のコンテンツの検索エクスペリエンスを構成する設定。 |
| state | microsoft.graph.externalConnectors.connectionState | 接続の現在の状態を示します。 指定可能な値は、 draft、 ready、 obsolete、および limitExceeded です。 必須です。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| groups | microsoft.graph.externalConnectors.externalGroup コレクション | 読み取り専用です。 Null 許容型。 |
| アイテム | microsoft.graph.externalConnectors.externalItem コレクション | 読み取り専用です。 Null 許容型。 |
| operations | microsoft.graph.externalConnectors.connectionOperation コレクション | 読み取り専用です。 Null 許容型。 |
| quota | microsoft.graph.externalConnectors.connectionQuota | 読み取り専用です。 Null 許容型。 |
| スキーマ | microsoft.graph.externalConnectors.schema | 読み取り専用です。 Null 許容型。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"activitySettings": {"@odata.type": "microsoft.graph.externalConnectors.activitySettings"},
"configuration": {"@odata.type": "microsoft.graph.externalConnectors.configuration"},
"connectorId": "String",
"description": "String",
"enabledContentExperiences": "[String]",
"id": "String (identifier)",
"ingestedItemsCount": "Int64",
"name": "String",
"searchSettings": {"@odata.type": "microsoft.graph.externalConnectors.searchSettings"},
"state": "String"
}