ManualValidation@1 – Tarefa de validação manual v1

Artigo
12/20/2024

Pausar uma execução de pipeline para aguardar a interação manual. Funciona somente com pipelines YAML.

Sintaxe

# Manual validation v1
# Pause a pipeline run to wait for manual interaction. Works only with YAML pipelines.
- task: ManualValidation@1
  inputs:
    notifyUsers: # string. Required. Notify users. 
    #approvers: # string. Approvers. 
    #allowApproversToApproveTheirOwnRuns: false # boolean. Allow approvers to approve their own run. Default: false.
    #instructions: # string. Instructions. 
    #onTimeout: 'reject' # 'reject' | 'resume'. On timeout. Default: reject.

Entradas

notifyUsers - Notificar usuários
string. Necessário.

Envie um email pendente de validação manual para uma lista separada por vírgulas de usuários (ou grupos) específicos. Você pode enviar um email para um grupo usando a sintaxe de nome [org name]\group.

Essa entrada de tarefa é necessária, mas você pode especificar uma cadeia de caracteres vazia se não quiser notificar ninguém, por exemplo, durante uma execução de teste: notifyUsers: ''.

aprovadores approvers -
string.

Especifique uma lista separada por vírgulas de usuários/grupos/equipes de projeto para agir em uma validação manual. Na ausência de entrada, os usuários com permissão de build de fila poderão tomar medidas.

allowApproversToApproveTheirOwnRuns - permitir que os aprovadores aprovem seus próprios de execução
boolean. Valor padrão: false.

Se isso for verdade, o aprovador poderá aprovar sua própria execução.

Importante

A funcionalidade para allowApproversToApproveTheirOwnRuns ainda está sendo implantada no Azure DevOps e atualmente não está habilitada.

instruções instructions -
string.

Especifica as instruções mostradas ao usuário ao retomar ou rejeitar a validação manual. Com base nessas instruções, o usuário tomará uma decisão informada sobre essa validação manual.

onTimeout - No tempo limite
string. Valores permitidos: reject, resume. Valor padrão: reject.

Rejeita ou retoma automaticamente essa validação manual depois que ela está pendente para o tempo limite especificado ou 30 dias, o que for anterior.

Opções de controle de tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte as opções de Controle de e as propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Observações

Use essa tarefa em um pipeline YAML para pausar uma execução em um estágio. Normalmente, isso é executado para executar várias etapas ou ações manuais e, em seguida, a execução é retomada ou rejeitada.

Importante

Essa tarefa só tem suporte em pipelines YAML e só pode ser usada em um de trabalho sem agente de um pipeline YAML.

A tarefa validação manual permite que você pause uma execução de pipeline em um estágio, normalmente para executar algumas etapas ou ações manuais e, em seguida, continuar com o pipeline. Por exemplo, talvez o usuário precise validar manualmente determinadas configurações de implantação antes que o pipeline inicie um trabalho com uso intensivo computacional de execução prolongada.

A configuração da tarefa de Validação Manual inclui uma instruções parâmetro usado para fornecer informações relacionadas ou especificar as etapas manuais executadas pelo usuário durante a pausa. Você pode configurar a tarefa para enviar notificações por email para usuários e grupos de usuários quando ela estiver aguardando uma revisão e especificar a resposta automática (rejeitar ou retomar) depois que ocorrer um tempo limite configurável.

Você pode especificar o valor de tempo limite para a tarefa usando o parâmetro timeoutInMinutes opcional, disponível nas propriedades de tarefa comuns .

Nota

Para que a tarefa seja executada completamente, o valor timeoutInMinutes do trabalho (default = 60 minutes) que contém essa tarefa deve ser maior do que o valor timeoutInMinutes da tarefa em si. Consulte valores de tempo limite de trabalho padrão.

Ponta

Você pode usar variáveis para especificar endereços de email no parâmetro notifyUsers.

Quando a tarefa Validação Manual é ativada durante um pipeline, ela exibe uma barra de mensagens com um link que abre a caixa de diálogo Validação Manual, que contém as instruções. Depois de executar as etapas manuais, o administrador ou o usuário pode optar por retomar a execução ou rejeitá-la. Os usuários com builds Fila permissão no pipeline podem retomar ou rejeitar a execução.

Exemplos

  jobs:
  - job: waitForValidation
    displayName: Wait for external validation
    pool: server
    timeoutInMinutes: 4320 # job times out in 3 days
    steps:
    - task: ManualValidation@1
      timeoutInMinutes: 1440 # task times out in 1 day
      inputs:
        notifyUsers: |
          test@test.com,
          example@example.com
        instructions: 'Please validate the build configuration and resume'
        onTimeout: 'resume'

Este exemplo usa timeoutInMinutes que é uma propriedade de tarefa comum disponíveis em todas as tarefas.

Requisitos

Requisito	Descrição
Tipos de pipeline	YAML, build clássico
Execuções em	Servidor
de demandas	Nenhum
recursos	Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
restrições de comando	Qualquer
variáveis settable	Qualquer
Versão do agente	Todas as versões de agente com suporte.
Categoria de tarefa	Implantar

Compartilhar via