Compute Node - List

サービス:

Batch Service

API バージョン:

2024-07-01.20.0

指定したプール内のコンピューティング ノードを一覧表示します。

GET {batchUrl}/pools/{poolId}/nodes?api-version=2024-07-01.20.0

省略可能なパラメーターを含む:

GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべての Azure Batch サービス要求のベース URL。
poolId	path	True	string	コンピューティング ノードを一覧表示するプールの ID。
api-version	query	True	string	クライアント API のバージョン。
$filter	query		string	OData $filter 句。 このフィルターの構築の詳細については、https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-poolを参照してください。
$select	query		string	OData $select 句。
maxresults	query		integer int32	応答で返される項目の最大数。 最大 1,000 個のコンピューティング ノードを返すことができます。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が 30 より大きい場合は、代わりに既定値が使用されます。

要求ヘッダー

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

名前	必須	型	説明
client-request-id		string uuid	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id		boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date		string date-time-rfc1123	要求が発行された時刻。 通常、クライアント ライブラリはこれを現在のシステム クロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
200 OK	ComputeNodeListResult	コンピューティング ノードの一覧を含む応答。 ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コード フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

Authorization

型: apiKey
/: header

例

Node list

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2024-07-01.20.0

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "tvm-1695681911_1-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2016-11-22T22:22:27.2236818Z",
      "lastBootTime": "2016-11-22T22:22:24.4634125Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "small",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T22:22:27.2236818Z",
        "endTime": "2016-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_2-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
      "lastBootTime": "2016-11-22T19:37:28.623369Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "small",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:37:31.4285526Z",
        "endTime": "2016-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_3-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2016-11-22T19:36:51.0013378Z",
      "lastBootTime": "2016-11-22T19:36:48.21721Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "small",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:36:51.0013378Z",
        "endTime": "2016-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

定義

名前	説明
AutoUserScope	自動ユーザーのスコープ
AutoUserSpecification	Batch サービスでタスクを実行する自動ユーザーのパラメーターを指定します。
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
CertificateReference	プール内のコンピューティング ノードにインストールされる証明書への参照。
CertificateStoreLocation	証明書をインストールするコンピューティング ノード上の証明書ストアの場所。
CertificateVisibility	証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。
ComputeNode	Batch サービスのコンピューティング ノード。
ComputeNodeEndpointConfiguration	コンピューティング ノードのエンドポイント構成。
ComputeNodeError	コンピューティング ノードで発生したエラー。
ComputeNodeIdentityReference	コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
ComputeNodeListResult	プール内のコンピューティング ノードを一覧表示した結果。
ComputeNodeState	コンピューティング ノードの現在の状態。
ContainerHostBatchBindMountEntry	タスク コンテナーにマウントするパスとマウント モードのエントリ。
ContainerHostDataPath	コンテナー タスクのコンテナーにマウントされるパス。
ContainerRegistry	プライベート コンテナー レジストリ。
ContainerWorkingDirectory	コンテナータスク作業ディレクトリの場所。
ElevationLevel	ユーザーの昇格レベル。
EnvironmentSetting	タスク プロセスで設定する環境変数。
ErrorCategory	エラーのカテゴリ。
ErrorMessage	Azure Batch エラー応答で受信したエラー メッセージ。
ImageReference	Azure Virtual Machines Marketplace イメージまたは Azure コンピューティング ギャラリー イメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。
InboundEndpoint	コンピューティング ノード上の受信エンドポイント。
InboundEndpointProtocol	エンドポイントのプロトコル。
NameValuePair	名前と値のペアを表します。
NodeAgentInformation	コンピューティング ノード エージェントに関する情報。
ResourceFile	コンピューティング ノードにダウンロードする 1 つのファイルまたは複数のファイル。
SchedulingState	コンピューティング ノードがタスクのスケジュール設定に使用できるかどうかを示します。
StartTask	ノードが Azure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。
StartTaskInformation	コンピューティング ノードで実行されている StartTask に関する情報。
StartTaskState	コンピューティング ノード上の StartTask の状態。
TaskContainerExecutionInformation	タスクが実行されているコンテナーに関する情報を格納します。
TaskContainerSettings	タスクのコンテナー設定。
TaskExecutionInformation	タスクの実行に関する情報。
TaskExecutionResult	タスクの実行結果。
TaskFailureInformation	タスクの失敗に関する情報。
TaskInformation	コンピューティング ノードで実行されているタスクに関する情報。
TaskState	タスクの状態。
UserIdentity	タスクを実行するユーザー ID の定義。
VirtualMachineInfo	仮想マシンの現在の状態に関する情報。

AutoUserScope

自動ユーザーのスコープ

名前	型	説明
pool	string	タスクが、プール内のすべてのコンピューティング ノードで作成される共通の自動ユーザー アカウントとして実行されるように指定します。
task	string	サービスがタスクの新しいユーザーを作成することを指定します。

