Task - Add

指定されたジョブにタスクを追加します。
完了までのタスクの最長有効期間は180日です。 タスクが追加されてから180日以内に完了しなかった場合は、Batch サービスによって終了され、その時点の状態になります。

POST {batchUrl}/jobs/{jobId}/tasks?api-version=2021-06-01.14.0
POST {batchUrl}/jobs/{jobId}/tasks?timeout={timeout}&api-version=2021-06-01.14.0

URI パラメーター

Name In Required Type Description
batchUrl
path True
  • string

すべての Azure Batch サービス要求のベース URL。

jobId
path True
  • string

タスクを追加するジョブの ID を指定します。

api-version
query True
  • string

クライアント API バージョン。

timeout
query
  • integer
int32

サーバーが要求の処理に使用できる最大時間 (秒単位)。 既定値は 30 秒です。

要求ヘッダー

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
client-request-id
  • string
uuid

呼び出し元によって生成された要求 id。中かっこなどの装飾なしの GUID の形式で9C4D50EE-2D56-4CD3-8152-34347DC9F2B0 です。

return-client-request-id
  • boolean

サーバーがクライアント要求 id を応答で返すかどうかを指定します。

ocp-date
  • string
date-time-rfc1123

要求が発行された時刻。 クライアントライブラリは、通常、これを現在のシステムクロック時刻に設定します。REST API を直接呼び出す場合は、明示的に設定します。

要求本文

Media Types: "application/json; odata=minimalmetadata"

Name Required Type Description
commandLine True
  • string

タスクのコマンドライン。
マルチインスタンスタスクの場合、プライマリタスクとすべてのサブタスクが調整コマンドラインの実行を完了した後、コマンドラインがプライマリタスクとして実行されます。 コマンドラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンドラインでシェルを呼び出す必要があります。たとえば、Linux では Windows または "/bin/sh-c mycommand" で "cmd/c mycommand" を使用します。 コマンドラインがファイルパスを参照する場合は、相対パス (タスクの作業ディレクトリからの相対パス) を使用するか、バッチによって指定された環境変数 () を使用する必要があり https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) ます。

id True
  • string

ジョブ内のタスクを一意に識別する文字列です。
ID には、ハイフンとアンダースコアを含む英数字の任意の組み合わせを含めることができ、64文字を超えることはできません。 ID では大文字と小文字が区別され、大文字と小文字は区別されません (つまり、大文字と小文字のみが異なるジョブ内に2つの Id がない可能性があります)。

affinityInfo

新しいタスクを開始するコンピューティングノードを選択するために Batch サービスで使用できる局所性のヒント。

applicationPackageReferences

コマンドラインを実行する前に、Batch サービスによってコンピューティングノードにデプロイされるパッケージの一覧。
アプリケーションパッケージは、タスクの作業ディレクトリではなく、共有ディレクトリにダウンロードされて展開されます。 このため、参照先のパッケージが既にノードにあり、最新の状態である場合、再ダウンロードされません。コンピューティングノードの既存のコピーが使用されます。 パッケージが削除された、ダウンロードに失敗したなどの理由で、参照されたパッケージをインストールできない場合、タスクは失敗します。

authenticationTokenSettings

タスクが Batch サービス操作を実行するために使用できる認証トークンの設定。
このプロパティが設定されている場合、Batch サービスは、アカウントアクセスキーを必要とせずに Batch サービス操作を認証するために使用できる認証トークンをタスクに提供します。 このトークンは、AZ_BATCH_AUTHENTICATION_TOKEN 環境変数を介して提供されます。 タスクがトークンを使用して実行できる操作は、設定によって異なります。 たとえば、タスクは、ジョブに他のタスクを追加するためにジョブの権限を要求したり、ジョブの状態やジョブの他のタスクの状態を確認したりすることができます。

constraints

このタスクに適用される実行の制約。
制約を指定しない場合、maxTaskRetryCount はジョブに指定された maxTaskRetryCount、maxWallClockTime は無限で、retentionTime は7日間です。

containerSettings

タスクを実行するコンテナーの設定。
このタスクを実行するプールに containerConfiguration が設定されている場合は、これも設定する必要があります。 このタスクを実行するプールに containerConfiguration が設定されていない場合、これを設定することはできません。 これを指定すると、AZ_BATCH_NODE_ROOT_DIR (ノードの Azure Batch ディレクトリのルート) の下にあるすべてのディレクトリがコンテナーにマップされ、すべてのタスク環境変数がコンテナーにマップされ、タスクのコマンドラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR 外部のコンテナーで生成されたファイルは、ホストディスクに反映されない可能性があります。つまり、バッチファイル Api はこれらのファイルにアクセスできません。

