Task - Get

指定されたタスクに関する情報を取得します。
マルチインスタンスタスクの場合、affinityId、executionInfo、nodeInfo などの情報は、プライマリタスクを参照します。 サブタスクに関する情報を取得するには、サブタスクの一覧表示 API を使用します。

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2021-06-01.14.0
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&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 です。

taskId
path True
  • string

情報を取得するタスクの ID。

api-version
query True
  • string

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

$expand
query
  • string

OData $expand 句。

$select
query
  • string

OData $select 句。

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 を直接呼び出す場合は、明示的に設定します。

If-Match
  • string

クライアントが認識しているリソースのバージョンに関連付けられている ETag 値。 操作が実行されるのは、サービス上のリソースの現在の ETag がクライアントによって指定された値と正確に一致する場合のみです。

If-None-Match
  • string

クライアントが認識しているリソースのバージョンに関連付けられている ETag 値。 操作が実行されるのは、サービス上のリソースの現在の ETag がクライアントによって指定された値と一致しない場合のみです。

If-Modified-Since
  • string
date-time-rfc1123

クライアントに認識されているリソースの最終更新時刻を示すタイムスタンプ。 操作は、指定された時間以降にサービスのリソースが変更された場合にのみ実行されます。

If-Unmodified-Since
  • string
date-time-rfc1123

クライアントに認識されているリソースの最終更新時刻を示すタイムスタンプ。 操作は、指定された時間以降にサービスのリソースが変更されていない場合にのみ実行されます。

応答

Name Type Description
200 OK

タスクを含む応答です。

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

Task get

Sample Request

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId?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

Sample Response

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2016-09-06T06:59:15.1161429Z",
  "lastModified": "2016-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
  "commandLine": "cmd /c hostname",
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  },
  "multiInstanceSettings": {
    "numberOfInstances": 3,
    "coordinationCommandLine": "cmd /c echo coordinating"
  },
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "retentionTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "requiredSlots": 2,
  "executionInfo": {
    "retryCount": 0,
    "requeueCount": 0
  }
}

定義

AffinityInformation

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

ApplicationPackageReference

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

AuthenticationTokenSettings

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

AutoUserScope

自動ユーザーのスコープ

AutoUserSpecification

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

BatchError

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

BatchErrorDetail

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

CloudTask

Azure Batch タスク。

ComputeNodeIdentityReference

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

ComputeNodeInformation

タスクが実行されたコンピューティング ノードに関する情報。

ContainerRegistry

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

ContainerWorkingDirectory

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

DependencyAction

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

ElevationLevel

ユーザーの昇格レベル。

EnvironmentSetting

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

ErrorCategory

エラーのカテゴリ。

ErrorMessage

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

ExitCodeMapping

タスクが特定の終了コードで終了した場合の Batch サービスの応答方法。

ExitCodeRangeMapping

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

ExitConditions

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

ExitOptions

Batch サービスが特定の終了条件に応答する方法を指定します。

JobAction

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

MultiInstanceSettings

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

NameValuePair

名前と値のペアを表します。

OutputFile

Batch サービスがタスクプロセスの実行を完了した後に、Azure Batch の計算ノードから別の場所にファイルをアップロードするための仕様。

OutputFileBlobContainerDestination

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

OutputFileDestination

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

OutputFileUploadCondition

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

OutputFileUploadOptions

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

ResourceFile

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

TaskConstraints

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

TaskContainerExecutionInformation

タスクが実行されているコンテナーに関する情報を格納します。

TaskContainerSettings

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

TaskDependencies

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

TaskExecutionInformation

タスクの実行に関する情報です。

TaskExecutionResult

タスクの実行結果。

TaskFailureInformation

タスクの失敗に関する情報。

TaskIdRange

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

TaskState

Task の状態。

TaskStatistics

タスクのリソース使用状況の統計情報。

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

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

CloudTask

Azure Batch タスク。

Name Type Description
affinityInfo

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

applicationPackageReferences

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

authenticationTokenSettings

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

commandLine
  • string

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

constraints

このタスクに適用される実行の制約。

containerSettings

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

creationTime
  • string

タスクの作成時刻。

dependsOn

このタスクが依存しているタスク。
このタスクは、依存するすべてのタスクが正常に完了するまでスケジュールされません。 これらのタスクのいずれかが失敗して再試行回数を使い果たすと、このタスクはスケジュールされません。