AutoUserSpecification

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

名前	型	説明
elevationLevel	ElevationLevel	自動ユーザーの昇格レベル。 既定値は nonAdmin です。
scope	AutoUserScope	自動ユーザーのスコープ 既定値は pool です。 プールが Windows を実行している場合は、タスク間のより厳密な分離が必要な場合は、Task の値を指定する必要があります。 たとえば、タスクが他のタスクに影響を与える可能性のある方法でレジストリを変更する場合や、通常のタスクではアクセスできないが StartTasks からアクセスできる必要がある証明書がプールで指定されている場合などです。

BatchError

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

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
message	ErrorMessage	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

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

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

CertificateReference

プール内のコンピューティング ノードにインストールされる証明書への参照。

名前	型	説明
storeLocation	CertificateStoreLocation	証明書をインストールするコンピューティング ノード上の証明書ストアの場所。 既定値は currentuser です。 このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。
storeName	string	証明書をインストールするコンピューティング ノード上の証明書ストアの名前。 このプロパティは、Windows コンピューティング ノードで構成されたプールにのみ適用されます。 一般的なストア名には、My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook などがありますが、カスタム ストア名も使用できます。 既定値は My です。
thumbprint	string	証明書の拇印。
thumbprintAlgorithm	string	拇印が関連付けられているアルゴリズム。 これは sha1 である必要があります。
visibility	CertificateVisibility[]	証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。 このコレクションでは、複数の可視性を指定できます。 既定値はすべてのアカウントです。

CertificateStoreLocation

証明書をインストールするコンピューティング ノード上の証明書ストアの場所。

名前	型	説明
currentuser	string	証明書は CurrentUser 証明書ストアにインストールする必要があります。
localmachine	string	証明書は LocalMachine 証明書ストアにインストールする必要があります。

CertificateVisibility

証明書のプライベート データにアクセスできるコンピューティング ノード上のユーザー アカウント。

名前	型	説明
remoteuser	string	証明書は、ユーザーがコンピューティング ノードにリモートでアクセスするユーザー アカウントに表示される必要があります。
starttask	string	証明書は、StartTask が実行されているユーザー アカウントに表示されます。 AutoUser スコープが StartTask と Task の両方のプールである場合、この証明書はタスクにも表示されることに注意してください。
task	string	証明書は、ジョブ タスクが実行されているユーザー アカウントに表示されます。

ComputeNode

Batch サービスのコンピューティング ノード。

