Partager via

ManualValidation@0 - Tâche de validation manuelle v0

La procédure décrite ci-dessous permet de suspendre l’exécution d’un pipeline YAML en attendant une interaction manuelle.

Syntaxe

# Manual validation v0
# 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.

# 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.

Données d'entrée

notifyUsers - notifier les utilisateurs
string. Obligatoire.

Envoie un e-mail manuel en attente de validation à des utilisateurs (ou groupes) spécifiques. Seuls les utilisateurs disposant d’une autorisation de génération de file d’attente peuvent effectuer 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 pas avertir quiconque, par exemple lors d’une exécution de test : notifyUsers: ''.


instructions - instructions
string.

Spécifie les instructions affichées à l’utilisateur lors de la reprise ou du rejet de la validation manuelle. En fonction de ces instructions, l’utilisateur prendra une décision éclairée sur cette validation manuelle.


onTimeout - Sur le 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 pour le délai d’expiration spécifié, ou 30 jours, selon ce qui est antérieur.


Options de contrôle de tâche

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

Variables de sortie

Aucun.

Remarques

Utilisez cette tâche dans un pipeline YAML pour suspendre une exécution dans une phase. Cette opération est généralement exécutée pour effectuer différentes étapes manuelles ou actions, 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 l’exécution d’un pipeline dans une phase, généralement pour effectuer des étapes manuelles ou des actions, puis 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 nécessitant beaucoup de ressources de calcul.

La configuration tâche de validation manuelle inclut une instructions paramètre utilisé pour fournir des informations connexes ou pour spécifier les étapes manuelles exécutées par l’utilisateur pendant la pause. Vous pouvez configurer la tâche pour envoyer des notifications par e-mail aux utilisateurs et aux groupes d’utilisateurs lorsqu’elle attend 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 timeoutInMinutes facultatif, disponible dans les propriétés de tâche courantes .

Remarque

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

Conseil / Astuce

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

Lorsque la tâche de 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 le rejeter. Les utilisateurs disposant de File d’attente créent autorisation 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.

Spécifications

Besoin Descriptif
Types de pipelines YAML, build classique
Exécutions sur Serveur
demandes Aucun
Capacités Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande N'importe lequel
variables settables N'importe lequel
Version de l’agent Toutes les versions de l’agent prises en charge.
Catégorie de tâche Déployer
  • Last updated on