为何在Azure Pipeline Yaml中使用templateContext？求示例与对比

一、templateContext 核心作用 #

templateContext 是 Azure Pipeline YAML 中用于向模板传递结构化上下文数据的特性，它不像参数/变量那样仅能传递单一值或简单数组，而是支持传递嵌套对象、复杂数组等结构化数据，让模板逻辑更灵活，避免重复编写零散的条件分支。

二、与参数、变量的核心差异 #

三、实际应用示例 #

示例1：向部署模板传递多环境差异化配置 #

假设你有一个通用部署模板 deploy.yml，需要针对开发、生产环境传递不同的资源配置：

主 Pipeline 文件

stages:
- stage: DeployDev
  jobs:
  - template: deploy.yml
    templateContext:
      environment: dev
      resources:
        vmSize: Standard_D2s_v3
        replicas: 2
        monitoring:
          enabled: true
          logLevel: Info
- stage: DeployProd
  jobs:
  - template: deploy.yml
    templateContext:
      environment: prod
      resources:
        vmSize: Standard_D4s_v3
        replicas: 5
        monitoring:
          enabled: true
          logLevel: Warning

模板文件 deploy.yml

jobs:
- job: Deploy
  steps:
  - task: AzureResourceManagerTemplateDeployment@3
    inputs:
      deploymentScope: 'Resource Group'
      azureResourceManagerConnection: 'Azure-$(templateContext.environment)'
      resourceGroupName: 'rg-$(templateContext.environment)'
      templateLocation: 'Linked artifact'
      csmFile: 'arm-templates/deploy.json'
      overrideParameters: >
        -vmSize $(templateContext.resources.vmSize)
        -replicas $(templateContext.resources.replicas)
  - task: ConfigureMonitoring@1
    condition: eq(templateContext.resources.monitoring.enabled, true)
    inputs:
      environment: $(templateContext.environment)
      logLevel: $(templateContext.resources.monitoring.logLevel)

这种方式无需给模板定义一堆零散参数，通过结构化上下文传递所有关联配置，模板逻辑更清晰。

示例2：结合模板复用实现动态步骤生成 #

如果需要根据不同任务类型生成对应步骤，用 templateContext 传递任务元数据：

主 Pipeline 文件

jobs:
- template: job-template.yml
  templateContext:
    tasks:
      - name: BuildAPI
        type: dotnet
        projectPath: 'src/API/API.csproj'
        arguments: '--configuration Release'
      - name: BuildWebApp
        type: npm
        workingDir: 'src/WebApp'
        arguments: 'run build'

模板文件 job-template.yml

jobs:
- job: DynamicBuild
  steps:
  - ${{ each task in templateContext.tasks }}:
    - ${{ if eq(task.type, 'dotnet') }}:
      - task: DotNetCoreCLI@2
        displayName: ${{ task.name }}
        inputs:
          command: 'build'
          projects: ${{ task.projectPath }}
          arguments: ${{ task.arguments }}
    - ${{ if eq(task.type, 'npm') }}:
      - task: Npm@1
        displayName: ${{ task.name }}
        inputs:
          command: 'custom'
          workingDir: ${{ task.workingDir }}
          customCommand: ${{ task.arguments }}

这里通过 templateContext 传递任务数组，模板内部遍历数组动态生成对应步骤，比用多个参数或变量拼接简洁得多。

四、为什么选择 templateContext 而非参数/变量 #

1. 减少模板参数冗余：传递多个关联配置时，无需定义十几个零散参数，一个结构化的 templateContext 就能搞定。
2. 逻辑更内聚：相关配置打包在一个上下文对象中，避免参数/变量分散导致的维护混乱。
3. 支持复杂结构：嵌套对象、数组等结构可直接传递，而参数/变量仅能处理简单类型，复杂场景下需额外拼接或拆分。
4. 模板复用性更高：模板可基于上下文结构做通用逻辑处理，不用为不同场景修改参数列表。

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