名前	型	説明
affinityId	string	タスクを追加して、このコンピューティング ノードでタスクをスケジュールするように要求するときに渡すことができる識別子。 これは単なるソフト アフィニティであることに注意してください。 タスクがスケジュールされている時点でターゲットのコンピューティング ノードがビジー状態または使用できない場合、タスクは別の場所でスケジュールされます。
allocationTime	string	このコンピューティング ノードがプールに割り当てられた時刻。 これは、コンピューティング ノードが最初に割り当てられ、設定後に変更されない時刻です。 コンピューティング ノードがサービスの回復または割り込み時に更新されません。
certificateReferences	CertificateReference[]	コンピューティング ノードにインストールされている証明書の一覧。 Windows ノードの場合、Batch サービスは、指定された証明書ストアと場所に証明書をインストールします。 Linux コンピューティング ノードの場合、証明書はタスク作業ディレクトリ内のディレクトリに格納され、この場所を照会するためにタスクにAZ_BATCH_CERTIFICATES_DIR環境変数が提供されます。 'remoteUser' の可視性を持つ証明書の場合、ユーザーのホーム ディレクトリ (/home/{user-name}/certs など) に 'certs' ディレクトリが作成され、そのディレクトリに証明書が配置されます。 警告: このプロパティは非推奨であり、2024 年 2 月以降に削除されます。 代わりに、Azure KeyVault 拡張機能 を使用してください。
endpointConfiguration	ComputeNodeEndpointConfiguration	コンピューティング ノードのエンドポイント構成。
errors	ComputeNodeError[]	コンピューティング ノードで現在発生しているエラーの一覧。
id	string	コンピューティング ノードの ID。 プールに追加されるすべてのコンピューティング ノードには、一意の ID が割り当てられます。 コンピューティング ノードがプールから削除されるたびに、そのローカル ファイルがすべて削除され、ID が再利用され、新しいコンピューティング ノードに再利用できます。
ipAddress	string	他のノードがこのコンピューティング ノードとの通信に使用できる IP アドレス。 プールに追加されるすべてのコンピューティング ノードには、一意の IP アドレスが割り当てられます。 コンピューティング ノードがプールから削除されるたびに、そのすべてのローカル ファイルが削除され、IP アドレスが再利用され、新しいコンピューティング ノードに再利用できます。
isDedicated	boolean	このコンピューティング ノードが専用のコンピューティング ノードであるかどうか。 false の場合、コンピューティング ノードはスポット/優先順位の低いコンピューティング ノードです。
lastBootTime	string	コンピューティング ノードが最後に開始された時刻。 コンピューティング ノードの状態が使用できない場合は、このプロパティが存在しない可能性があります。
nodeAgentInfo	NodeAgentInformation	コンピューティング ノード エージェントのバージョンと、コンピューティング ノードが新しいバージョンにアップグレードされた時刻に関する情報。 Batch コンピューティング ノード エージェントは、プール内の各コンピューティング ノードで実行され、コンピューティング ノードで Batch 機能を提供するプログラムです。
recentTasks	TaskInformation[]	状態が最近変更されたタスクの一覧。 このプロパティは、プールに割り当てられた後、このコンピューティング ノードで少なくとも 1 つのタスクが実行されている場合にのみ存在します。
runningTaskSlotsCount	integer	コンピューティング ノードで現在実行中のジョブ タスクによって使用されるスケジュール スロットの合計数。 これには、ジョブ マネージャー タスクと通常のタスクが含まれますが、ジョブの準備、ジョブの解放、または開始タスクは含まれません。
runningTasksCount	integer	コンピューティング ノードで現在実行中のジョブ タスクの合計数。 これには、ジョブ マネージャー タスクと通常のタスクが含まれますが、ジョブの準備、ジョブの解放、または開始タスクは含まれません。
schedulingState	SchedulingState	コンピューティング ノードがタスクのスケジュール設定に使用できるかどうかを示します。
startTask	StartTask	プールに参加するコンピューティング ノードで実行するように指定されたタスク。 Batch は、ノードで復旧操作がトリガーされたときにタスクを再試行します。 復旧操作の例としては、異常なノードが再起動されたときや、ホスト障害が原因でコンピューティング ノードが消えた場合などです (ただし、これらに限定されません)。 回復操作による再試行は独立しており、maxTaskRetryCount に対してカウントされません。 maxTaskRetryCount が 0 の場合でも、復旧操作による内部再試行が発生する可能性があります。 このため、すべてのタスクはべき等である必要があります。 つまり、タスクは、破損やデータの重複を引き起こさずに中断および再起動されることを許容する必要があります。 実行時間の長いタスクのベスト プラクティスは、何らかの形式のチェックポイント処理を使用することです。 場合によっては、コンピューティング ノードが再起動されなかった場合でも、StartTask が再実行されることがあります。 中断プロセスを作成したり、StartTask 作業ディレクトリからサービスをインストール/起動したりする StartTask を回避するには、特別な注意が必要です。これにより、Batch で StartTask を再実行できなくなるためです。
startTaskInfo	StartTaskInformation	コンピューティング ノードでの StartTask の実行に関するランタイム情報。
state	ComputeNodeState	コンピューティング ノードの現在の状態。 スポット/低優先度のコンピューティング ノードが割り込まれています。 コンピューティング ノードが割り込まれたときにコンピューティング ノードで実行されていたタスクは、別のコンピューティング ノードが使用可能になったときに再スケジュールされます。
stateTransitionTime	string	コンピューティング ノードが現在の状態になった時刻。
totalTasksRun	integer	コンピューティング ノードで完了したジョブ タスクの合計数。 これには、ジョブ マネージャー タスクと通常のタスクが含まれますが、ジョブの準備、ジョブの解放、または開始タスクは含まれません。
totalTasksSucceeded	integer	コンピューティング ノードで (exitCode 0 を使用して) 正常に完了したジョブ タスクの合計数。 これには、ジョブ マネージャー タスクと通常のタスクが含まれますが、ジョブの準備、ジョブの解放、または開始タスクは含まれません。
url	string	コンピューティング ノードの URL。
virtualMachineInfo	VirtualMachineInfo	仮想マシンの現在の状態に関する情報。
vmSize	string	コンピューティング ノードをホストしている仮想マシンのサイズ。 プールで使用可能な仮想マシンのサイズについては、「Azure Batch プールのコンピューティング ノードの VM サイズの選択 (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)」を参照してください。

ComputeNodeEndpointConfiguration

コンピューティング ノードのエンドポイント構成。

名前	型	説明
inboundEndpoints	InboundEndpoint[]	コンピューティング ノードでアクセスできる受信エンドポイントの一覧。

ComputeNodeError

コンピューティング ノードで発生したエラー。

名前	型	説明
code	string	コンピューティング ノード エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
errorDetails	NameValuePair[]	コンピューティング ノード エラーに関連する追加エラーの詳細の一覧。
message	string	ユーザー インターフェイスでの表示に適したコンピューティング ノード エラーを説明するメッセージ。

ComputeNodeIdentityReference

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

