如何通过GitHub Action YAML向Azure WebJob传递参数

嘿，我懂你现在正折腾用GitHub Actions的YAML配置来部署Azure WebJob，还在发愁怎么给WebJob传递参数对吧？结合你给出的deploy-webjob.yml片段，我给你分享几个实用的解决办法：

方法一：通过环境变量+配置文件传递参数 #

WebJob运行时可以读取自身目录下的配置文件（比如appsettings.json），我们可以在GitHub Action的打包步骤里，把参数写入这个配置文件，或者直接设置环境变量让WebJob读取。

比如修改你现有的打包步骤：

- name: Prepare WebJob Package - Action1
  env:
    # 这里定义要传递的参数，敏感值用GitHub Secrets存储
    WEBJOB_TARGET_URL: "https://your-api-endpoint.com"
    WEBJOB_API_KEY: ${{ secrets.WEBJOB_API_SECRET }}
  run: |
    New-Item -ItemType Directory -Path webjob_package/App_Data/jobs/triggered/Action1 -Force
    Copy-Item -Recurse publish/* webjob_package/App_Data/jobs/triggered/Action1/
    
    # 把参数写入WebJob的appsettings.json
    $settingsFile = "webjob_package/App_Data/jobs/triggered/Action1/appsettings.json"
    if (Test-Path $settingsFile) {
        # 如果配置文件已存在，追加参数
        $settings = Get-Content $settingsFile | ConvertFrom-Json
        $settings.TargetUrl = $env:WEBJOB_TARGET_URL
        $settings.ApiKey = $env:WEBJOB_API_KEY
        $settings | ConvertTo-Json -Depth 10 | Set-Content $settingsFile
    } else {
        # 如果没有配置文件，直接创建并写入参数
        @{
            TargetUrl = $env:WEBJOB_TARGET_URL
            ApiKey = $env:WEBJOB_API_KEY
        } | ConvertTo-Json | Set-Content $settingsFile
    }

这样WebJob启动后，就能从appsettings.json里读取到这些参数了。

方法二：通过Azure CLI设置WebApp应用配置参数 #

Azure WebJob是依附于WebApp的，所以可以给WebApp设置应用配置，WebJob会自动共享这些配置项。你可以在GitHub Action里添加部署后的配置步骤：

# 先登录Azure
- name: Azure Login
  uses: azure/login@v1
  with:
    creds: ${{ secrets.AZURE_CREDENTIALS }}

# 设置WebApp的应用配置，WebJob可直接读取这些配置
- name: Set WebApp Application Settings
  run: |
    az webapp config appsettings set `
      --name your-webapp-name `
      --resource-group your-resource-group `
      --settings "WEBJOB_TARGET_URL=https://your-api-endpoint.com" "WEBJOB_API_KEY=${{ secrets.WEBJOB_API_SECRET }}"

# 部署WebJob包
- name: Deploy WebJob Package
  run: |
    Compress-Archive -Path webjob_package/* -DestinationPath webjob_package.zip
    az webapp deployment source config-zip --name your-webapp-name --resource-group your-resource-group --src webjob_package.zip

这种方法的好处是，后续要修改参数的话，不用重新打包部署WebJob，直接修改WebApp的应用配置就行。

小提示 #

• 所有敏感参数（比如密钥、令牌）一定要存在GitHub Secrets里，别明文写在YAML里，避免泄露。
• 如果是触发式WebJob，除了部署时配置参数，还可以在触发请求里动态传参，但如果是需要固定的默认参数，上面两种方法更合适。

备注：内容来源于stack exchange，提问作者confusedandamused