dependsOn

このタスクが依存しているタスク。
このタスクは、依存するすべてのタスクが正常に完了するまでスケジュールされません。 これらのタスクのいずれかが失敗して再試行回数を使い果たすと、このタスクはスケジュールされません。 ジョブで usesTaskDependencies が true に設定されておらず、この要素が存在する場合、要求は失敗し、エラーコード TaskDependenciesNotSpecifiedOnJob が表示されます。

displayName
  • string

タスクの表示名。
表示名は一意である必要はなく、最大長が1024の Unicode 文字を含めることができます。

environmentSettings

タスクの環境変数の設定の一覧です。

exitConditions

タスクの完了時に Batch サービスがどのように応答するかを指定します。
タスクの完了時に Batch サービスがどのように応答するかを指定します。

multiInstanceSettings

タスクがマルチインスタンスタスクであり、マルチインスタンスタスクを実行する方法に関する情報が含まれていることを示すオブジェクト。
複数インスタンスタスクは、通常、MPI タスクをサポートするために使用されます。 MPI の場合、サブタスクのいずれかが失敗した場合 (たとえば、ゼロ以外の終了コードで終了したため)、マルチインスタンスタスク全体が失敗します。 その後、マルチインスタンスタスクが終了し、再試行の上限に達するまで再試行されます。

outputFiles

コマンドラインを実行した後に、Batch サービスによって計算ノードからアップロードされるファイルの一覧。
マルチインスタンスタスクの場合、ファイルは、プライマリタスクが実行されているコンピューティングノードからのみアップロードされます。

requiredSlots
  • integer

タスクが実行するために必要なスケジュールスロットの数。
既定値は 1 です。 ノードに十分な空きスケジュールスロットがある場合は、コンピューティングノードでのみタスクを実行するようにスケジュールできます。 マルチインスタンスタスクの場合、これは1である必要があります。

resourceFiles

コマンドラインを実行する前に、Batch サービスによってコンピューティングノードにダウンロードされるファイルの一覧。
マルチインスタンスタスクの場合、リソースファイルは、プライマリタスクが実行されているコンピューティングノードにのみダウンロードされます。 リソースファイルの一覧には最大サイズがあります。 最大サイズを超えた場合、要求は失敗し、応答エラーコードは RequestEntityTooLarge になります。 これが発生した場合は、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは .zip ファイル、アプリケーションパッケージ、または Docker コンテナーを使用して実現できます。

userIdentity

タスクを実行するユーザー id。
省略した場合、タスクはタスクに固有の管理者以外のユーザーとして実行されます。

応答

Name Type Description
201 Created

Batch サービスに対する要求が正常に完了しました。

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

Batch サービスからのエラー。

セキュリティ

azure_auth

Azure Active DirectoryOAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

Authorization

Type: apiKey
In: header

Add a basic task
Add a task with container settings
Add a task with exit conditions
Add a task with extra slot requirement

Add a basic task

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "task1",
  "commandLine": "cmd /c echo task1"
}

Sample Response

