Azure DevOps Wiki Microsoft Graph 连接器

Azure DevOps Wiki Graph 连接器允许组织在其 Azure DevOps 服务实例中为 Wiki 编制索引。 配置连接器后,最终用户可以在 Microsoft 搜索中从 Azure DevOps 搜索项目 Wiki 和代码 Wiki。

注意

本文适用于配置、运行和监视 Azure DevOps Wiki Graph 连接器的任何人。 它补充了常规设置过程,并显示仅适用于 Azure DevOps Wiki Graph 连接器的说明。

重要

Azure DevOps Wiki 连接器仅支持 Azure DevOps 云服务。 此连接器不支持 Azure DevOps Server 2019、TFS 2018、TFS 2017、TFS 2015 和 TFS 2013。

开始之前

你必须是组织的 M365 租户的 搜索管理员 ,以及组织的 Azure DevOps 实例的管理员。

若要允许连接器连接到 Azure DevOps 组织,必须 通过 OAuth 启用第三方应用程序访问。 有关详细信息,请参阅 Azure DevOps 文档 来管理安全策略

通过 OAuth 进行第三方应用程序访问

需要向在连接器配置期间使用其凭据的用户帐户授予以下权限:

权限名称 权限类型 必需
查看项目级信息 项目权限 对 Azure DevOps 工作项进行爬网。 对于需要编制索引的项目,此权限是必需的。

重要

用户帐户必须具有 基本 访问级别。 若要详细了解 Azure DevOps 中的访问级别,请阅读 支持的访问权限级别

步骤 1:在Microsoft 365 管理中心中添加 Graph 连接器

添加 Azure DevOps Wiki 连接器

按照常规 设置说明进行操作

步骤 2:命名连接

按照常规 设置说明进行操作

步骤 3:配置连接设置

若要连接到 Azure DevOps 实例,需要 Azure DevOps 帐户应用 ID 和客户端密码进行 OAuth 身份验证。

注册应用

在 Azure DevOps 中注册应用,以便 Microsoft 搜索应用可以访问该实例。 若要注册应用,请访问 注册应用程序的链接。 若要了解详细信息,请参阅有关如何 注册应用的 Azure DevOps 文档。

下表提供了有关如何填写应用注册表单的指导:

必填字段 说明 建议的值
公司名称 公司名称。 使用适当的值
应用程序名称 标识要授权的应用程序的唯一值。 Microsoft 搜索
应用程序网站 将在连接器设置期间请求访问 Azure DevOps 实例的应用程序的 URL。 (必需) 。 对于 M365 企业版:https:// gcs.office。com/,
For M365 Government: https:// gcsgcc.office.com/
授权回调 URL 授权服务器重定向到的所需回调 URL。 对于 M365 企业版:https:// gcs.office。com/v1.0/admin/oauth/callback,
适用于 M365 政府版:https:// gcsgcc.office。com/v1.0/admin/oauth/callback
授权范围 应用程序的访问范围 选择以下范围:标识 (读取) 、代码 (读取) 、权利 (读取) 、项目和团队 (读取) 、Graph (读取) 、MemberEntitlement Management (读取) 、Wiki (读取)

重要

为应用选择的授权范围应与上面列出的范围完全匹配。 如果选择了更多或更少的范围,授权将失败。

使用上述详细信息注册应用时,你将获得将用于配置连接器 的应用 ID客户端密码

注意

若要撤销对 Azure DevOps 中注册的任何应用的访问权限,请转到 Azure DevOps 实例右上角的“用户设置”。 选择“配置文件”,然后在侧窗格的“安全性”部分选择“授权”。 将鼠标悬停在授权的 OAuth 应用上,可查看应用详细信息一角的“撤销”按钮。

连接设置

向 Azure DevOps 注册 Microsoft 搜索应用后,可以完成连接设置步骤。 输入应用 ID 和客户端密码。

连接应用程序设置。

配置数据:选择组织、项目和字段

在此步骤中,使用 Azure DevOps Wiki 图形连接器指定要为其编制索引的数据范围。

第一步,可以从有权访问的所有组织中选择要编制索引的组织。 然后,可以选择为连接编制整个组织或所选组织中特定项目的索引。

如果选择对整个组织编制索引,则组织内所有项目中的 Wiki 都将编制索引。 创建新项目和 Wiki 后,将在下次爬网期间编制索引。

如果选择为单个项目编制索引,则只会为所选项目中的 wiki 编制索引。

步骤 4:管理搜索权限

Azure DevOps 连接器支持对 每个人可见的搜索权限。 使用“ 所有人 ”选项,索引数据将显示在所有用户的搜索结果中。

步骤 5:分配属性标签

按照常规 设置说明进行操作

步骤 6:管理架构

按照常规 设置说明进行操作

步骤 7:选择刷新设置

Azure DevOps Wiki 连接器支持完全爬网和增量爬网的刷新计划。 建议的增量爬网计划为 1 小时,完全爬网为 1 周。

步骤 8:查看连接

按照常规 设置说明进行操作

步骤 9:设置搜索结果页

发布连接后,需要使用垂直和结果类型自定义搜索结果页。 若要了解如何自定义搜索结果,请查看如何 管理垂直结果类型。 还可以使用 Azure DevOps Wiki 连接器 的示例结果布局 。 只需复制粘贴结果布局 JSON 即可开始使用。

故障排除

以下是在配置连接器时或爬网过程中观察到的常见错误及其可能的原因。

步骤 错误消息 () 的可能原因
连接设置 Invalid Credentials detected. Try signing in with a different account or check the permissions for your account 可能会禁用通过 OAuth 进行的第三方应用程序访问。 遵循管理 安全策略 的步骤启用 OAuth。
连接设置 Bad state OAuth 弹出窗口中的消息,其中 URL 指出 error=InvalidScope 为已注册的应用提供的范围不正确。
连接设置 400 - Bad request OAuth 弹出窗口中的消息 应用 ID 不正确
连接设置 BadRequest: Bad Request on api request OAuth 弹出窗口中的消息 错误的客户端密码
连接器配置) 后 (爬网时间 The account associated with the connector doesn't have permission to access the item. 已注册的应用没有任何所需的 OAuth 范围。
连接器配置) 后 (爬网时间 You don't have permission to access this data source. You can contact the owner of this data source to request permission. 通过 OAuth 禁用第三方应用程序访问 。 遵循管理 安全策略 的步骤启用 OAuth。
连接器配置) 后 (爬网时间 Credentials associated with this data source have expired. Renew the credentials and then update the connection 已注册的应用可能已被删除或过期。
连接器配置) 后 (爬网时间 Item listed but no longer accessible or no longer exists 爬网帐户可能缺少“基本”访问级别。 爬网失败,访问“利益干系人”。