Usar variáveis nos pipelines de lançamento clássico

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

O uso de variáveis nos pipelines clássicos de lançamento é uma maneira conveniente de trocar e transportar dados em todo o pipeline. Cada variável é armazenada como uma cadeia de caracteres e o seu valor pode mudar entre as execuções do pipeline.

Ao configurar tarefas para implantar seu aplicativo em cada estágio do pipelines clássicos de lançamento, as variáveis podem ajudá-lo a:

• Simplificar a personalização: defina um pipeline de implantação genérico uma vez e adapte-o facilmente para diferentes estágios. Por exemplo, use uma variável para representar a cadeia de conexão de uma implantação da Web e ajuste o seu valor conforme for necessário para cada estágio. São conhecidas como variáveis personalizadas.

• Aproveite as informações contextuais: acesse detalhes sobre o contexto da versão, como um estágio, um artefato, ou o agente executando a implantação. Por exemplo, seus scripts podem exigir o local de compilação para o download ou o diretório de trabalho do agente para criar arquivos temporários. Eles são chamados de variáveis padrão.

Variáveis padrão

As variáveis padrão disponibilizam informações essenciais sobre o contexto de execução para as suas tarefas e scripts em execução. Essas variáveis permitem que você acesse detalhes sobre o sistema, lançamento, estágio, ou o agente no qual elas estão sendo executadas.

Com exceção de System.Debug, as variáveis padrão são somente leitura, com seus valores definidos automaticamente pelo sistema.

Algumas das variáveis mais significativas são descritas nas tabelas a seguir. Para exibir a lista completa, confira Exibir os valores atuais de todas as variáveis.

Variáveis do sistema

Variáveis de lançamento

Variáveis do estágio de lançamento

Variáveis do agente

Variáveis de artefatos de lançamento

Para cada artefato referenciado em uma versão, você pode usar as variáveis de artefato a seguir. Observe que nem todas as variáveis se aplicam a todos os tipos de artefatos. A tabela a seguir lista as variáveis de artefato padrão e fornece exemplos dos seus valores, baseado no tipo de artefato. Se um exemplo estiver vazio, isso indica que a variável não é aplicável a esse tipo de artefato.

Substitua {alias} com o valor que você especificou para a fonte de artefato alias ou com o valor padrão gerado para o pipeline de lançamento.

Variáveis de artefato primária

Em pipelines de lançamento clássicos, se você estiver usando vários artefatos, poderá designar um como o artefato primário. O Azure Pipelines preencherá as seguintes variáveis para o artefato primário designado.

Usar variáveis padrão

Você pode usar as variáveis padrão de duas maneiras: como parâmetros para tarefas em um pipeline de lançamento ou em seus scripts.

Você pode usar uma variável padrão diretamente como uma entrada para uma tarefa. Por exemplo, para passar Release.Artifacts.{Artifact alias}.DefinitionName como um argumento para uma tarefa do PowerShell para um artefato com ASPNET4.CI como seu alias, você usaria $(Release.Artifacts.ASPNET4.CI.DefinitionName).

Para usar uma variável padrão no seu script, primeiro você deve substituir o . nos nomes de variáveis padrão por _. Por exemplo, para imprimir o valor de Release.Artifacts.{Artifact alias}.DefinitionName para um artefato com ASPNET4.CI como seu alias em um script do PowerShell, use $env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME. Observe que o alias original, ASPNET4.CI, é substituído por ASPNET4_CI.

Variáveis personalizadas

As variáveis personalizadas podem ser definidas em vários escopos.

• Grupos de variáveis: use grupos de variáveis para compartilhar valores em todas as definições de um projeto. Isso é útil quando você deseja usar os mesmos valores em definições, estágios e tarefas em um projeto e gerenciá-los em um único local. Defina e gerencie grupos de variáveis na Biblioteca de >pipelines.