名前	型	説明
resourceId	string	ユーザー割り当て ID の ARM リソース ID。

ComputeNodeListResult

プール内のコンピューティング ノードを一覧表示した結果。

名前	型	説明
odata.nextLink	string	次の結果セットを取得する URL。
value	ComputeNode[]	コンピューティング ノードの一覧。

ComputeNodeState

コンピューティング ノードの現在の状態。

名前	型	説明
creating	string	Batch サービスは、基になる仮想マシンを Azure Compute から取得しましたが、プールへの参加はまだ開始されていません。
deallocated	string	コンピューティング ノードの割り当てが解除されます。
deallocating	string	コンピューティング ノードの割り当てが解除されています。
idle	string	コンピューティング ノードは現在タスクを実行していません。
leavingpool	string	コンピューティング ノードは、ユーザーがプールを明示的に削除したか、プールのサイズを変更または自動スケールダウンしているため、プールから離れることになります。
offline	string	コンピューティング ノードは現在タスクを実行していないため、コンピューティング ノードへの新しいタスクのスケジュール設定は無効になっています。
preempted	string	スポット/低優先度のコンピューティング ノードが割り込まれています。 コンピューティング ノードが割り込まれたときにコンピューティング ノードで実行されていたタスクは、別のコンピューティング ノードが使用可能になったときに再スケジュールされます。
rebooting	string	コンピューティング ノードが再起動中です。
reimaging	string	コンピューティング ノードが再イメージ化されています。
running	string	コンピューティング ノードは、1 つ以上のタスク (StartTask 以外) を実行しています。
starting	string	基になる仮想マシンで Batch サービスが開始されています。
starttaskfailed	string	StartTask はコンピューティング ノードで失敗し (すべての再試行を使い果たしました)、waitForSuccess が設定されています。 コンピューティング ノードは、タスクの実行には使用できません。
unknown	string	Batch サービスはコンピューティング ノードとの接触を失い、その真の状態を認識していません。
unusable	string	コンピューティング ノードは、エラーが原因でタスクの実行に使用できません。
upgradingos	string	コンピューティング ノードで OS のアップグレード操作が行われます。
waitingforstarttask	string	StartTask はコンピューティング ノードで実行を開始しましたが、waitForSuccess が設定され、StartTask はまだ完了していません。

ContainerHostBatchBindMountEntry

タスク コンテナーにマウントするパスとマウント モードのエントリ。

名前	型	説明
isReadOnly	boolean	このソース パスを読み取り専用モードとしてマウントするかどうか。 既定値は false (読み取り/書き込みモード) です。 Linux の場合、このパスを読み取り/書き込みモードとしてマウントした場合、コンテナー内のすべてのユーザーがパスの読み取り/書き込みアクセス権を持っているわけではありません。これは、ホスト VM のアクセスに依存します。 このパスが読み取り専用でマウントされている場合、コンテナー内のすべてのユーザーはパスを変更できません。
source	ContainerHostDataPath	コンテナー顧客にマウントするパスを選択できます。

ContainerHostDataPath

コンテナー タスクのコンテナーにマウントされるパス。

名前	型	説明
Applications	string	アプリケーション パス。
JobPrep	string	ジョブ準備タスクのパス。
Shared	string	複数インスタンス のタスクがファイルを共有するためのパス。
Startup	string	開始タスクのパス。
Task	string	タスク パス。
VfsMounts	string	パスには、このノードにマウントされているすべての仮想ファイル システムが含まれています。

ContainerRegistry

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

名前	型	説明
identityReference	ComputeNodeIdentityReference	ユーザー名とパスワードではなく、Azure Container Registry へのアクセスに使用するユーザー割り当て ID への参照。 コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
password	string	レジストリ サーバーにログインするためのパスワード。
registryServer	string	レジストリ URL。 省略した場合、既定値は "docker.io" です。
username	string	レジストリ サーバーにログインするユーザー名。

ContainerWorkingDirectory

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

名前	型	説明
containerImageDefault	string	コンテナー イメージで定義されている作業ディレクトリを使用します。 このディレクトリには、Batch によってダウンロードされたリソース ファイルが含まれていないことに注意してください。
taskWorkingDirectory	string	Batch によって設定されたタスク リソース ファイルが含まれる標準の Batch サービスタスク作業ディレクトリを使用します。

ElevationLevel

ユーザーの昇格レベル。

名前	型	説明
admin	string	ユーザーは昇格されたアクセス権を持つユーザーであり、完全な管理者権限で動作します。
nonadmin	string	ユーザーは、昇格されたアクセス権を持たない標準ユーザーです。

EnvironmentSetting

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

名前	型	説明
name	string	環境変数の名前。
value	string	環境変数の値。

ErrorCategory

エラーのカテゴリ。

名前	型	説明
servererror	string	エラーは、内部サーバーの問題が原因です。
usererror	string	このエラーは、構成の誤りなど、ユーザーの問題が原因です。

