Azure DevOps Board外部集成CRUD操作REST API公开性及替代方案问询

你调试发现的UI端点是否公开 #

你通过调试看到的https://dev.azure.com/my-org/my-project/_settings/boards-external-integration属于Azure DevOps的内部UI专用端点，这类接口并未对公众开放，也不会出现在官方公开的REST API文档中。它们仅用于支撑ADO自身前端页面的交互，参数格式、返回结构随时可能变动，绝对不能在生产项目中依赖。

替代方案：使用官方公开能力实现集成CRUD #

针对ADO Boards与GitHub等外部服务的集成操作，微软提供了官方支持的REST API和CLI工具，以下是具体实现路径：

1. 基于官方REST API管理外部集成 #

• 服务端点管理：GitHub这类外部服务的连接属于ADO的「服务端点」范畴，可通过以下API完成CRUD：

  • 创建：POST https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?api-version=7.1-preview.4
  • 更新：PUT https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints/{endpointId}?api-version=7.1-preview.4
  • 删除：DELETE https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints/{endpointId}?api-version=7.1-preview.4
    请求体需包含GitHub的认证信息（如个人访问令牌）及连接配置，参数需符合官方定义的服务端点schema规范。

• 工作项与GitHub关联规则：若要实现工作项与GitHub提交、PR的关联，可通过Work Item Tracking API结合GitHub webhook完成，或直接用API配置ADO自带的GitHub集成规则。

2. 使用Azure DevOps CLI工具 #

如果不想直接编写API请求，可通过Azure DevOps CLI的az devops service-endpoint命令快速管理：

• 创建GitHub服务端点：

  az devops service-endpoint github create --name "MyGitHubConnection" --github-url "https://github.com/my-org/my-repo" --github-pat "ghp_xxxxxx" --org "my-org" --project "my-project"
  

• 删除服务端点：

  az devops service-endpoint delete --id "endpoint-guid" --org "my-org" --project "my-project"
  

3. 关键注意事项 #

• 操作需具备对应权限：例如项目管理员权限才能创建或修改服务端点。
• 生产环境优先使用稳定版API：避免依赖preview标识的预览版接口，防止后续版本变动影响业务。

内容的提问来源于stack exchange，提问作者riaz