在经典发布管道中使用变量

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022

在经典发布管道中使用变量是在整个管道中交换和传输数据的一种便捷方式。 每个变量都存储为字符串，其值可以在管道运行之间更改。

设置任务以在经典发布管道的每个阶段部署应用程序时，变量可帮助你：

• 简化自定义：定义一次通用部署管道，并轻松地针对不同的阶段对其进行调整。 例如，使用变量来表示 Web 部署的连接字符串，并根据需要为每个阶段调整其值。 这些变量称为 自定义变量。

• 利用上下文信息：访问有关发布上下文的详细信息，例如阶段、项目或运行部署的代理。 例如，脚本可能需要生成位置进行下载，或者需要代理的工作目录来创建临时文件。 这些变量称为 默认变量。

默认变量

默认变量为正在运行的任务和脚本提供有关执行上下文的基本信息。 这些变量允许你访问有关运行 它们的系统、 发布、 阶段或 代理 的详细信息。

除了 System.Debug 之外，默认变量是只读的，系统会自动设置其值。

下表描述了一些最重要的变量。 若要查看完整列表，请参阅查看所有变量的当前值。

系统变量

发布变量

发布阶段变量

代理变量

发布产物变量

对于在发布中引用的每个项目，请使用以下项目变量。 请注意，并非所有变量都适用于每种项目类型。 下表列出了默认项目变量，并提供了基于项目类型的值的示例。 如果示例为空，则表示该变量不适用于该项目类型。

将 {alias} 占位符替换为为 项目源别名 指定的值或为发布管道生成的默认值。

主工件变量

在经典发布管道中，如果使用多个项目，则可以将一个项目指定为主要项目。 然后，Azure Pipelines 为指定的主项目填充以下变量。

使用默认变量

可以通过两种方式使用默认变量作为发布管道或脚本中任务的参数。

直接使用默认变量作为任务的输入。 例如，若要将 Release.Artifacts.{Artifact alias}.DefinitionName 作为参数传递给别名为 ASPNET4.CI 的工件的 PowerShell 任务，请使用 $(Release.Artifacts.ASPNET4.CI.DefinitionName)。

若要在脚本中使用默认变量，请将 . 默认变量名称替换为 _。 例如，若要在 PowerShell 脚本中输出 Release.Artifacts.{Artifact alias}.DefinitionName 作为其别名的项目的 的值，请使用$env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME。 原始别名 ASPNET4.CI 替换为 ASPNET4_CI。

自定义变量

可以在不同的范围内定义自定义变量。

• 变量组：使用变量组在项目中的所有定义之间共享值。 如果要在整个项目中的定义、阶段和任务中使用相同的值，并从单个位置管理它们，此方法非常有用。 在管道>库中定义和管理变量组。

• 发布管道变量：使用发布管道变量跨发布管道中的所有阶段共享值。 这种方法非常适合需要在各个阶段和任务中保持一致值的场景，而且可以在单一位置进行更新。 在发布管道的变量选项卡中定义和管理这些变量。 在“管道变量”页中，添加变量时，将范围下拉列表设置为发布。

• 阶段变量：使用阶段变量在发布管道的特定阶段共享值。 该方法适用于在每个阶段有所不同但在每个阶段中所有任务保持一致的值。 在发布管道的变量选项卡中定义和管理这些变量。 在“管道变量”页中，添加变量时，将范围下拉列表设置为适当的环境。

通过在项目、发布管道和阶段级别使用自定义变量，可以：

• 避免重复值，从而更容易通过一次更改更新所有引用。

• 通过防止用户查看或修改敏感值来保护它们。 若要将变量标记为安全（机密），请选择 变量旁边的图标。

  重要

  隐藏变量（机密）的值安全地存储在服务器上，用户无法在保存后查看它们。 在部署期间，Azure Pipelines 会在任务引用这些值时解密这些值，并通过安全的 HTTPS 通道将其传递给代理。

使用自定义变量

若要在任务中使用自定义变量，可将变量名称括在括号中，然后在前面加上 $ 字符。 例如，如果你有一个名为 adminUserName 的变量，则将其当前值作为任务 $(adminUserName)插入。

在脚本中定义和修改变量

若要定义或修改脚本中的变量，请使用 task.setvariable 日志记录命令。 更新的变量值的范围限定为正在执行的作业，并且不会跨作业或阶段持续存在。 请注意，变量名称将转换为大写，并将“.”和" "替换为“_”。

例如，Agent.WorkFolder 将变为 AGENT_WORKFOLDER。

• 在 Windows 上，以 %AGENT_WORKFOLDER% 或 $env:AGENT_WORKFOLDER 的方式访问此变量。
• 在 Linux 和 macOS 上，使用 $AGENT_WORKFOLDER。

@echo ##vso[task.setvariable variable=sauce]crushed tomatoes
@echo ##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic

"$(sauce)" "$(secret.Sauce)"

@echo off
set sauceArgument=%~1
set secretSauceArgument=%~2
@echo No problem reading %sauceArgument% or %SAUCE%
@echo But I cannot read %SECRET_SAUCE%
@echo But I can read %secretSauceArgument% (but the log is redacted so I do not spoil the secret)

Write-Host "##vso[task.setvariable variable=sauce]crushed tomatoes"
Write-Host "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with
            garlic"

-sauceArgument "$(sauce)" -secretSauceArgument "$(secret.Sauce)"

Param(
   [string]$sauceArgument,
   [string]$secretSauceArgument
)
Write-Host No problem reading $env:SAUCE or $sauceArgument
Write-Host But I cannot read $env:SECRET_SAUCE
Write-Host But I can read $secretSauceArgument "(but the log is redacted so I do not spoil the secret)"

- pwsh: |
      Write-Host No problem reading $(sauce)
      Write-Host But I cannot read $env:SECRET_SAUCE
      Write-Host But I can read $(secret.Sauce) "(but the log is redacted so I do not spoil the secret)"

#!/bin/bash
echo "##vso[task.setvariable variable=sauce]crushed tomatoes"
echo "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic"

"$(sauce)" "$(secret.Sauce)"

#!/bin/bash
echo "No problem reading $SAUCE"
echo "But I cannot read $SECRET_SAUCE"

从中读取变量的控制台输出：

No problem reading crushed tomatoes or crushed tomatoes
But I cannot read 
But I can read ******** (but the log is redacted so I do not spoil the secret)

查看所有变量的当前值

1. 选择“管道”>“发布”，然后选择发布管道。

2. 打开发布的摘要视图，然后选择感兴趣的阶段。 在步骤列表中，选择“初始化作业”。

   

3. 此步骤将打开日志。 向下滚动以查看代理用于此作业的值。

   

在调试模式下运行发布

在调试模式下运行发布有助于诊断和解决问题，方法是在发布执行期间显示额外信息。 可以打开整个版本的调试模式，也可以仅针对特定发布阶段中的任务启用调试模式。

• 若要为整个版本启用调试模式，请将名为值System.Debug的true变量添加到发布管道的“变量”选项卡中。

• 若要打开特定阶段的调试模式，请从阶段的快捷菜单中打开“配置阶段”对话框，并将名为“System.Debug变量”的变量true添加到“变量”选项卡。

• 或者，创建一个变量组，其中包含名为 System.Debug 且值为 true 的变量，并将此变量组链接到发布管道。

相关内容

• 经典发布管道中的工件源

• 部署拉取请求项目

• 列出变量组中的变量