ErrorMessage

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

名前	型	説明
lang	string	エラー メッセージの言語コード
value	string	メッセージのテキスト。

ImageReference

Azure Virtual Machines Marketplace イメージまたは Azure コンピューティング ギャラリー イメージへの参照。 Azure Batch によって検証されたすべての Azure Marketplace イメージ参照の一覧を取得するには、「サポートされているイメージの一覧表示」操作を参照してください。

名前	型	説明
communityGalleryImageId	string	コミュニティ ギャラリー イメージの一意識別子 このプロパティは他のプロパティと相互に排他的であり、コミュニティ ギャラリー イメージの GET 呼び出しからフェッチできます。
exactVersion	string	ノードの作成に使用されるプラットフォーム イメージまたはマーケットプレース イメージの特定のバージョン。 この読み取り専用フィールドは、プールの作成時に 'version' に指定された値が 'latest' の場合にのみ、'version' と異なります。
offer	string	Azure Virtual Machines Marketplace イメージのオファーの種類。 たとえば、UbuntuServer や WindowsServer などです。
publisher	string	Azure Virtual Machines Marketplace イメージの発行元。 たとえば、Canonical または MicrosoftWindowsServer です。
sharedGalleryImageId	string	共有ギャラリー イメージの一意識別子 このプロパティは他のプロパティと相互に排他的であり、共有ギャラリー イメージの GET 呼び出しからフェッチできます。
sku	string	Azure Virtual Machines Marketplace イメージの SKU。 たとえば、18.04-LTS や 2019-Datacenter などです。
version	string	Azure Virtual Machines Marketplace イメージのバージョン。 'latest' の値を指定して、イメージの最新バージョンを選択できます。 省略した場合、既定値は 'latest' です。
virtualMachineImageId	string	Azure コンピューティング ギャラリー イメージの ARM リソース識別子。 プール内のコンピューティング ノードは、このイメージ ID を使用して作成されます。これは、常に最新のイメージ バージョンに既定値を設定するために、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} または /subscriptions/{subscriptionId}/resourceGroup}/providers/Microsoft.Compute/galleryName}/images/{imageDefinitionName} の形式です。 このプロパティは、他の ImageReference プロパティと相互に排他的です。 Azure コンピューティング ギャラリー イメージは、同じリージョンにレプリカを持ち、Azure Batch アカウントと同じサブスクリプション内にある必要があります。 イメージのバージョンが imageId で指定されていない場合は、最新バージョンが使用されます。 Batch サービスと通信するための Batch コンピューティング ノード エージェントのファイアウォール設定については、https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configurationを参照してください。

InboundEndpoint

コンピューティング ノード上の受信エンドポイント。

名前	型	説明
backendPort	integer	エンドポイントのバックエンド ポート番号。
frontendPort	integer	エンドポイントのパブリック ポート番号。
name	string	エンドポイントの名前。
protocol	InboundEndpointProtocol	エンドポイントのプロトコル。
publicFQDN	string	コンピューティング ノードのパブリック完全修飾ドメイン名。
publicIPAddress	string	コンピューティング ノードのパブリック IP アドレス。

InboundEndpointProtocol

エンドポイントのプロトコル。

名前	型	説明
tcp	string	エンドポイントには TCP を使用します。
udp	string	エンドポイントには UDP を使用します。

NameValuePair

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

名前	型	説明
name	string	名前と値のペアの名前。
value	string	名前と値のペアの値。

NodeAgentInformation

コンピューティング ノード エージェントに関する情報。

名前	型	説明
lastUpdateTime	string	コンピューティング ノード でコンピューティング ノード エージェントが更新された時刻。 これは、コンピューティング ノード エージェントが新しいバージョンに更新された最新の時刻です。
version	string	コンピューティング ノードで実行されている Batch コンピューティング ノード エージェントのバージョン。 このバージョン番号は、https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.mdにあるコンピューティング ノード エージェントのリリース ノートに対して確認できます。

ResourceFile

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

名前	型	説明
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 プロパティが指定されている場合、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	ComputeNodeIdentityReference	storageContainerUrl または httpUrl で指定された Azure Blob Storage へのアクセスに使用するユーザー割り当て ID への参照 コンピューティング ノードが使用する Batch プールに関連付けられているユーザー割り当て ID への参照。
storageContainerUrl	string	Azure Blob Storage 内の BLOB コンテナーの URL。 autoStorageContainerName、storageContainerUrl、および httpUrl プロパティは相互に排他的であり、そのうちの 1 つを指定する必要があります。 この URL は、コンピューティング ノードから読み取り可能でリスト可能である必要があります。 Azure Storage 内のコンテナーのこのような URL を取得するには、3 つの方法があります。コンテナーに対する読み取りと一覧表示のアクセス許可を付与する Shared Access Signature (SAS) を含めるか、読み取りとリストのアクセス許可を持つマネージド ID を使用するか、コンテナーの ACL を設定してパブリック アクセスを許可します。

