ManualValidation@0 – Manuell validering v0-uppgift

Artikel
06/11/2024

Använd den här uppgiften för att pausa en YAML-pipelinekörning för att vänta på manuell interaktion.

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.

Indata

notifyUsers - Meddela användare
string. Krävs.

Skickar en manuell validering som väntar på e-post till specifika användare (eller grupper). Endast användare med behörighet att skapa köer kan utföra en manuell validering. Du kan skicka ett e-postmeddelande till en grupp med hjälp av syntaxen [org name]\group name .

Den här uppgiftsindata krävs, men du kan ange en tom sträng om du inte vill meddela någon, till exempel under en testkörning: notifyUsers: ''.

instructions - Instruktioner
string.

Anger de instruktioner som visas för användaren när den manuella åtgärden återupptas eller avvisas. Baserat på dessa instruktioner kommer användaren att fatta ett välgrundat beslut om den här manuella åtgärden.

onTimeout - Vid tidsgräns
string. Tillåtna värden: reject, resume. Standardvärde: reject.

Avvisar eller återupptar automatiskt den här manuella valideringen efter att den är väntande för den angivna tidsgränsen, eller 30 dagar, beroende på vilket som inträffar tidigare.

Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Inga.

Kommentarer

Använd den här uppgiften i en YAML-pipeline för att pausa en körning inom ett steg. Detta körs vanligtvis för att utföra olika manuella steg eller åtgärder och sedan återupptas eller avvisas körningen.

Viktigt

Den här uppgiften stöds endast i YAML-pipelines och kan endast användas i ett agentlöst jobb i en YAML-pipeline.

Med uppgiften Manuell validering kan du pausa en pipelinekörning i en fas, vanligtvis för att utföra några manuella steg eller åtgärder och sedan fortsätta med pipelinen. Användaren kan till exempel behöva verifiera vissa distributionskonfigurationer manuellt innan pipelinen startar ett tidskrävande beräkningsintensivt jobb.

Aktivitetskonfigurationen manuell verifiering innehåller en instruktionsparameter som används för att tillhandahålla relaterad information eller för att ange de manuella steg som användaren kör under pausen. Du kan konfigurera uppgiften att skicka e-postaviseringar till användare och användargrupper när den väntar på en granskning och ange det automatiska svaret (avvisa eller återuppta) efter att en konfigurerbar tidsgräns har inträffat.

Du kan ange timeout-värdet för aktiviteten med hjälp av den valfria timeoutInMinutes parametern som är tillgänglig i de vanliga aktivitetsegenskaperna.

Anteckning

För att aktiviteten ska köras helt timeoutInMinutes bör värdet för jobbet (default = 60 minutes) som innehåller den här aktiviteten vara högre än timeoutInMinutes värdet för själva aktiviteten. Se standardvärden för jobbtimeout.

Tips

Du kan använda variabler för att ange e-postadresser i parametern notifyUsers .

När aktiviteten Manuell validering aktiveras under en pipeline visas ett meddelandefält med en länk som öppnar dialogrutan Manuell validering, som innehåller instruktionerna. När du har utfört de manuella stegen kan administratören eller användaren välja att återuppta körningen eller avvisa den. Användare med behörigheten Queue Builds på pipelinen kan återuppta eller avvisa körningen.

Exempel

  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'

I det här exemplet används timeoutInMinutes som är en vanlig uppgiftsegenskap som är tillgänglig i alla aktiviteter.

Krav

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version
Körs på	Server
Krav	Ingen
Funktioner	Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar	Valfri
Inställningsbara variabler	Valfri
Agentversion	Alla agentversioner som stöds.
Uppgiftskategori	Distribuera

Dela via