Add a task with container settings

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerRunOptions": "--rm"
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with exit conditions

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "taskId",
  "commandLine": "cmd /c exit 3",
  "exitConditions": {
    "exitCodeRanges": [
      {
        "start": 2,
        "end": 4,
        "exitOptions": {
          "jobAction": "terminate"
        }
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Sample Response

Add a task with extra slot requirement

Sample Request

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2021-06-01.14.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "task1",
  "requiredSlots": 2,
  "commandLine": "cmd /c echo task1"
}

Sample Response

定義

AffinityInformation

Batch サービスがタスクを開始するコンピューティング ノードを選択するために使用できる局所性ヒント。

ApplicationPackageReference

コンピューティング ノードにデプロイされるパッケージへの参照。

AuthenticationTokenSettings

タスクが Batch サービス操作の実行に使用できる認証トークンの設定。

AutoUserScope

自動ユーザーのスコープ

AutoUserSpecification

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

BatchError

サービスから受信したAzure Batch応答。

BatchErrorDetail

Azure Batch エラー応答に含まれる追加情報の項目。

ComputeNodeIdentityReference

コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て id への参照。

ContainerRegistry

プライベートコンテナーレジストリ。

ContainerWorkingDirectory

コンテナータスクの作業ディレクトリの場所です。

DependencyAction

Batch サービスがこのタスクに依存するタスクに対して実行するアクション。

ElevationLevel

ユーザーの昇格レベル。

EnvironmentSetting

タスク プロセスに設定する環境変数。

ErrorMessage

Azure Batch エラー応答で受信したエラーメッセージ。

ExitCodeMapping

特定の終了コードでタスクが終了した場合に Batch サービスがどのように応答するかを指定します。

ExitCodeRangeMapping

一連の終了コードと、その範囲内の終了コードに Batch サービスが応答する方法。

ExitConditions

タスクの完了時に Batch サービスがどのように応答するかを指定します。

ExitOptions

Batch サービスが特定の終了条件にどのように応答するかを指定します。

JobAction

指定された終了条件でタスクが完了し、ジョブの onTaskFailed プロパティが "performExitOptionsJobAction" の場合に、タスクを含むジョブに対して実行するアクション。

MultiInstanceSettings

設定インスタンス タスクを実行する方法を指定します。

OutputFile

Batch サービスがタスク プロセスの実行を完了した後Azure Batchコンピューティング ノードから別の場所にファイルをアップロードする仕様。

OutputFileBlobContainerDestination

Azure blob storage コンテナー内のファイルアップロード先を指定します。

OutputFileDestination

ファイルのアップロード先の。

OutputFileUploadCondition

タスクの出力ファイルまたはファイルのセットをアップロードする必要がある条件。

OutputFileUploadOptions

アップロードを実行する条件に基づいて、出力ファイルのアップロード操作に関する詳細を表示します。

ResourceFile

コンピューティングノードにダウンロードされる1つまたは複数のファイル。

TaskAddParameter

追加Azure Batchタスク。

TaskConstraints

タスクに適用する実行制約。

TaskContainerSettings

タスクのコンテナー設定です。

TaskDependencies

タスクの依存関係を指定します。 明示的に指定されたタスクまたは依存関係範囲内のタスクは、依存するタスクをスケジュールする前に完了する必要があります。

TaskIdRange

タスクが依存できるタスク Id の範囲。 範囲内の Id を持つすべてのタスクは、依存タスクをスケジュールする前に正常に完了する必要があります。

UserIdentity

タスクを実行するユーザー ID の定義。

AffinityInformation

Batch サービスがタスクを開始するコンピューティング ノードを選択するために使用できる局所性ヒント。

Name Type Description
affinityId
  • string

コンピューティング ノードまたは以前に実行したタスクの場所を表す不透明な文字列。
ノードの affinityId を渡して、このタスクをそのコンピューティング ノードで実行する必要があるかどうかを示すことができます。 これは単なるソフト アフィニティです。 タスクがスケジュールされている時点でターゲットコンピューティング ノードがビジー状態または使用できない場合、タスクは別の場所でスケジュールされます。

ApplicationPackageReference

コンピューティング ノードにデプロイされるパッケージへの参照。

Name Type Description
applicationId
  • string

デプロイするアプリケーションの ID。

version
  • string

デプロイするアプリケーションのバージョン。 省略すると、既定のバージョンがデプロイされます。
プールでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、要求はエラー コード InvalidApplicationPackageReferences と HTTP 状態コード 409 で失敗します。 タスクでこれを省略し、このアプリケーションに既定のバージョンが指定されていない場合、タスクは前処理エラーで失敗します。

AuthenticationTokenSettings

タスクが Batch サービス操作の実行に使用できる認証トークンの設定。

Name Type Description
access
  • string[]

トークンがアクセスを許可する Batch リソース。
認証トークンは、限られた一連の Batch サービス操作へのアクセスを許可します。 現在、アクセス プロパティでサポートされている値は "job" のみです。この値は、Task を含む Job に関連するすべての操作へのアクセスを許可します。

AutoUserScope

自動ユーザーのスコープ

Name Type Description
pool
  • string

プール内のすべてのコンピューティングノードで作成される共通の自動ユーザーアカウントでタスクを実行することを指定します。

task
  • string

サービスがタスクの新しいユーザーを作成する必要があることを指定します。

AutoUserSpecification

Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。

Name Type Description
elevationLevel

自動ユーザーの昇格レベル。
既定値は nonAdmin です。

scope

自動ユーザーのスコープ
既定値は pool です。 プールが実行されている場合 Windows タスクを厳密に分離する必要がある場合は、タスクの値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを作成する場合、または通常のタスクではアクセスできないが、StartTasks からアクセスできる必要があるプールで証明書が指定されている場合などです。

BatchError

サービスから受信したAzure Batch応答。

Name Type Description
code
  • string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

message

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

values

エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Azure Batch エラー応答に含まれる追加情報の項目。

Name Type Description
key
  • string

Value プロパティの意味を指定する識別子。

value
  • string

エラー応答に含まれる追加情報。

ComputeNodeIdentityReference

コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て id への参照。

Name Type Description
resourceId
  • string

ユーザー割り当て id の ARM リソース id。

ContainerRegistry

プライベートコンテナーレジストリ。

Name Type Description
identityReference

ユーザー名とパスワードの代わりに Azure Container Registry にアクセスするために使用するユーザー割り当て id への参照。
コンピューティングノードが使用する Batch プールに関連付けられているユーザー割り当て id への参照。

password
  • string

レジストリサーバーにログインするためのパスワード。

registryServer
  • string

レジストリ URL。
省略した場合、既定値は "docker.io" です。

username
  • string

レジストリサーバーにログインするためのユーザー名。

ContainerWorkingDirectory

コンテナータスクの作業ディレクトリの場所です。

Name Type Description
containerImageDefault
  • string

コンテナーイメージで定義されている作業ディレクトリを使用します。 このディレクトリには Batch によってダウンロードされたリソースファイルは含まれないことに注意してください。

taskWorkingDirectory
  • string

Batch によって設定されたタスクリソースファイルを含む、標準の Batch サービスタスクの作業ディレクトリを使用します。

DependencyAction

Batch サービスがこのタスクに依存するタスクに対して実行するアクション。

Name Type Description
block
  • string

このタスクを待機しているタスクをブロックして、スケジュールされないようにします。

satisfy
  • string

このタスクを待機しているタスクを満たす。すべての依存関係が満たされると、タスクが実行されるようにスケジュールされます。

ElevationLevel

ユーザーの昇格レベル。

Name Type Description
admin
  • string

ユーザーは、昇格されたアクセス権を持つユーザーであり、完全な管理者のアクセス許可を使用して操作します。

nonadmin
  • string

ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。

EnvironmentSetting

タスク プロセスに設定する環境変数。

Name Type Description
name
  • string

環境変数の名前。

value
  • string

環境変数の値。

ErrorMessage

Azure Batch エラー応答で受信したエラーメッセージ。

Name Type Description
lang
  • string

エラーメッセージの言語コード

value
  • string

メッセージのテキストです。

ExitCodeMapping

特定の終了コードでタスクが終了した場合に Batch サービスがどのように応答するかを指定します。

Name Type Description
code
  • integer

プロセス終了コード。

exitOptions

この終了コードでタスクが終了した場合に Batch サービスがどのように応答するかを指定します。

ExitCodeRangeMapping

一連の終了コードと、その範囲内の終了コードに Batch サービスが応答する方法。

Name Type Description
end
  • integer

範囲内の最後の終了コード。

exitOptions

開始から終了までの範囲内の終了コードでタスクが終了した場合に、Batch サービスがどのように応答するかを指定します。

start
  • integer

範囲内の最初の終了コード。

ExitConditions

タスクの完了時に Batch サービスがどのように応答するかを指定します。

Name Type Description
default

他のどのプロパティにも対応していない終了条件でタスクが失敗した場合に、Batch サービスがどのように応答するかを指定します。
この値は、タスクが exitCodes または exitCodeRanges collection にリストされていない0以外の終了コードで終了した場合、preProcessingError プロパティが存在しない場合はプリプロセスエラーが発生した場合、または fileUploadError プロパティが存在しない場合にファイルアップロードエラーが発生した場合に使用されます。 終了コード0に既定以外の動作が必要な場合は、exitCodes または exitCodeRanges collection を使用して明示的に一覧表示する必要があります。

exitCodeRanges

タスク終了コード範囲と、Batch サービスがそれらに応答する方法の一覧。

exitCodes

個々のタスク終了コードの一覧と、Batch サービスがそれらに応答する方法。

fileUploadError

ファイルのアップロードエラーが発生した場合に Batch サービスがどのように応答するかを指定します。
ExitCodes または exitCodeRanges を使用して指定された終了コードでタスクが終了し、ファイルのアップロードエラーが発生した場合は、終了コードによって指定されたアクションが優先されます。

preProcessingError

エラーが原因でタスクを開始できなかった場合に、Batch サービスがどのように応答するかを指定します。

ExitOptions

Batch サービスが特定の終了条件にどのように応答するかを指定します。

Name Type Description
dependencyAction

Batch サービスがこのタスクに依存するタスクに対して実行するアクション。
使用可能な値は、"対応" (依存タスクの進行を許可する) と "ブロック" (依存タスクは引き続き待機します) です。 バッチは、依存タスクの取り消しをまだサポートしていません。

jobAction

指定された終了条件でタスクが完了し、ジョブの onTaskFailed プロパティが "performExitOptionsJobAction" の場合に、タスクを含むジョブに対して実行するアクション。
既定値は、終了コード0の場合は none、他のすべての終了条件で終了する場合はです。 ジョブの onTaskFailed プロパティが noaction の場合、このプロパティを指定するとエラーが返され、[タスクの追加] 要求は無効なプロパティ値エラーで失敗します。REST API を直接呼び出す場合、HTTP 状態コードは 400 (Bad Request) になります。

JobAction

指定された終了条件でタスクが完了し、ジョブの onTaskFailed プロパティが "performExitOptionsJobAction" の場合に、タスクを含むジョブに対して実行するアクション。

Name Type Description
disable
  • string

ジョブを無効にします。 これは、disableTasks 値がキューへである disable Job API を呼び出すことと同じです。

none
  • string

操作を実行しません。

terminate
  • string

ジョブを終了します。 ジョブの executionInfo の terminateReason が "TaskFailed" に設定されています。

MultiInstanceSettings

設定インスタンス タスクを実行する方法を指定します。

Name Type Description
commonResourceFiles

調整コマンド ラインを実行する前に Batch サービスがダウンロードするファイルの一覧。
共通リソース ファイルとタスク リソース ファイルの違いは、プライマリを含むすべてのサブタスクに共通のリソース ファイルがダウンロードされるのに対し、タスク リソース ファイルはプライマリに対してのみダウンロードされる点です。 また、これらのリソース ファイルは Task 作業ディレクトリにはダウンロードされませんが、代わりにタスク ルート ディレクトリ (作業ディレクトリの上の 1 つのディレクトリ) にダウンロードされます。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 このような場合は、ResourceFiles のコレクションのサイズを縮小する必要があります。 これは、アプリケーション ファイル、アプリケーション .zip Docker コンテナーを使用して実現できます。

coordinationCommandLine
  • string

プライマリがメインの Task コマンドを実行するときに調整するために、すべてのコンピューティング ノードで実行するコマンド ライン。
一般的な調整コマンド ラインは、バックグラウンド サービスを起動し、サービスがノード間メッセージを処理する準備ができていることを確認します。

numberOfInstances
  • integer

タスクに必要なコンピューティング ノードの数。
省略した場合、既定値は 1 です。

OutputFile

Batch サービスがタスク プロセスの実行を完了した後Azure Batchコンピューティング ノードから別の場所にファイルをアップロードする仕様。

Name Type Description
destination

出力ファイルの出力先。

filePattern
  • string

アップロードするファイルを示すパターン。
相対パスと絶対パスの両方がサポートされています。 相対パスは、Task 作業ディレクトリに対する相対パスです。 次のワイルドカードがサポートされています。 * は 0 以上の文字に一致します (たとえば、パターン abc* は abc または abcdef と一致します)、 ** は任意のディレクトリに一致します。 ? は任意の 1 文字に一致し、[abc] は角かっこ内の 1 文字に一致し、[a-c] は範囲内の 1 文字と一致します。 角かっこには、指定されていない任意の文字と一致する否定を含めできます (たとえば、[!abc] は a、b、または c を含む任意の文字と一致します)。 ファイル名が "." で始まる場合、既定では無視されますが、明示的に指定することで一致する可能性があります (たとえば 、.gif は .a.gif と一致しませんが、.gif は一致します)。 単純な例: .txt は、'.' で始まり、Task 作業ディレクトリまたはサブディレクトリの .txt で終わるすべてのファイル * と一致します。ファイル名にワイルドカード文字が 含まれている場合は、角かっこを使用してエスケープできます (たとえば、abc[ ] は abc という名前のファイルと一致します)。 \ と / の両方が、Linux 上では Windows ディレクトリ区切り記号として扱われるのに注意してください。 環境変数 (Linux の場合は %var% Windowsまたは Linux $var) は、適用されるパターンの前に拡張されます。

uploadOptions

アップロード操作の追加オプション (アップロードを実行する条件を含む)。

OutputFileBlobContainerDestination

Azure blob storage コンテナー内のファイルアップロード先を指定します。

Name Type Description
containerUrl
  • string

ファイルのアップロード先となる Azure Blob Storage 内のコンテナーの URL。
マネージド id を使用しない場合、URL には、コンテナーに対する書き込みアクセス許可を付与する Shared Access Signature (SAS) が含まれている必要があります。

identityReference

containerUrl によって指定された Azure Blob Storage にアクセスするために使用するユーザー割り当て id への参照
id には Azure Blob Storage コンテナーに対する書き込みアクセス権が必要です

path
  • string

Azure Storage コンテナー内のコピー先 blob または仮想ディレクトリ。
FilePattern が特定のファイルを参照している場合 (つまり、ワイルドカードが含まれていない場合)、path はそのファイルをアップロードする blob の名前です。 FilePattern に1つ以上のワイルドカードが含まれている場合 (したがって、複数のファイルに一致する場合があります)、path はファイルをアップロードする blob 仮想ディレクトリの名前 (各 blob 名の前に付加されます) です。 省略した場合は、ファイル名と一致する blob 名を持つコンテナーのルートにファイルがアップロードされます。

OutputFileDestination

ファイルのアップロード先の。

Name Type Description
container

ファイルのアップロード先となる Azure blob storage 内の場所。

OutputFileUploadCondition

タスクの出力ファイルまたはファイルのセットをアップロードする必要がある条件。

Name Type Description
taskcompletion
  • string

終了コードに関係なく、タスクプロセスが終了した後にファイルをアップロードします。

taskfailure
  • string

タスクプロセスが終了して0以外の終了コードで終了した後にのみ、ファイルをアップロードします。

tasksuccess
  • string

タスクプロセスが終了コード0で終了した後にのみ、ファイルをアップロードします。

OutputFileUploadOptions

アップロードを実行する条件に基づいて、出力ファイルのアップロード操作に関する詳細を表示します。

Name Type Description
uploadCondition

タスクの出力ファイルまたはファイルのセットをアップロードする必要がある条件。
既定値は taskcompletion です。

ResourceFile

コンピューティングノードにダウンロードされる1つまたは複数のファイル。

Name Type Description
autoStorageContainerName
  • string

自動ストレージアカウントのストレージコンテナー名。
AutoStorageContainerName、storageContainerUrl、および httpUrl の各プロパティは相互に排他的であり、そのうちの1つを指定する必要があります。

blobPrefix
  • string

Azure Storage コンテナーから blob をダウンロードするときに使用する blob プレフィックス。 指定されたプレフィックスで始まる名前を持つ blob のみがダウンロードされます。
プロパティは、autoStorageContainerName または storageContainerUrl が使用されている場合にのみ有効です。 このプレフィックスは、部分的なファイル名またはサブディレクトリにすることができます。 プレフィックスを指定しない場合は、コンテナー内のすべてのファイルがダウンロードされます。

fileMode
  • string

8 進数形式のファイルアクセス許可モード属性。
このプロパティは、Linux コンピューティング ノードにダウンロードされるファイルにのみ適用されます。 resourceFile に指定されている場合は無視されます。これは、コンピューティング ノードのWindowsされます。 このプロパティが Linux コンピューティング ノードに指定されていない場合は、既定値の 0770 がファイルに適用されます。

filePath
  • string

タスクの作業ディレクトリを基準として、ファイルをダウンロードするコンピューティング ノード上の場所。
httpUrl プロパティが指定されている場合は、filePath が必要であり、ファイル名を含め、ファイルのダウンロードパスが記述されます。 それ以外の場合は、autoStorageContainerName プロパティまたは storageContainerUrl プロパティが指定されている場合、filePath は省略可能であり、ファイルをダウンロードするディレクトリです。 filePath をディレクトリとして使用する場合、入力データに既に関連付けられているディレクトリ構造は完全に保持され、指定された filePath ディレクトリに追加されます。 指定した相対パスは、タスクの作業ディレクトリから抜け出す (たとえば 、'..' を使用して) できません。

httpUrl
  • string

ダウンロードするファイルの URL。
AutoStorageContainerName、storageContainerUrl、および httpUrl の各プロパティは相互に排他的であり、そのうちの1つを指定する必要があります。 URL が Azure Blob Storage を指している場合は、コンピューティングノードから読み取ることができる必要があります。 Azure storage で blob の URL を取得するには、次の3つの方法があります。 blob に対する読み取りアクセス許可を付与する Shared Access Signature (SAS)、読み取りアクセス許可を持つ管理対象 id を使用する方法、または blob またはコンテナーの ACL を設定してパブリックアクセスを許可する方法です。

identityReference

storageContainerUrl または httpUrl で指定された Azure Blob Storageにアクセスするために使用するユーザー割り当て ID への参照
コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。

storageContainerUrl
  • string

Azure Blob Storage 内の blob コンテナーの URL。
AutoStorageContainerName、storageContainerUrl、および httpUrl の各プロパティは相互に排他的であり、そのうちの1つを指定する必要があります。 この URL は、コンピューティングノードから読み取り可能で、listable である必要があります。 Azure storage でコンテナーの URL を取得するには、次の3つの方法があります。コンテナーに対して読み取りと一覧表示のアクセス許可を付与する Shared Access Signature (SAS)、読み取りと一覧のアクセス許可を持つ管理対象 id を使用する方法、またはコンテナーの ACL を設定してパブリックアクセスを許可する方法です。

TaskAddParameter

追加Azure Batchタスク。

Name Type Description
affinityInfo

新しいタスクを開始するコンピューティングノードを選択するために Batch サービスで使用できる局所性のヒント。

applicationPackageReferences

コマンドラインを実行する前に、Batch サービスによってコンピューティングノードにデプロイされるパッケージの一覧。
アプリケーションパッケージは、タスクの作業ディレクトリではなく、共有ディレクトリにダウンロードされて展開されます。 このため、参照先のパッケージが既にノードにあり、最新の状態である場合、再ダウンロードされません。コンピューティングノードの既存のコピーが使用されます。 パッケージが削除された、ダウンロードに失敗したなどの理由で、参照されたパッケージをインストールできない場合、タスクは失敗します。

authenticationTokenSettings

タスクが Batch サービス操作を実行するために使用できる認証トークンの設定。
このプロパティが設定されている場合、Batch サービスは、アカウントアクセスキーを必要とせずに Batch サービス操作を認証するために使用できる認証トークンをタスクに提供します。 このトークンは、AZ_BATCH_AUTHENTICATION_TOKEN 環境変数を介して提供されます。 タスクがトークンを使用して実行できる操作は、設定によって異なります。 たとえば、タスクは、ジョブに他のタスクを追加するためにジョブの権限を要求したり、ジョブの状態やジョブの他のタスクの状態を確認したりすることができます。

commandLine
  • string

タスクのコマンド ライン。
マルチインスタンス タスクの場合、プライマリ タスクとすべてのサブタスクが調整コマンド ラインの実行を完了した後、コマンド ラインがプライマリ タスクとして実行されます。 コマンド ラインはシェルでは実行されません。そのため、環境変数の展開などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows で "cmd /c MyCommand" を使用するか、Linux で "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 ( ) を使用する必要があります https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables) 。

constraints

このタスクに適用される実行の制約。
制約を指定しない場合、maxTaskRetryCount はジョブに指定された maxTaskRetryCount、maxWallClockTime は無限で、retentionTime は7日間です。

containerSettings

タスクを実行するコンテナーの設定。
このタスクを実行するプールに containerConfiguration が設定されている場合は、これも設定する必要があります。 このタスクを実行するプールに containerConfiguration が設定されていない場合、これを設定することはできません。 これを指定すると、AZ_BATCH_NODE_ROOT_DIR (ノードの Azure Batch ディレクトリのルート) の下にあるすべてのディレクトリがコンテナーにマップされ、すべてのタスク環境変数がコンテナーにマップされ、タスクのコマンドラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR 外部のコンテナーで生成されたファイルは、ホストディスクに反映されない可能性があります。つまり、バッチファイル Api はこれらのファイルにアクセスできません。

dependsOn

このタスクが依存しているタスク。
このタスクは、依存するすべてのタスクが正常に完了するまでスケジュールされません。 これらのタスクのいずれかが失敗して再試行回数を使い果たすと、このタスクはスケジュールされません。 ジョブで usesTaskDependencies が true に設定されておらず、この要素が存在する場合、要求は失敗し、エラーコード TaskDependenciesNotSpecifiedOnJob が表示されます。

displayName
  • string

タスクの表示名。
表示名は一意である必要はなめ、最大長 1024 までの Unicode 文字を含めることができます。

environmentSettings

タスクの環境変数の設定の一覧です。

exitConditions

タスクの完了時に Batch サービスがどのように応答するかを指定します。
タスクの完了時に Batch サービスがどのように応答するかを指定します。

id
  • string

ジョブ内のタスクを一意に識別する文字列。
ID には、ハイフンやアンダースコアを含む英数字の任意の組み合わせを含め、64 文字を超えることはできません。 ID は大文字と小文字が区別され、大文字と小文字は区別されません (つまり、ジョブ内に大文字と小文字の違いがある ID が 2 つない場合があります)。

multiInstanceSettings

タスクがマルチインスタンスタスクであり、マルチインスタンスタスクを実行する方法に関する情報が含まれていることを示すオブジェクト。
複数インスタンスタスクは、通常、MPI タスクをサポートするために使用されます。 MPI の場合、サブタスクのいずれかが失敗した場合 (たとえば、ゼロ以外の終了コードで終了したため)、マルチインスタンスタスク全体が失敗します。 その後、マルチインスタンスタスクが終了し、再試行の上限に達するまで再試行されます。

outputFiles

コマンドラインを実行した後に、Batch サービスによって計算ノードからアップロードされるファイルの一覧。
マルチインスタンスタスクの場合、ファイルは、プライマリタスクが実行されているコンピューティングノードからのみアップロードされます。

requiredSlots
  • integer

タスクが実行するために必要なスケジュールスロットの数。
既定値は 1 です。 ノードに十分な空きスケジュールスロットがある場合は、コンピューティングノードでのみタスクを実行するようにスケジュールできます。 マルチインスタンスタスクの場合、これは1である必要があります。

resourceFiles

コマンドラインを実行する前に、Batch サービスによってコンピューティングノードにダウンロードされるファイルの一覧。
マルチインスタンスタスクの場合、リソースファイルは、プライマリタスクが実行されているコンピューティングノードにのみダウンロードされます。 リソースファイルの一覧には最大サイズがあります。 最大サイズを超えた場合、要求は失敗し、応答エラーコードは RequestEntityTooLarge になります。 これが発生した場合は、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは .zip ファイル、アプリケーションパッケージ、または Docker コンテナーを使用して実現できます。

userIdentity

タスクを実行するユーザー id。
省略した場合、タスクはタスクに固有の管理者以外のユーザーとして実行されます。

TaskConstraints

タスクに適用する実行制約。

Name Type Description
maxTaskRetryCount
  • integer

タスクを再試行できる最大回数。 Batch サービスは、終了コードが 0 以外の場合、タスクを再試行します。
この値は、0 以外の終了コードによる Task 実行可能ファイルの再試行回数を具体的に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (初回試行は 1 回、再試行回数は 3 回)。 最大再試行回数が 0 の場合、Batch サービスは最初の試行後にタスクを再試行されません。 最大再試行回数が -1 の場合、Batch サービスは制限なしでタスクを再試行します。

maxWallClockTime
  • string

タスクが開始されてから測定される、タスクが実行できる最大経過時間。 タスクが制限時間内に完了しない場合、Batch サービスはタスクを終了します。
これを指定しない場合、タスクの実行時間に制限はありません。

retentionTime
  • string

実行が完了した時間から、実行されたコンピューティング ノードに Task ディレクトリを保持する最小時間。 この時間が過わると、Batch サービスによって Task ディレクトリとそのすべての内容が削除される可能性があります。
既定値は 7 日です。つまり、コンピューティング ノードが削除されたか、ジョブが削除されていない限り、Task ディレクトリは 7 日間保持されます。

TaskContainerSettings

タスクのコンテナー設定です。

Name Type Description
containerRunOptions
  • string

コンテナーの create コマンドに追加のオプションがあります。
これらの追加オプションは、Batch サービスによって制御されるものに加えて、"docker create" コマンドの引数として指定されます。

imageName
  • string

タスクを実行するコンテナーの作成に使用するイメージ。
これは、"docker pull" に指定された完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合は、": latest" というタグが既定値として使用されます。

registry

コンテナーイメージを含むプライベートレジストリ。
プールの作成時にが既に提供されている場合は、この設定を省略できます。

workingDirectory

コンテナータスクの作業ディレクトリの場所です。
既定値は ' taskWorkingDirectory ' です。

TaskDependencies

タスクの依存関係を指定します。 明示的に指定されたタスクまたは依存関係範囲内のタスクは、依存するタスクをスケジュールする前に完了する必要があります。

Name Type Description
taskIdRanges

このタスクが依存するタスク ID 範囲の一覧。 依存するタスクをスケジュールするには、すべての範囲のすべてのタスクが正常に完了している必要があります。

taskIds
  • string[]

このタスクが依存するタスクの一覧。 この一覧のすべてのタスクは、依存するタスクをスケジュールする前に正常に完了する必要があります。
taskIds コレクションの合計文字数は 6,4000 文字に制限されています (つまり、すべてのタスク ID の合計長)。 taskIds コレクションが最大長を超えると、タスクの追加要求はエラー コード TaskDependencyListTooLong で失敗します。 この場合は、代わりにタスク ID 範囲の使用を検討してください。

TaskIdRange

タスクが依存できるタスク Id の範囲。 範囲内の Id を持つすべてのタスクは、依存タスクをスケジュールする前に正常に完了する必要があります。

Name Type Description
end
  • integer

範囲内の最後のタスク ID。

start
  • integer

範囲内の最初のタスク ID。

UserIdentity

タスクを実行するユーザー ID の定義。

Name Type Description
autoUser

タスクを実行する自動ユーザー。
userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要があります。

username
  • string

タスクを実行するユーザー ID の名前。
userName プロパティと autoUser プロパティは相互に排他的です。1 つを指定する必要がありますが、両方を指定する必要があります。