SchedulingState

コンピューティング ノードがタスクのスケジュール設定に使用できるかどうかを示します。

名前	型	説明
disabled	string	コンピューティング ノードに新しいタスクはスケジュールされません。 コンピューティング ノードで既に実行されているタスクは、引き続き完了まで実行される可能性があります。 すべてのコンピューティング ノードは、スケジュール設定が有効な状態で開始されます。
enabled	string	タスクはコンピューティング ノードでスケジュールできます。

StartTask

ノードが Azure Batch サービスのプールに参加したとき、またはコンピューティング ノードが再起動または再イメージ化されたときに実行されるタスク。

名前	型	説明
commandLine	string	StartTask のコマンド ライン。 コマンド ラインはシェルでは実行されないため、環境変数の拡張などのシェル機能を利用することはできません。 このような機能を利用する場合は、コマンド ラインでシェルを呼び出す必要があります。たとえば、Windows では "cmd /c MyCommand" を使用し、Linux では "/bin/sh -c MyCommand" を使用します。 コマンド ラインがファイル パスを参照している場合は、相対パス (Task 作業ディレクトリに対する相対パス) を使用するか、Batch で指定された環境変数 (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables) を使用する必要があります。
containerSettings	TaskContainerSettings	StartTask を実行するコンテナーの設定。 これを指定すると、AZ_BATCH_NODE_ROOT_DIRの下にあるすべてのディレクトリ (ノード上の Azure Batch ディレクトリのルート) がコンテナーに再帰的にマップされ、すべての Task 環境変数がコンテナーにマップされ、タスク コマンド ラインがコンテナーで実行されます。 AZ_BATCH_NODE_ROOT_DIR外のコンテナーで生成されたファイルはホスト ディスクに反映されない可能性があります。つまり、Batch ファイル API はそれらのファイルにアクセスできません。
environmentSettings	EnvironmentSetting[]	StartTask の環境変数設定の一覧。
maxTaskRetryCount	integer	タスクを再試行できる最大回数。 終了コードが 0 以外の場合、Batch サービスはタスクを再試行します。 この値は、再試行回数を特に制御します。 Batch サービスはタスクを 1 回試し、この制限まで再試行できます。 たとえば、最大再試行回数が 3 の場合、Batch はタスクを最大 4 回試行します (1 回の最初の再試行と 3 回の再試行)。 最大再試行回数が 0 の場合、Batch サービスはタスクを再試行しません。 最大再試行回数が -1 の場合、Batch サービスは制限なくタスクを再試行しますが、これは開始タスクまたはタスクには推奨されません。 既定値は 0 (再試行なし) です。
resourceFiles	ResourceFile[]	コマンド ラインを実行する前に Batch サービスがコンピューティング ノードにダウンロードするファイルの一覧。 リソース ファイルの一覧には最大サイズがあります。 最大サイズを超えると、要求は失敗し、応答エラー コードは RequestEntityTooLarge になります。 この場合、ResourceFiles のコレクションのサイズを小さくする必要があります。 これは、.zip ファイル、アプリケーション パッケージ、または Docker コンテナーを使用して実現できます。 この要素の下に一覧表示されるファイルは、タスクの作業ディレクトリにあります。
userIdentity	UserIdentity	StartTask を実行するユーザー ID。 省略した場合、タスクはタスクに固有の非管理ユーザーとして実行されます。
waitForSuccess	boolean	コンピューティング ノードでタスクをスケジュールする前に、Batch サービスが StartTask が正常に完了するまで (つまり、終了コード 0 で終了する) のを待つ必要があるかどうか。 True で、ノードで StartTask が失敗した場合、Batch サービスは StartTask を最大再試行回数 (maxTaskRetryCount) まで再試行します。 すべての再試行の後もタスクが正常に完了していない場合、Batch サービスはノードを使用不可としてマークし、タスクをスケジュールしません。 この状態は、コンピューティング ノードの状態とエラー情報の詳細を使用して検出できます。 false の場合、Batch サービスは StartTask の完了を待機しません。 この場合、StartTask がまだ実行されている間に、コンピューティング ノードで他のタスクの実行を開始できます。StartTask が失敗した場合でも、新しいタスクはコンピューティング ノードで引き続きスケジュールされます。 既定値は true です。

StartTaskInformation

コンピューティング ノードで実行されている StartTask に関する情報。

