externalConnection 资源类型
Namespace:microsoft.graph.externalConnectors
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
用于将外部源中的内容添加到 Microsoft Graph 的逻辑容器。
方法
方法 | 返回类型 | 说明 |
---|---|---|
创建 externalConnection | externalConnection | 通过发布到 connections 集合创建新的 externalConnection 。 |
列出 externalConnections | externalConnection 集合 | 获取 externalConnection 对象集合。 |
获取 externalConnection | externalConnection | 读取 externalConnection 对象的属性和关系。 |
更新 externalConnection | externalConnection | 更新 externalConnection 对象。 |
删除 externalConnection | None | 删除 externalConnection 对象。 |
创建架构 | 无 或架构 | 注册连接架构。 |
获取操作 | connectionOperation | 获取用于创建连接架构的异步请求的状态。 |
创建 externalItem | externalItem | 通过发布到 items 集合来创建新的 externalItem。 |
获取 connectionQuota | connectionQuota | 检索 connectionQuota 的属性和关系。 |
属性
属性 | 类型 | 说明 |
---|---|---|
activitySettings | microsoft.graph.externalConnectors.activitySettings | 收集与涉及连接器内容的活动相关的可配置设置。 |
configuration | microsoft.graph.externalConnectors.configuration | 指定允许管理连接和索引连接内容的其他应用程序 ID。 可选。 |
connectorId | String | Teams 应用 ID。 可选。 |
说明 | String | Microsoft 365 管理中心中显示的连接说明。 可选。 |
enabledContentExperiences | microsoft.graph.externalConnectors.contentExperienceType 集合 | 连接将参与的内容体验列表。 可能的值为 search 。 |
id | String | Microsoft Entra 租户中由开发人员提供的连接的唯一 ID。 长度必须介于 3 到 32 个字符之间。 只能包含字母数字字符。 不能以 Microsoft 下列值之一开头或为以下值之一:None 、Directory 、Exchange 、、LinkedIn ExchangeArchive 、Teams SharePoint Yammer Connectors Mailbox OneDriveBusiness TaskFabric 、PowerBI 、Assistant 、 。 MSFT_All_Connectors TopicEngine 必填。 |
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。 |
items | microsoft.graph.externalConnectors.externalItem 集合 | 此为只读属性。 可为 NULL。 |
operations | microsoft.graph.externalConnectors.connectionOperation 集合 | 此为只读属性。 可为 NULL。 |
配额 | 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"
}