ManualValidation@0 - Tâche v0 de validation manuelle

  • Article

Utilisez cette tâche pour suspendre une exécution de pipeline YAML pour attendre une interaction manuelle.

Syntax

# Manual validation v0
# [PREVIEW] Pause a pipeline run to wait for manual interaction. Works only with YAML pipelines.
- task: ManualValidation@0
  inputs:
    notifyUsers: # string. Required. Notify users. 
    #instructions: # string. Instructions. 
    #onTimeout: 'reject' # 'reject' | 'resume'. On timeout. Default: reject.

Entrées

notifyUsers - Notifier les utilisateurs
string. Obligatoire.

Envoie un e-mail de validation manuelle en attente à des utilisateurs (ou groupes) spécifiques. Seuls les utilisateurs disposant d’une autorisation de génération de file d’attente peuvent agir sur une validation manuelle. Vous pouvez envoyer un e-mail à un groupe à l’aide de la [org name]\group name syntaxe .

Cette entrée de tâche est requise, mais vous pouvez spécifier une chaîne vide si vous ne souhaitez avertir personne, par exemple pendant une série de tests : notifyUsers: ''.


instructions - Instructions
string.

Spécifie les instructions affichées à l’utilisateur lors de la reprise ou du rejet de l’intervention manuelle. Sur la base de ces instructions, l’utilisateur prendra une décision éclairée concernant cette intervention manuelle.


onTimeout - Délai d’expiration
string. Valeurs autorisées : reject, resume. Valeur par défaut : reject.

Rejette ou reprend automatiquement cette validation manuelle une fois qu’elle est en attente pendant le délai d’attente spécifié, ou 30 jours, selon la date antérieure.


Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Utilisez cette tâche dans un pipeline YAML pour suspendre une exécution au sein d’une étape. Cette opération est généralement exécutée pour effectuer différentes étapes ou actions manuelles, puis l’exécution est reprise ou rejetée.

Important

Cette tâche est uniquement prise en charge dans les pipelines YAML et ne peut être utilisée que dans un travail sans agent d’un pipeline YAML.

La tâche validation manuelle vous permet de suspendre une exécution de pipeline au cours d’une phase, généralement pour effectuer des étapes ou actions manuelles, puis de continuer avec le pipeline. Par exemple, l’utilisateur peut avoir besoin de valider manuellement certaines configurations de déploiement avant que le pipeline démarre un travail de longue durée nécessitant beaucoup de calcul.

La configuration de la tâche validation manuelle inclut un paramètre d’instructions utilisé pour fournir des informations connexes ou pour spécifier les étapes manuelles que l’utilisateur exécute pendant la pause. Vous pouvez configurer la tâche pour envoyer des Notifications par e-mail aux utilisateurs et aux groupes d’utilisateurs en attente d’une révision et spécifier la réponse automatique (rejeter ou reprendre) après un délai d’expiration configurable.

Vous pouvez spécifier la valeur de délai d’expiration de la tâche à l’aide du paramètre facultatif timeoutInMinutes , disponible dans les propriétés de la tâche courantes.

Notes

Pour que la tâche s’exécute complètement, la timeoutInMinutes valeur du travail (default = 60 minutes) contenant cette tâche doit être supérieure à la timeoutInMinutes valeur de la tâche elle-même. Consultez les valeurs de délai d’expiration de travail par défaut.

Conseil

Vous pouvez utiliser des variables pour spécifier des adresses e-mail dans le notifyUsers paramètre.

Lorsque la tâche Validation manuelle est activée pendant un pipeline, elle affiche une barre de messages avec un lien qui ouvre la boîte de dialogue Validation manuelle, qui contient les instructions. Après avoir effectué les étapes manuelles, l’administrateur ou l’utilisateur peut choisir de reprendre l’exécution ou de la rejeter. Les utilisateurs disposant d’une autorisation de génération de file d’attente sur le pipeline peuvent reprendre ou rejeter l’exécution.

Exemples

  jobs:
  - job: waitForValidation
    displayName: Wait for external validation
    pool: server
    timeoutInMinutes: 4320 # job times out in 3 days
    steps:
    - task: ManualValidation@0
      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'

Cet exemple utilise timeoutInMinutes qui est une propriété de tâche commune disponible dans toutes les tâches.

Configuration requise

Condition requise Description
Types de pipelines YAML, build classique
S’exécute sur Serveur
Demandes None
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes Quelconque
Variables settables Quelconque
Version de l’agent Toutes les versions d’agent prises en charge.
Catégorie de la tâche Déployer