名前	型	説明
containerInfo	TaskContainerExecutionInformation	タスクが実行されているコンテナーに関する情報。 このプロパティは、タスクがコンテナー コンテキストで実行される場合にのみ設定されます。
endTime	string	StartTask が実行を停止した時刻。 これは、実行が完了した場合 (その実行が失敗し、再試行が保留中の場合でも) StartTask の最新の実行の終了時刻です。 StartTask が現在実行中の場合、この要素は存在しません。
exitCode	integer	StartTask コマンド ラインで指定されたプログラムの終了コード。 このプロパティは、StartTask が完了状態の場合にのみ設定されます。 一般に、プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されます。 終了コード値を使用してコード内で決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 ただし、Batch サービスが StartTask を終了した場合 (タイムアウトのため、または API を介したユーザー終了が原因)、オペレーティング システムで定義された終了コードが表示されることがあります。
failureInfo	TaskFailureInformation	タスクの失敗を説明する情報 (存在する場合)。 このプロパティは、Task が完了状態でエラーが発生した場合にのみ設定されます。
lastRetryTime	string	タスクの再試行が実行を開始した最新の時刻。 この要素は、Task が再試行された場合にのみ存在します (つまり、retryCount は 0 以外です)。 存在する場合、これは通常、startTime と同じですが、再試行以外の理由でタスクが再起動された場合は異なる場合があります。たとえば、再試行中にコンピューティング ノードが再起動された場合、startTime は更新されますが、lastRetryTime は更新されません。
result	TaskExecutionResult	タスク実行の結果。 値が 'failed' の場合は、failureInfo プロパティでエラーの詳細を確認できます。
retryCount	integer	Batch サービスによってタスクが再試行された回数。 タスク アプリケーションエラー (0 以外の終了コード) が再試行され、前処理エラー (タスクを実行できませんでした)、ファイルアップロードエラーは再試行されません。 Batch サービスは、制約で指定された制限までタスクを再試行します。
startTime	string	StartTask の実行が開始された時刻。 この値は、タスクが再起動または再試行されるたびにリセットされます (つまり、StartTask が実行を開始した最新の時刻です)。
state	StartTaskState	コンピューティング ノード上の StartTask の状態。

StartTaskState

コンピューティング ノード上の StartTask の状態。

名前	型	説明
completed	string	StartTask が終了コード 0 で終了したか、StartTask が失敗して再試行の上限に達したか、タスク準備エラー (リソース ファイルのダウンロードエラーなど) が原因で StartTask プロセスが実行されませんでした。
running	string	StartTask は現在実行中です。

TaskContainerExecutionInformation

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

名前	型	説明
containerId	string	コンテナーの ID。
error	string	コンテナーに関する詳細なエラー情報。 これは、Docker サービスからの詳細なエラー文字列 (使用可能な場合) です。 これは、"docker inspect" によって返されるエラー フィールドと同じです。
state	string	コンテナーの状態。 これは、Docker サービスに従ったコンテナーの状態です。 これは、"docker inspect" によって返される状態フィールドと同じです。

TaskContainerSettings

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

名前	型	説明
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	コンテナー タスクにマウントするパス。 この配列が null または存在しない場合、コンテナー タスクは一時ディスク ドライブ全体を Windows (または Linux では AZ_BATCH_NODE_ROOT_DIR) にマウントします。 この配列が空として設定されている場合、データ パスはコンテナーにマウントされません。
containerRunOptions	string	コンテナー作成コマンドの追加オプション。 これらの追加オプションは、Batch サービスによって制御されるオプションに加えて、"docker create" コマンドの引数として提供されます。
imageName	string	タスクを実行するコンテナーの作成に使用するイメージ。 これは、"docker pull" に指定されているように、完全なイメージ参照です。 イメージ名の一部としてタグが指定されていない場合は、タグ ":latest" が既定として使用されます。
registry	ContainerRegistry	コンテナー イメージを含むプライベート レジストリ。 この設定は、プールの作成時に既に指定されている場合は省略できます。
workingDirectory	ContainerWorkingDirectory	コンテナータスク作業ディレクトリの場所。 既定値は 'taskWorkingDirectory' です。

TaskExecutionInformation

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