displayName
  • string

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

eTag
  • string

タスクの ETag。
これは不透明な文字列です。 これを使用すると、要求間でタスクが変更されたかどうかを検出できます。 特に、タスクを更新するときに ETag を渡して、その間に他のタスクが変更されていない場合にのみ変更が有効になるように指定することができます。

environmentSettings

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

executionInfo

タスクの実行に関する情報です。

exitConditions

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

id
  • string

ジョブ内のタスクを一意に識別する文字列です。
ID には、ハイフンとアンダースコアを含む英数字の任意の組み合わせを含めることができ、64文字を超えることはできません。

lastModified
  • string

タスクの最終更新時刻。

multiInstanceSettings

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

nodeInfo

タスクが実行されたコンピューティングノードに関する情報。

outputFiles

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

previousState

タスクの以前の状態です。
タスクが最初のアクティブな状態の場合、このプロパティは設定されません。

previousStateTransitionTime
  • string

タスクが以前の状態になった時刻。
タスクが最初のアクティブな状態の場合、このプロパティは設定されません。

requiredSlots
  • integer

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

resourceFiles

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

state

タスクの現在の状態です。

stateTransitionTime
  • string

タスクが現在の状態になった時刻。

stats

タスクのリソース使用状況の統計。

url
  • string

タスクの URL。

userIdentity

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

ComputeNodeIdentityReference

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

Name Type Description
resourceId
  • string

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

ComputeNodeInformation

タスクが実行されたコンピューティング ノードに関する情報。

Name Type Description
affinityId
  • string

タスクが実行されたノードの識別子。タスクを追加するときに渡し、このコンピューティング ノードでタスクをスケジュールする必要があります。

nodeId
  • string

タスクが実行されたコンピューティング ノードの ID。

nodeUrl
  • string

タスクが実行されたコンピューティング ノードの URL。

poolId
  • string

タスクが実行されたプールの ID。

taskRootDirectory
  • string

コンピューティング ノード上のタスクのルート ディレクトリ。

taskRootDirectoryUrl
  • string

コンピューティング ノード上のタスクのルート ディレクトリへの URL。

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

環境変数の値。

ErrorCategory

エラーのカテゴリ。

Name Type Description
servererror
  • string

このエラーは、内部サーバーの問題が原因で発生します。

usererror
  • 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 サービスが実行するアクション。
指定できる値は 、'satisfy' (依存タスクの進行を許可) と 'block' (依存タスクは待機し続けます) です。 Batch では、依存タスクの取り消しはまだサポートされていません。

jobAction

指定された終了条件でタスクが完了し、ジョブの onTaskFailed プロパティが 'performExitOptionsJobAction' である場合に、タスクを含むジョブに対して実行するアクション。
既定値は、終了コード 0 の場合は none で、他のすべての終了条件では終了します。 Job の 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 です。

NameValuePair

名前と値のペアを表します。

Name Type Description
name
  • string

名前と値のペアの名前。

value
  • string

名前と値のペアの値。

OutputFile

Batch サービスがタスクプロセスの実行を完了した後に、Azure Batch の計算ノードから別の場所にファイルをアップロードするための仕様。

Name Type Description
destination

出力ファイルのコピー先。

filePattern
  • string

