BatchScript@1 - バッチ スクリプト v1 タスク

このタスクを使用して、Windows .bat または .cmd スクリプトを実行します。 必要に応じて、 .bat スクリプトまたは .cmd スクリプトで環境変数を永続的に変更できます。

構文

# Batch script v1
# Run a Windows command or batch script and optionally allow it to change the environment.
- task: BatchScript@1
  inputs:
    filename: # string. Required. Path. 
    #arguments: # string. Arguments. 
    #modifyEnvironment: False # boolean. Modify Environment. Default: False.
  # Advanced
    #workingFolder: # string. Working folder. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.

入力

filename - パスの
string。 必須。

実行する .cmd または .bat スクリプトのパス。 これは、完全修飾パス、または既定の作業ディレクトリに対する相対パスである必要があります。 (作業ディレクトリは、このタスクに指定できる workingFolder とは異なる場合があることに注意してください。


arguments - 引数
string。

.cmd スクリプトまたは .bat スクリプトに渡される引数。


modifyEnvironment - 環境の変更
boolean。 既定値: False。

環境変数の変更が後続のタスクに影響を与えるかどうかを決定します。


workingFolder - 作業フォルダーの
string。

スクリプト実行時の現在の作業ディレクトリ。 これは、スクリプトが配置されているフォルダにデフォルト設定されています。


標準エラーで失敗する failOnStandardError -
boolean。 既定値: false。

これが true の場合、エラーが StandardError ストリームに書き込まれた場合、このタスクは失敗します。


タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。

出力変数

なし。

注釈

このタスクを使用して、Windows .bat または .cmd スクリプトを実行します。 必要に応じて、環境変数を永続的に変更できるようにします。

注

このタスクは Windows コンテナと互換性がありません。 Windows コンテナでバッチスクリプトを実行する必要がある場合は、代わりに コマンドラインタスク を使用してください。

複数のプラットフォームのサポートについては、「 クロスプラットフォーム スクリプティング」を参照してください。

例示

リポジトリのルートに test.bat を作成します。

@echo off
echo Hello World from %AGENT_NAME%.
echo My ID is %AGENT_ID%.
echo AGENT_WORKFOLDER contents:
@dir %AGENT_WORKFOLDER%
echo AGENT_BUILDDIRECTORY contents:
@dir %AGENT_BUILDDIRECTORY%
echo BUILD_SOURCESDIRECTORY contents:
@dir %BUILD_SOURCESDIRECTORY%
echo Over and out.

このスクリプトを実行するには、パイプラインに次のタスクを追加します。

- task: BatchScript@1
  inputs:
    filename: 'test.bat'

要求事項

要件 説明
パイプラインの種類 YAML、クラシック ビルド、クラシック リリース
実行日 エージェント、DeploymentGroup
の需要 セルフホステッド エージェントには、このタスクを使用するジョブを実行するために 次の 要求に一致する 機能 が必要です。
機能 このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 [任意]
設定可能な変数 [任意]
エージェントのバージョン 1.83.0 以上
タスク カテゴリ 効用