名前	型	説明
containerInfo	TaskContainerExecutionInformation	タスクが実行されているコンテナーに関する情報。 このプロパティは、タスクがコンテナー コンテキストで実行される場合にのみ設定されます。
endTime	string	タスクが完了した時刻。 このプロパティは、Task が Completed 状態の場合にのみ設定されます。
exitCode	integer	タスク コマンド ラインで指定されたプログラムの終了コード。 このプロパティは、Task が完了状態の場合にのみ設定されます。 一般に、プロセスの終了コードには、そのプロセスに対してアプリケーション開発者によって実装された特定の規則が反映されます。 終了コード値を使用してコード内で決定を行う場合は、アプリケーション プロセスで使用される終了コード規則がわかっていることを確認してください。 ただし、Batch サービスがタスクを終了した場合 (タイムアウトのため、または API を使用したユーザー終了が原因)、オペレーティング システムで定義された終了コードが表示されることがあります。
failureInfo	TaskFailureInformation	タスクの失敗を説明する情報 (存在する場合)。 このプロパティは、Task が完了状態でエラーが発生した場合にのみ設定されます。
lastRequeueTime	string	ユーザー要求の結果として Batch サービスによってタスクが再キューされた最新の時刻。 このプロパティは、requeueCount が 0 以外の場合にのみ設定されます。
lastRetryTime	string	タスクの再試行が実行を開始した最新の時刻。 この要素は、Task が再試行された場合にのみ存在します (つまり、retryCount は 0 以外です)。 存在する場合、これは通常、startTime と同じですが、再試行以外の理由でタスクが再起動された場合は異なる場合があります。たとえば、再試行中にコンピューティング ノードが再起動された場合、startTime は更新されますが、lastRetryTime は更新されません。
requeueCount	integer	ユーザー要求の結果として Batch サービスによってタスクが再キューされた回数。 ユーザーがプールからコンピューティング ノードを削除するとき (プールのサイズ変更/縮小によって) またはジョブが無効になっている場合、ユーザーはコンピューティング ノードで実行中のタスクを実行のために再キューに入れるかどうかを指定できます。 この数は、これらの理由からタスクが再キューされた回数を追跡します。
result	TaskExecutionResult	タスク実行の結果。 値が 'failed' の場合は、failureInfo プロパティでエラーの詳細を確認できます。
retryCount	integer	Batch サービスによってタスクが再試行された回数。 タスク アプリケーションエラー (0 以外の終了コード) が再試行され、前処理エラー (タスクを実行できませんでした)、ファイルアップロードエラーは再試行されません。 Batch サービスは、制約で指定された制限までタスクを再試行します。
startTime	string	タスクの実行を開始した時刻。 'Running' は実行中の状態に対応するため、タスクでリソース ファイルまたはパッケージが指定されている場合、開始時刻には、タスクがダウンロードまたはデプロイを開始した時刻が反映されます。 タスクが再起動または再試行された場合、これはタスクの実行を開始した最新の時刻です。 このプロパティは、実行中または完了状態のタスクにのみ存在します。

TaskExecutionResult

タスクの実行結果。

名前	型	説明
failure	string	タスクの処理中にエラーが発生しました。 タスク プロセスが起動される前、タスク プロセスの実行中、またはタスク プロセスが終了した後に、エラーが発生した可能性があります。
success	string	タスクは正常に実行されました。

TaskFailureInformation

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

名前	型	説明
category	ErrorCategory	タスク エラーのカテゴリ。
code	string	タスク エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
details	NameValuePair[]	エラーに関連する追加の詳細の一覧。
message	string	ユーザー インターフェイスでの表示に適したタスク エラーを説明するメッセージ。

TaskInformation

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

名前	型	説明
executionInfo	TaskExecutionInformation	タスクの実行に関する情報。
jobId	string	タスクが属するジョブの ID。
subtaskId	integer	タスクが複数インスタンスのタスクの場合のサブタスクの ID。
taskId	string	タスクの ID。
taskState	TaskState	タスクの現在の状態。
taskUrl	string	タスクの URL。

TaskState

タスクの状態。

名前	型	説明
active	string	タスクはキューに登録され、実行できますが、現在コンピューティング ノードには割り当てされていません。 タスクは、タスクが作成されたとき、無効になった後に有効になったとき、または失敗した実行後に再試行を待機しているときに、この状態になります。
completed	string	通常、タスクが正常に完了したか、タスクが正常に完了せず、再試行の制限を使い果たしたため、タスクは実行の対象ではなくなりました。 タスクの起動中にエラーが発生した場合、またはタスクが終了した場合も、タスクは完了としてマークされます。
preparing	string	タスクはコンピューティング ノードに割り当てられますが、コンピューティング ノードで必要なジョブ準備タスクが完了するのを待機しています。 ジョブ準備タスクが成功すると、タスクは実行中に移動します。 ジョブ準備タスクが失敗した場合、タスクはアクティブに戻り、別のコンピューティング ノードに割り当てられる資格があります。
running	string	タスクはコンピューティング ノードで実行されています。 これには、リソース ファイルのダウンロードやタスクで指定されたパッケージのデプロイなどのタスク レベルの準備が含まれます。これは、必ずしも Task コマンド ラインが実行を開始したことを意味するわけではありません。

UserIdentity

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

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

VirtualMachineInfo

仮想マシンの現在の状態に関する情報。

名前	型	説明
imageReference	ImageReference	Azure 仮想マシンの Marketplace イメージへの参照。
scaleSetVmResourceId	string	コンピューティング ノードの現在の仮想マシン スケール セット VM のリソース ID。 batch アカウントが poolAllocationMode プロパティを 'UserSubscription' に設定して作成された場合にのみ定義されます。