Usar variáveis em pipelines de versão clássica

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

O uso de variáveis em pipelines de liberação Classic é uma maneira conveniente de trocar e transportar dados em todo o pipeline. Cada variável é armazenada como uma cadeia de caracteres e seu valor pode mudar entre execuções de pipeline.

Ao configurar tarefas para implantar seu aplicativo em cada estágio do pipeline de versão Classic, as variáveis podem ajudá-lo a:

• Simplifique 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, ajustando seu valor conforme necessário para cada estágio. Estas 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 que executa a implantação. Por exemplo, seus scripts podem exigir o local de compilação para download ou o diretório de trabalho do agente para criar arquivos temporários. Estas são referidas como variáveis padrão.

Variáveis predefinidas

As variáveis padrão fornecem informações essenciais sobre o contexto de execução para suas tarefas e scripts em execução. Essas variáveis permitem que você acesse detalhes sobre o sistema, a versão, o estágio ou o agente no qual eles estão sendo executados.

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, consulte Exibir os valores atuais de todas as variáveis.

Variáveis do sistema

Variáveis de liberação

Variáveis do estágio de liberação

Variáveis do agente

Variáveis de artefatos de liberação

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

Substitua o espaço reservado {alias} pelo valor especificado para o alias de origem do artefato ou pelo valor padrão gerado para o pipeline de liberação.

Variáveis primárias do artefato

Em pipelines de liberação clássicos, se você estiver usando vários artefatos, poderá designar um como o artefato principal. Os Pipelines do Azure preencherão 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 liberação ou dentro de 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 alias, você usaria $(Release.Artifacts.ASPNET4.CI.DefinitionName).

Para usar uma variável padrão em seu script, você deve primeiro substituir o . nos nomes de variáveis padrão por _. Por exemplo, para imprimir o valor de Release.Artifacts.{Artifact alias}.DefinitionName um artefato com ASPNET4.CI como 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 em um projeto. Isso é útil quando você deseja usar os mesmos valores em definições, estágios e tarefas dentro de um projeto e gerenciá-los a partir de um único local. Defina e gerencie grupos de variáveis na Biblioteca de Pipelines>.

• Variáveis de pipeline de liberação: use variáveis de pipeline de liberação para compartilhar valores em todos os estágios dentro de um pipeline de liberação. Isso é ideal para 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 gerencie essas variáveis na guia Variáveis do pipeline de liberação. Na página Variáveis de pipeline, defina a lista suspensa Escopo como Release ao adicionar uma variável.

• Variáveis de estágio: use variáveis de estágio para compartilhar valores dentro de um estágio específico de um pipeline de liberação. 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 gerencie essas variáveis na guia Variáveis do pipeline de liberação. Na página Variáveis de Pipeline, defina a lista suspensa Escopo como o ambiente apropriado ao adicionar uma variável.

O uso de variáveis personalizadas nos níveis de projeto, pipeline de liberação e 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 valores confidenciais impedindo que sejam visualizados ou modificados pelos utilizadores. Para marcar uma variável como segura (secreta), selecione o ícone ao lado da variável.

  Importante

  Os valores das variáveis ocultas (secret) são armazenados com segurança no servidor e não podem ser visualizados pelos usuários depois de serem salvos. Durante a implantação, o Azure Pipelines descriptografa esses valores quando 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 a partir de um script, use o task.setvariable comando log. 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 passa a AGENT_WORKFOLDER.

• No Windows, acesse essa variável como %AGENT_WORKFOLDER% ou $env:AGENT_WORKFOLDER.
• No Linux e macOS, use $AGENT_WORKFOLDERo .

@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 a partir 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 Releases e, em seguida, selecione seu pipeline de>release.

2. Abra a vista de resumo da sua versão e selecione a fase em que está interessado. Na lista de etapas, escolha Inicializar trabalho.

   

3. Isso abre os logs para esta etapa. Role para baixo para ver os valores usados pelo agente para este trabalho.

   

Executar uma versão no modo de depuração

Executar 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 da versão. Você pode ativar o modo de depuração para toda a versão ou apenas para as tarefas dentro de um estágio de lançamento específico.

• Para habilitar o modo de depuração para uma versão inteira, adicione uma variável nomeada System.Debug com o valor true à guia Variáveis do pipeline de versão.

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

• Como alternativa, crie um grupo de variáveis contendo uma variável nomeada System.Debug com o valor truee vincule esse grupo de variáveis ao pipeline de liberação.

Conteúdos relacionados

• Fontes de artefatos em pipelines de liberação clássica

• Implantar artefatos de solicitação pull

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