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

  • [アーティクル]

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

構文

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

# Batch Script v1
# Run a windows cmd or bat 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.

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


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
確認要求 セルフホステッド エージェントには、このタスクを使用するジョブを実行するための次の要求に一致する機能が必要です。
Capabilities このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 Any
設定可能な変数 Any
エージェントのバージョン 1.83.0 以上
タスクのカテゴリ ユーティリティ