如何为Azure Pipeline YAML添加作业列表显示的多行描述？

针对你要在Admin Toolbox文件夹下的管理类Pipeline（比如Create Tenant）名称下方显示多行描述的需求，有两种实用方案：

方案一：给Pipeline添加全局描述（显示在Pipelines列表视图） #

这个方法能让描述直接出现在Pipelines文件夹列表里的Pipeline名称下方，无需进入详情页：

• 打开目标Pipeline（比如Create Tenant），点击右上角的「编辑」按钮
• 切换到「选项」标签页，找到「描述」输入框
• 直接输入多行文本，按回车换行即可，比如：

  用于快速创建新租户实例
  自动完成租户初始化、权限配置、资源配额分配
  仅管理员可触发执行

• 保存后回到Pipelines列表，就能看到该Pipeline名称下方显示这些多行描述

方案二：给YAML中的作业添加多行显示名称（显示在运行详情页） #

如果是想在Pipeline运行时的作业模块下方显示描述，直接在YAML的作业配置里用多行字符串设置displayName：

jobs:
- job: CreateTenantJob
  displayName: |
    创建租户作业
    描述：初始化新租户的核心配置
    注意：执行前需确认租户ID未重复
  steps:
  # 此处添加你的作业步骤

这样在Pipeline运行详情的作业列表中，作业名称下方会自动展示这些换行的描述文本。

需要注意的是，方案一的描述是全局生效的，所有查看该Pipeline列表的管理员都能看到；方案二则是针对单个作业的描述，仅在运行详情页显示。

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