Freigeben über


ManualValidation@0 - Aufgabe zur manuellen Validierung v0

Verwenden Sie diese Aufgabe, um die Ausführung einer YAML-Pipeline anzuhalten, um auf eine manuelle Interaktion zu warten.

Syntax

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

Eingänge

notifyUsers - Benutzer benachrichtigen
string. Erforderlich.

Sendet eine E-Mail mit einer ausstehenden manuellen Validierung an bestimmte Benutzer (oder Gruppen). Nur Benutzer mit der Berechtigung zum Erstellen von Warteschlangen können auf eine manuelle Validierung reagieren. Sie können mithilfe der [org name]\group name Syntax eine E-Mail an eine Gruppe senden.

Diese Vorgangseingabe 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 beim Fortsetzen oder Ablehnen der manuellen Überprüfung angezeigt werden. Basierend auf diesen Anweisungen entscheidet der Benutzer über diese manuelle Überprüfung.


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

Lehnt diese manuelle Überprüfung automatisch ab, nachdem sie für das angegebene Timeout oder 30 Tage, je nachdem, was früher ist, aussteht oder fortsetzt.


Aufgabensteuerungsoptionen

Alle Aufgaben verfügen zusätzlich zu ihren Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerelementoptionen und allgemeinen Aufgabeneigenschaften.

Ausgabevariablen

Keiner.

Bemerkungen

Verwenden Sie diese Aufgabe 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.

Von Bedeutung

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

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

Die manuelle Überprüfung Aufgabenkonfiguration enthält eine Anweisungen Parameter, 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 E-Mail-Benachrichtigungen an Benutzer und Benutzergruppen gesendet werden, wenn sie auf eine Überprüfung warten und die automatische Antwort (Ablehnen oder Fortsetzen) angeben, nachdem ein konfigurierbares Timeout auftritt.

Sie können den Timeoutwert für den Vorgang mithilfe des optionalen timeoutInMinutes-Parameters angeben, der in den allgemeinen Aufgabeneigenschaftenverfügbar ist.

Hinweis

Damit die Aufgabe vollständig ausgeführt wird, sollte der timeoutInMinutes Wert des Auftrags (default = 60 minutes) mit diesem Vorgang höher sein als der timeoutInMinutes Wert des Vorgangs selbst. Siehe Standardzeitüberschreitungswerte für Auftrags.

Tipp

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

Wenn der Vorgang "Manuelle Überprüfung" während einer Pipeline aktiviert wird, wird eine Meldungsleiste mit einem Link angezeigt, über den das Dialogfeld "Manuelle Überprüfung" geöffnet wird, 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 Warteschlangenbuilds Berechtigung 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 timeoutInMinutes verwendet, bei dem es sich um eine allgemeine Vorgangseigenschaft handelt, die in allen Vorgängen verfügbar ist.

Anforderungen

Anforderung BESCHREIBUNG
Pipelinetypen YAML, klassischer Build
Läuft auf Server
Anforderungen Nichts
Funktionen Dieser Vorgang erfüllt keine Anforderungen für nachfolgende Vorgänge im Auftrag.
Befehlseinschränkungen Beliebig
Settable-Variablen Beliebig
Agentversion Alle unterstützten Agentversionen.
Vorgangskategorie Einsetzen