アップロードするファイルを示すパターン。
相対パスと絶対パスの両方がサポートされています。 相対パスは、タスクの作業ディレクトリに対する相対パスです。 次のワイルドカードがサポートされています。 * は、0個以上の文字に一致します (たとえば、pattern abc * は abc または abcdef と一致します)。 * * は任意のディレクトリに一致しますか? 任意の1文字と一致し、[abc] は角かっこ内の1文字と一致し、[a-c] は範囲内の1文字と一致します。 角かっこには、指定されていない任意の文字と一致する否定を含めることができます (たとえば、[! abc] は任意の文字、a、b、または c に一致します)。 ファイル名が "." で始まる場合は、既定では無視されますが、明示的に指定することによって一致させることができます (たとえば 、.gif は .a.gif と一致しませんが、.gif は一致しません )。 単純な例: .txt は、* '. ' で開始されず、タスクの作業ディレクトリまたは任意のサブディレクトリ内の .txt で終了するすべてのファイルと一致します。ファイル名にワイルドカード文字が含まれている場合は、角かっこを使用してエスケープできます (たとえば、abc [*] は abc * という名前のファイルに一致します)。 Windows では \ と/の両方をディレクトリ区切り記号として扱うことに注意してください。ただし、は Linux 上でのみ/です。 環境変数 (Windows では% var%、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 コンピューティングノードにダウンロードされるファイルにのみ適用されます。 Windows の計算ノードにダウンロードされる resourceFile に対して指定されている場合、無視されます。 Linux コンピューティングノードに対してこのプロパティが指定されていない場合、既定値の0770がファイルに適用されます。

filePath
  • string

タスクの作業ディレクトリを基準とした、ファイルのダウンロード先となる計算ノード上の場所。
HttpUrl プロパティを指定する場合は、ファイル名を含めて、ファイルのダウンロード先のパスを記述する必要があります。 それ以外の場合、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 を設定してパブリックアクセスを許可する方法です。

TaskConstraints

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

Name Type Description
maxTaskRetryCount
  • integer

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

maxWallClockTime
  • string

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

retentionTime
  • string

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

TaskContainerExecutionInformation

タスクが実行されているコンテナーに関する情報を格納します。

Name Type Description
containerId
  • string

コンテナーの ID。

error
  • string

コンテナーに関する詳細なエラー情報。
これは、Docker サービスからの詳細なエラー文字列です (使用可能な場合)。 これは、"docker 検査" によって返される error フィールドと同じです。

state
  • string

コンテナーの状態。
これは、Docker サービスによるコンテナーの状態です。 これは、"docker 検査" によって返される status フィールドと同じです。

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 範囲の使用を検討してください。

TaskExecutionInformation

タスクの実行に関する情報です。

Name Type Description
containerInfo

タスクが実行されているコンテナーに関する情報。
このプロパティは、Task がコンテナー コンテキストで実行される場合にのみ設定されます。

endTime
  • string

タスクが完了した時刻。
このプロパティは、タスクが完了状態の場合にのみ設定されます。

exitCode
  • integer

タスクのコマンドラインで指定されたプログラムの終了コード。
このプロパティは、Task が完了状態の場合にのみ設定されます。 一般に、プロセスの終了コードは、アプリケーション開発者によってそのプロセスに実装される特定の規則を反映しています。 終了コード値を使用してコード内で決定を行う場合は、アプリケーション プロセスで使用される終了コード規則を知っている必要があります。 ただし、Batch サービスがタスクを終了した場合 (タイムアウトまたは API を使用したユーザー終了のため)、オペレーティング システムで定義された終了コードが表示される場合があります。

failureInfo

タスクの失敗を示す情報 (表示されている場合)。
このプロパティは、Task が完了状態でエラーが発生した場合にのみ設定されます。

lastRequeueTime
  • string

ユーザー要求の結果として Batch サービスによってタスクが再キューされた最新の時刻。
このプロパティは、requeueCount が 0 以外の場合にのみ設定されます。

lastRetryTime
  • string

タスクの再試行が開始された最も新しい時刻。
この要素は、Task が再試行された場合にのみ存在します (retryCount が 0 以外の場合)。 存在する場合、これは通常 startTime と同じですが、再試行以外の理由でタスクが再起動された場合は異なる場合があります。たとえば、再試行中にコンピューティング ノードが再起動された場合、startTime は更新されますが、lastRetryTime は更新されません。

requeueCount
  • integer

ユーザー要求の結果として Batch サービスによってタスクが再キューされた回数。
ユーザーが (プールのサイズ変更または縮小によって) プールからコンピューティング ノードを削除する場合、またはジョブが無効になっている場合、ユーザーは計算ノードで実行中のタスクを実行のために再キューに入れ直す必要を指定できます。 この数は、これらの理由でタスクが再キューされた回数を追跡します。

result

タスク実行の結果。
値が "failed" の場合、エラーの詳細は failureInfo プロパティにあります。

retryCount
  • integer

Batch サービスによってタスクが再試行された回数。
タスク アプリケーションのエラー (ゼロ以外の終了コード) が再試行され、前処理エラー (タスクを実行できない) が発生し、ファイルのアップロード エラーは再試行されません。 Batch サービスは、制約で指定された制限までタスクを再試行します。

startTime
  • string

タスクの実行が開始された時刻。
' Running ' は実行中の状態に対応しているため、タスクでリソースファイルまたはパッケージを指定すると、開始時刻には、タスクがそれらのダウンロードまたは展開を開始した時刻が反映されます。 タスクが再起動または再試行された場合は、タスクが実行を開始した最新の時刻になります。 このプロパティは、実行中または完了済みの状態のタスクに対してのみ存在します。

TaskExecutionResult

タスクの実行結果。

Name Type Description
failure
  • string

タスクの処理中にエラーが発生しました。 このエラーは、タスクプロセスの開始前、タスクプロセスの実行中、またはタスクプロセスの終了後に発生した可能性があります。

success
  • string

タスクが正常に実行されました。

TaskFailureInformation

タスクの失敗に関する情報。

Name Type Description
category

タスクエラーのカテゴリ。

code
  • string

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

details

エラーに関連する追加情報の一覧。

message
  • string

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

TaskIdRange

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

Name Type Description
end
  • integer

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

start
  • integer

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

TaskState

Task の状態。

Name Type Description
active
  • string

タスクはキューに登録されて実行できますが、現在はコンピューティングノードに割り当てられていません。 タスクは、作成されたとき、無効になった後に有効になったとき、または実行に失敗した後に再試行を待機しているときに、この状態になります。

completed
  • string

タスクが正常に完了したか、タスクが正常に完了して再試行の制限を超えたことが原因で、タスクが実行対象になりません。 タスクの起動中にエラーが発生した場合、またはタスクが終了した場合にも、タスクは完了としてマークされます。

preparing
  • string

タスクはコンピューティングノードに割り当てられていますが、コンピューティングノードで必要なジョブ準備タスクが完了するのを待機しています。 ジョブ準備タスクが成功した場合、タスクは [実行中] に移動します。 ジョブ準備タスクが失敗した場合、タスクはアクティブに戻り、別のコンピューティングノードに割り当てることができます。

running
  • string

タスクは計算ノードで実行されています。 これには、リソースファイルのダウンロードや、タスクで指定されたパッケージの展開などのタスクレベルの準備が含まれます。これは、必ずしもタスクのコマンドラインが実行を開始したことを意味するわけではありません。

TaskStatistics

タスクのリソース使用状況の統計情報。

Name Type Description
kernelCPUTime
  • string

タスクによって消費されたカーネル モードの CPU 時間の合計 (すべてのコアとすべてのコンピューティング ノードで合計)。

lastUpdateTime
  • string

統計が最後に更新された時刻。 すべての統計は、startTime と lastUpdateTime の範囲に制限されます。

readIOGiB
  • number

タスクによってディスクから読み取った合計ギビバイト数。

readIOps
  • integer

タスクによって行われたディスク読み取り操作の総数。

startTime
  • string

統計の対象となる時間範囲の開始時刻。

url
  • string

統計の URL。

userCPUTime
  • string

タスクによって消費されたユーザー モードの CPU 時間の合計 (すべてのコアとすべてのコンピューティング ノードで合計)。

waitTime
  • string

タスクの合計待機時間。 タスクの待機時間は、タスクの作成からタスク実行の開始までの経過時間として定義されます。 (エラーが原因でタスクが再試行された場合、待機時間は最新のタスク実行時間になります)。

wallClockTime
  • string

タスクの合計ウォール クロック時間。
ウォール クロック時間は、タスクがコンピューティング ノードで実行を開始してから終了するまでの経過時間です (それまでにタスクが完了していない場合は、統計が最後に更新されました)。 タスクが再試行された場合、これにはすべてのタスク再試行のウォール クロック時間が含まれます。

writeIOGiB
  • number

タスクによってディスクに書き込まれた合計ギビバイト数。

writeIOps
  • integer

タスクによって行われたディスク書き込み操作の総数。

UserIdentity

タスクの実行に使用するユーザー id の定義。

Name Type Description
autoUser

タスクが実行される自動ユーザー。
UserName プロパティと autoUser プロパティは相互に排他的です。どちらか一方だけを指定する必要があります。

username
  • string

タスクの実行に使用するユーザー id の名前。
UserName プロパティと autoUser プロパティは相互に排他的です。どちらか一方だけを指定する必要があります。