如何在Azure Databricks中注册Azure Pipelines GitHub App令牌？

核心结论 #

Azure Pipelines GitHub App在GitHub认证时使用的固定内部用户名是azurepipelines，你可以直接用这个值作为git_username参数调用Databricks的Git凭据API。

具体实现步骤 #

• 获取Azure Pipelines GitHub App的令牌
  在Azure Pipelines流水线中，你可以通过预定义变量$(System.AccessToken)获取到GitHub App的令牌，或者在配置了persistCredentials: true的checkout任务后，从.git/config文件中提取令牌（使用预定义变量更直接）。

• 调用Databricks Git凭据API注册凭据
  使用Databricks CLI或curl发起API请求，示例如下：

  • 用Databricks CLI：

    databricks workspace configure --host <你的Databricks工作区URL> --token <Databricks服务主体的令牌>
    databricks git-credentials create --git-username azurepipelines --personal-access-token $(System.AccessToken) --git-provider github
    

  • 用curl：

    curl -X POST \
      https://<你的Databricks工作区URL>/api/2.0/git-credentials \
      -H "Authorization: Bearer <Databricks服务主体的令牌>" \
      -H "Content-Type: application/json" \
      -d '{
        "git_username": "azurepipelines",
        "personal_access_token": "$(System.AccessToken)",
        "git_provider": "github"
      }'
    

• 验证凭据有效性
  注册完成后，你可以在Databricks工作区的用户设置 → Git凭据中查看已注册的条目，或者直接运行流水线测试部署到Git启用的文件夹，确认是否能正常拉取/推送代码。

注意事项 #

• 确保用于调用Databricks API的服务主体拥有Workspace Admin权限，或者至少拥有管理Git凭据的权限。
• 确认Azure Pipelines GitHub App已被安装到目标GitHub仓库/组织，且拥有对应的读写权限。
• 如果流水线中$(System.AccessToken)的权限不足，可以在GitHub App的权限设置中调整所需的仓库权限范围。

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