ManualValidation@1 - 手動検証 v1 タスク
パイプラインの実行を一時停止して、手動操作を待機します。 YAML パイプラインでのみ機能します。
構文
# 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.
入力
notifyUsers
-
ユーザーに を通知する
string
. 必須。
手動検証保留中の電子メールを、特定のユーザー (またはグループ) のコンマ区切りの一覧に送信します。
[org name]\group
名の構文を使用して、グループに電子メールを送信できます。
このタスクの入力は必須ですが、テストの実行中など、誰にも通知しない場合は空の文字列を指定 notifyUsers: ''
。
approvers
-
承認者
string
.
手動検証に対応するユーザー/グループ/プロジェクト チームのコンマ区切りのリストを指定します。 入力がない場合、キュービルド権限を持つユーザーはアクションを実行できます。
allowApproversToApproveTheirOwnRuns
-
承認者が自分の実行 を承認できるようにする
boolean
. 既定値: false
.
これが当てはまる場合、承認者は自分の実行を承認できます。
instructions
-
手順の
string
.
手動検証を再開または拒否するときにユーザーに表示される命令を指定します。 これらの手順に基づいて、ユーザーは、この手動検証に関する情報に基づいて決定を行います。
onTimeout
-
タイムアウト
string
. 使用できる値: reject
、resume
。 既定値: reject
.
指定したタイムアウト (30 日のいずれか早い方) が保留中の場合、この手動検証を自動的に拒否または再開します。
タスク コントロールのオプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。
出力変数
何一つ。
備考
ステージ内で実行を一時停止するには、YAML パイプラインでこのタスクを使用します。 これは通常、さまざまな手動の手順またはアクションを実行するために実行され、実行が再開または拒否されます。
大事な
このタスクは YAML パイプラインでのみサポートされ、YAML パイプラインの エージェントレス ジョブ でのみ使用できます。
手動検証 タスクを使用すると、ステージ内でパイプラインの実行を一時停止し、通常は手動の手順またはアクションを実行してから、パイプラインを続行できます。 たとえば、パイプラインが実行時間の長いコンピューティング集中型ジョブを開始する前に、ユーザーが特定のデプロイ構成を手動で検証する必要がある場合があります。
手動検証 タスク構成には、関連情報を提供したり、一時停止中にユーザーが実行する手動の手順を指定したりするために使用する 命令 パラメーターが含まれています。 レビューを待機しているときにユーザーとユーザー グループに電子メール通知を送信し、構成可能なタイムアウトが発生した後に自動応答 (拒否または再開) を指定するようにタスクを構成できます。
タスクのタイムアウト値は、オプションの timeoutInMinutes
パラメーターを使用して指定できます。これは、の一般的なタスク プロパティで使用できます。
手記
タスクを完全に実行するには、このタスクを含むジョブ (default = 60 minutes
) の timeoutInMinutes
値が、タスク自体の timeoutInMinutes
値より大きい必要があります。 既定のジョブ タイムアウト値 を参照してください。
先端
変数を使用して、notifyUsers
パラメーターで電子メール アドレスを指定できます。
パイプライン中に手動検証タスクがアクティブ化されると、メッセージ バーにリンクが表示され、[手動検証] ダイアログが開きます。このダイアログには、指示が含まれています。 手動の手順を実行した後、管理者またはユーザーは実行の再開または拒否を選択できます。 Queue ビルド パイプラインに対するアクセス許可を持つユーザーは、実行を再開または拒否できます。
例
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'
この例では、すべてのタスクで使用できる 共通タスク プロパティtimeoutInMinutes
を使用します。