ManualValidation@1 – Manueller Überprüfungsvorgang v1

Artikel
11/21/2024

Anhalten einer Pipelineausführung, um auf manuelle Interaktion zu warten. Funktioniert nur mit YAML-Pipelines.

Syntax

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

Eingänge

notifyUsers - Benutzer benachrichtigen
string. Erforderlich.

Senden Sie eine manuelle Überprüfung ausstehende E-Mails an eine durch Trennzeichen getrennte Liste bestimmter Benutzer (oder Gruppen). Sie können eine E-Mail mithilfe der [org name]\group Namenssyntax 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: ''.

approvers - Genehmiger
string.

Geben Sie eine durch Trennzeichen getrennte Liste von Benutzern/Gruppen/Projektteams an, die auf eine manuelle Überprüfung reagieren sollen. Wenn keine Eingabe erforderlich ist, können Benutzer, die über die Berechtigung zum Warteschlangenbuild verfügen, Maßnahmen ergreifen.

allowApproversToApproveTheirOwnRuns - Genehmigenden erlauben, ihre eigene Ausführung zu genehmigen
boolean. Standardwert: false.

Wenn dies zutrifft, kann genehmigende Person ihre eigene Ausführung genehmigen.

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

Nichts.

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.

Wichtig

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.

Anmerkung

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.

Trinkgeld

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@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'

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	Jegliche
Settable-Variablen	Jegliche
Agentversion	Alle unterstützten Agentversionen.
Vorgangskategorie	Aufstellen

Freigeben über