ManualValidation@0 - 手動検証 v0 タスク
このタスクを使用して、YAML パイプラインの実行を一時停止して手動操作を待機します。
構文
# 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.
入力
notifyUsers
- ユーザーに通知する
string
. 必須です。
手動検証保留中の電子メールを特定のユーザー (またはグループ) に送信します。 キュー ビルド アクセス許可を持つユーザーのみが手動検証に対応できます。 構文を使用して、グループに電子メールを [org name]\group name
送信できます。
このタスク入力は必須ですが、テストの実行中 notifyUsers: ''
など、誰にも通知しない場合は空の文字列を指定できます。
instructions
- 指示
string
.
手動による介入を再開または拒否するときにユーザーに表示される指示を指定します。 これらの手順に基づいて、ユーザーは、この手動介入に関する情報に基づいて決定を行います。
onTimeout
- タイムアウト時
string
. 使用できる値: reject
、resume
。 既定値: reject
。
指定されたタイムアウト (30 日のいずれか早い方) に保留中の後、この手動検証を自動的に拒否または再開します。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
解説
ステージ内で実行を一時停止するには、YAML パイプラインでこのタスクを使用します。 これは通常、さまざまな手動の手順またはアクションを実行するために実行され、実行が再開または拒否されます。
重要
このタスクは YAML パイプラインでのみサポートされており、YAML パイプラインの エージェントレス ジョブ でのみ使用できます。
手動検証タスクを使用すると、ステージ内でパイプラインの実行を一時停止し、通常は何らかの手動手順またはアクションを実行してから、パイプラインを続行できます。 たとえば、パイプラインが実行時間が長く計算量の多いジョブを開始する前に、ユーザーが特定のデプロイ構成を手動で検証することが必要な場合があります。
手動検証タスクの構成には、関連情報を提供したり、ユーザーが一時停止中に実行する手動の手順を指定したりするために使用される instructions パラメーターが含まれています。 レビューを待機しているときにユーザーとユーザー グループに電子メール通知を送信するようにタスクを構成し、構成可能なタイムアウトが発生した後に自動応答 (拒否または再開) を指定できます。
タスクのタイムアウト値は、タスクの共通プロパティで使用可能な省略可能なtimeoutInMinutes
パラメーターを使用して指定できます。
注意
タスクを完全に実行するには、このタスクを timeoutInMinutes
含むジョブ (default = 60 minutes
) の値が、タスク自体の値よりも timeoutInMinutes
大きくする必要があります。 既定のジョブ タイムアウト値に関するページをご覧ください。
ヒント
変数を使用して、notifyUsers
パラメーターでメール アドレスを指定できます。
パイプライン中に手動検証タスクがアクティブ化されると、メッセージ バーにリンクが表示され、[手動検証] ダイアログが開きます。これには指示が含まれます。 手動の手順を実行した後、管理者またはユーザーは実行を再開するか拒否するかを選択できます。 パイプラインに対する キュー ビルド アクセス許可を持つユーザーは、実行を再開または拒否できます。
例
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'
この例では、 を使用 timeoutInMinutes
します。これは、すべてのタスクで使用できる共通のタスク プロパティ です。
要件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド |
上で実行 | サーバー |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | サポートされているすべてのエージェント バージョン。 |
タスクのカテゴリ | 配置 |