• Variáveis de pipeline de lançamento: use variáveis de pipeline de lançamento para compartilhar valores em todos os estágios de um pipeline de lançamento. Isso é o ideal para os cenários em que você precisa de um valor consistente entre estágios e tarefas, com a capacidade de atualizá-lo de um único local. Defina e gerencia essas variáveis na guia Variáveis de um pipeline de lançamento. Na página Variáveis do pipeline, defina a lista suspensa de escopo para Lançamento ao adicionar uma variável.

• Variáveis de estágio: use variáveis de estágio para compartilhar valores em um estágio específico de um pipeline de lançamento. Isso é útil para valores que diferem de estágio para estágio, mas são consistentes em todas as tarefas dentro de um estágio. Defina e gerencia essas variáveis na guia Variáveis de um pipeline de lançamento. Na página Variáveis de pipeline, defina a lista suspensa do escopo como o ambiente apropriado ao adicionar uma variável.

O uso de variáveis personalizadas nos níveis do projeto, do pipeline de lançamento e do estágio ajuda a:

• Evite a duplicação de valores, facilitando a atualização de todas as ocorrências com uma única alteração.

• Proteja os valores confidenciais impedindo que sejam visualizados ou modificados pelos usuários. Para marcar uma variável como segura (secreta), selecione o o ícone ao lado da variável.

  Importante

  Os valores das variáveis ocultas (secretas) são armazenados com segurança no servidor e não podem ser visualizados pelos usuários após serem salvos. Durante a implantação, o Azure Pipelines descriptografa esses valores quando são referenciados por tarefas e os passa para o agente por meio de um canal HTTPS seguro.

Usar variáveis personalizadas

Para usar variáveis personalizadas em suas tarefas, coloque o nome da variável entre parênteses e preceda-o com um caractere $. Por exemplo, se você tiver uma variável chamada adminUserName, poderá inserir seu valor atual em uma tarefa como $(adminUserName).

Definir e modificar suas variáveis em um script

Para definir ou modificar uma variável de um script, use o comando de log task.setvariable. O valor da variável atualizada tem como escopo o trabalho que está sendo executado e não persiste entre trabalhos ou estágios. Observe que os nomes das variáveis são transformados em maiúsculas, com "." e " " substituídos por "_".

Por exemplo, Agent.WorkFolder se tornará AGENT_WORKFOLDER.

• No Windows, você acessa a variável como %AGENT_WORKFOLDER% ou $env:AGENT_WORKFOLDER.
• No Linux e no macOS, use $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"

Saída do console da leitura das variáveis:

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)

Exibir os valores atuais de todas as variáveis

1. Selecione Pipelines>Versões e, em seguida, selecione o pipeline de lançamento.

2. Abra a visualização de resumo do seu lançamento e selecione o estágio em que está interessado. Na lista de etapas, escolha Inicializar trabalho.

   

3. Isso abrirá os logs desta etapa. Role para baixo para ver os valores usados pelo agente para este trabalho.

   

Executar um lançamento no modo de depuração

A execução de uma versão no modo de depuração pode ajudá-lo a diagnosticar e resolver problemas ou falhas, exibindo informações adicionais durante a execução do lançamento. Você pode habilitar o modo de depuração para todo o lançamento ou apenas para as tarefas dentro de um estágio de lançamento específico.

• Para iniciar o modo de depuração para um lançamento inteiro, adicione uma variável chamada System.Debug com o valor true para a guia de Variáveis de um pipeline de lançamento.

• Para habilitar o modo de depuração em um estágio específico, abra Configurar estágio no menu de atalho do estágio e adicione uma variável chamada System.Debug com o valor true para a guia de Variáveis.

• Como alternativa, crie um grupo de variáveis que contenha uma variável chamada System.Debug com o valor true e vincule esse grupo de variáveis a o pipeline de lançamento.

Conteúdo relacionado

• Fontes de artefato em pipelines de lançamento Clássicos

• Implantar artefatos de solicitação de pull

• Usar variáveis em um grupo de variáveis