配置Github webhook实现提交后自动部署到Azure API Management

首先明确核心前提：Azure API Management（以下简称APIM）本身不提供直接接收GitHub代码提交Webhook、自动拉取代码构建部署的原生端点。你之前通过Visual Studio Publish完成的部署，实际包含「代码编译构建→生成API部署包/OpenAPI定义→调用APIM管理接口更新对应接口配置」三个环节，自动部署要把这串流程串起来，你要找的Webhook URL是承接这串部署流程的服务生成的，不是在APIM实例里直接创建。

下面是两种可直接落地的配置方式，根据你的需求选就行： #

方式1：GitHub Actions 对接（最推荐，无需手动创建Webhook URL） #

这是目前最稳定的配置方案，不需要你手动生成Webhook地址填到GitHub，GitHub原生的Actions能力会自动监听代码提交事件触发部署，和你本地Publish的逻辑完全对齐：

• 第一步：给部署流程开APIM操作权限
  打开Azure门户的Cloud Shell，执行以下PowerShell命令创建服务主体，把占位符替换成你自己的资源信息：

  $apimContext = New-AzApiManagementContext -ResourceGroupName "你的APIM所在资源组名称" -ServiceName "你的APIM实例名称"
  $sp = New-AzADServicePrincipal -DisplayName "GitHub-APIM-Deploy"
  New-AzRoleAssignment -Scope $apimContext.ResourceId -RoleDefinitionName "API Management Service Contributor" -ApplicationId $sp.ApplicationId
  

  命令执行完成后，记录生成的客户端ID、客户端密钥、租户ID，把这三个值加上你的APIM实例名、资源组名，统一存到对应GitHub仓库的Secrets配置项里，分别命名为AZURE_CLIENT_ID、AZURE_CLIENT_SECRET、AZURE_TENANT_ID、APIM_SERVICE_NAME、APIM_RES_GROUP。
• 第二步：创建部署工作流
  在你的API代码仓库根目录新建路径.github/workflows/deploy.yml的文件，写入以下工作流配置：

  name: Auto Deploy to APIM
  # 监听main分支的push事件，不需要额外配置Webhook
  on:
    push:
      branches: [ main ]
  jobs:
    build-deploy:
      runs-on: ubuntu-latest
      steps:
        - name: 拉取最新代码
          uses: actions/checkout@v4
        - name: 登录Azure账号
          uses: azure/login@v2
          with:
            client-id: ${{ secrets.AZURE_CLIENT_ID }}
            client-secret: ${{ secrets.AZURE_CLIENT_SECRET }}
            tenant-id: ${{ secrets.AZURE_TENANT_ID }}
        - name: 编译构建API项目
          run: dotnet publish 你的API项目文件相对路径/Api.csproj -c Release -o ./build_output
        - name: 部署更新到APIM
          run: |
            az apim api import \
              --resource-group ${{ secrets.APIM_RES_GROUP }} \
              --service-name ${{ secrets.APIM_SERVICE_NAME }} \
              --api-id 你在APIM里配置的对应API的ID \
              --path 你的API访问前缀路径 \
              --specification-format OpenApi \
              --specification-path ./build_output/OpenApi/v1/openapi.json
  

• 第三步：把这个yml文件提交推送到main分支，之后所有推送到main分支的代码提交，都会自动触发构建部署流程，直接更新APIM上的对应接口，全程不需要手动配置Webhook。

方式2：原生GitHub Webhook 触发（适合不想用GitHub Actions的场景） #

如果你一定要用GitHub原生Webhook的POST触发逻辑，Webhook URL需要你在承接请求的Azure服务里创建，APIM本身不能当这个接收端：

• 第一步：创建Webhook接收端
  在Azure门户新建一个消耗层Azure Function，触发类型选HTTP触发器，创建完成后在函数概览页就能拿到对应的函数调用URL，这个就是你要填到GitHub里的Webhook URL。
• 第二步：给这个Function开启APIM的贡献者权限，和方式1里的权限配置逻辑一致，给Function的系统托管身份分配APIM资源的API Management Service Contributor角色即可。
• 第三步：编写Function的处理逻辑：收到GitHub发来的push事件POST请求后，自动拉取对应仓库的最新代码、执行和本地VS Publish一致的编译步骤、调用APIM管理接口更新接口配置。
• 第四步：打开GitHub仓库的Settings → Webhooks → Add webhook，把之前拿到的Function URL填到Payload URL输入框，Content type选择application/json，触发事件选择「Just the push event」，保存后配置就生效了。之后每次代码推送，GitHub都会给这个URL发POST请求，触发自动部署。

踩坑提醒：不要直接把APIM的管理接口地址填到GitHub Webhook的Payload URL里。APIM的管理接口无法识别GitHub push事件的payload格式，也没有内置拉取代码、编译构建的能力，这么配完不会有任何部署效果。
如果你之前用VS Publish是把API先部署到Azure App Service，再把APIM的接口转发到App Service的，配置更简单：直接去App Service的部署中心，选择GitHub作为部署源，授权后选择对应仓库和分支，App Service会自动生成Webhook配置到GitHub，提交代码后App Service会自动拉取代码构建部署，只要接口路由没有变化，APIM侧不需要做任何额外配置。

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