ManualValidation@0 – Manuelle Überprüfung v0-Aufgabe

Artikel
06/11/2024

Verwenden Sie diese Aufgabe, um eine YAML-Pipelineausführung anzuhalten, um auf eine manuelle Interaktion zu warten.

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.

Eingaben

notifyUsers - Benachrichtigen von Benutzern
string. Erforderlich.

Sendet eine manuelle Überprüfung, die an bestimmte Benutzer (oder Gruppen) aussteht. Nur Benutzer mit Warteschlangenbuildberechtigung können auf eine manuelle Überprüfung reagieren. Sie können mithilfe der [org name]\group name Syntax eine E-Mail an eine Gruppe senden.

Diese Aufgabeneingabe ist erforderlich, Sie können jedoch eine leere Zeichenfolge angeben, wenn Sie niemanden benachrichtigen möchten, z. B. während einer Testausführung: notifyUsers: ''.

instructions - Anweisungen
string.

Gibt die Anweisungen an, die dem Benutzer angezeigt werden, wenn der manuelle Eingriff fortgesetzt oder abgelehnt wird. Basierend auf diesen Anweisungen trifft der Benutzer eine fundierte Entscheidung über diesen manuellen Eingriff.

onTimeout - Timeout
string. Zulässige Werte: reject, resume. Standardwert. reject.

Diese manuelle Überprüfung wird automatisch abgelehnt oder fortgesetzt, nachdem sie für das angegebene Timeout oder 30 Tage aussteht, je nachdem, welcher Zeitpunkt früher liegt.

Optionen für die Vorgangskontrolle

Alle Vorgänge verfügen zusätzlich zu ihren Eingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Keine.

Hinweise

Verwenden Sie diesen Task in einer YAML-Pipeline, um eine Ausführung innerhalb einer Phase anzuhalten. Dies wird in der Regel ausgeführt, um verschiedene manuelle Schritte oder Aktionen auszuführen, und dann wird die Ausführung fortgesetzt oder abgelehnt.

Wichtig

Diese Aufgabe wird nur in YAML-Pipelines unterstützt und kann nur in einem agentlosen Auftrag einer YAML-Pipeline verwendet werden.

Mit der Aufgabe Manuelle Überprüfung können Sie eine Pipelineausführung innerhalb einer Phase anhalten, in der Regel einige manuelle Schritte oder Aktionen ausführen und dann mit der Pipeline fortfahren. Beispielsweise muss der Benutzer möglicherweise bestimmte Bereitstellungskonfigurationen manuell überprüfen, bevor die Pipeline einen rechenintensiven Auftrag mit langer Ausführungszeit startet.

Die Konfiguration des Manuellen Überprüfungstasks enthält einen Anweisungsparameter , der verwendet wird, um verwandte Informationen bereitzustellen oder die manuellen Schritte anzugeben, die der Benutzer während der Pause ausführt. Sie können die Aufgabe so konfigurieren, dass sie E-Mail-Benachrichtigungen an Benutzer und Benutzergruppen sendet, wenn sie auf eine Überprüfung wartet, und die automatische Antwort (Ablehnen oder Fortsetzen) angeben, nachdem ein konfigurierbares Timeout auftritt.

Sie können den Timeoutwert für die Aufgabe mithilfe des optionalen timeoutInMinutes Parameters angeben, der in den allgemeinen Aufgabeneigenschaften verfügbar ist.

Hinweis

Damit die Aufgabe vollständig ausgeführt werden kann, sollte der timeoutInMinutes Wert des Auftrags (default = 60 minutes), der diese Aufgabe enthält, höher als der timeoutInMinutes Wert der Aufgabe selbst sein. Weitere Informationen finden Sie unter Timeoutwerte für Standardaufträge.

Tipp

Sie können Variablen verwenden, um E-Mail-Adressen im notifyUsers Parameter anzugeben.

Wenn der Task Manuelle Überprüfung während einer Pipeline aktiviert wird, wird eine Meldungsleiste mit einem Link angezeigt, der das Dialogfeld Manuelle Überprüfung öffnet, das die Anweisungen enthält. Nachdem sie die manuellen Schritte ausgeführt haben, kann der Administrator oder Benutzer die Ausführung fortsetzen oder ablehnen. Benutzer mit der Berechtigung Warteschlangenbuilds für die Pipeline können die Ausführung fortsetzen oder ablehnen.

Beispiele

  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'

In diesem Beispiel wird eine allgemeine Aufgabeneigenschaft verwendettimeoutInMinutes, die in allen Aufgaben verfügbar ist.

Anforderungen

Anforderung	Beschreibung
Pipelinetypen	YAML, Klassischer Build
Wird ausgeführt auf	Server
Forderungen	Keine
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Einstellbare Variablen	Any
Agent-Version	Alle unterstützten Agent-Versionen.
Aufgabenkategorie	Bereitstellen

Freigeben über