次の方法で共有


Nodes - Upload Node Logs

指定されたCompute NodeからAzure Blob StorageにAzure Batchサービスのログファイルをアップロードします。
これは、エラーが発生しAzureサポートにエスカレーションしたい場合は、Compute NodesからAzure Batchサービスのログファイルを自動化して収集するためのものです。 Batch サービスに関する問題のデバッグを支援するために、Azure Batch サービスのログ ファイルを Azure サポートと共有する必要があります。

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2025-06-01
POST {endpoint}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2025-06-01&timeOut={timeOut}

URI パラメーター

名前 / 必須 説明
endpoint
path True

string (uri)

Batch アカウント エンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。

nodeId
path True

string

リモートデスクトッププロトコルファイルを取得したいコンピュートノードのIDです。

poolId
path True

string

コンピューティング ノードを含むプールの ID。

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

timeOut
query

integer (int32)

サーバーが要求の処理に費やすことができる最大時間 (秒単位)。 既定値は 30 秒です。 値が30より大きい場合は、デフォルトが使われます。」

要求ヘッダー

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

名前 必須 説明
client-request-id

string

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

return-client-request-id

boolean

サーバーが応答で client-request-id を返す必要があるかどうか。

ocp-date

string (date-time-rfc7231)

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

要求本文

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

名前 必須 説明
containerUrl True

string (uri)

Batch ServiceログファイルをアップロードするためのAzure Blob Storage内のコンテナのURLです。 ユーザー割り当ての管理IDが使用されていない場合、URLにはコンテナに書き込み権限を与える共有アクセス署名(SAS)が含まれなければなりません。 SASの持続時間はアップロードが完了するのに十分な時間を確保しなければなりません。 SASの開始時間は任意であり、指定しないことが推奨されます。

startTime True

string (date-time)

バッチサービスのログファイルをアップロードする開始時間の範囲です。 時間範囲内のログメッセージを含むログファイルはアップロードされます。 つまり、操作はログファイル全体が常にアップロードされるため、要求されたより多くのログを取得する可能性がありますが、要求されたログ数より少ないログを取得するべきではありません。

endTime

string (date-time)

バッチサービスのログファイルをアップロードする期限の終了範囲。 時間範囲内のログメッセージを含むログファイルはアップロードされます。 つまり、操作はログファイル全体が常にアップロードされるため、要求されたより多くのログを取得する可能性がありますが、要求されたログ数より少ないログを取得するべきではありません。 省略する場合は、デフォルトではstartTime以降に利用可能なすべてのログをアップロードします。

identityReference

BatchNodeIdentityReference

containerUrlで指定されたAzure Blob Storageにアクセスするために使うユーザー割り当てのアイデンティティを参照します。 アイデンティティはAzure Blob Storageコンテナへの書き込みアクセス権を持っている必要があります。

応答

名前 説明
200 OK

UploadBatchServiceLogsResult

要求は成功しました。

ヘッダー

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

BatchError

予期しないエラー応答。

セキュリティ

OAuth2Auth

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

スコープ

名前 説明
https://batch.core.windows.net//.default

Upload BatchService Logs

要求のサンプル

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/uploadbatchservicelogs?api-version=2025-06-01



{
  "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2025-12-09T18%3A51%3A00Z&sp=w&sv=2025-05-31&sr=c&sig",
  "startTime": "2025-11-27T00:00:00Z"
}

応答のサンプル

{
  "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0",
  "numberOfFilesUploaded": 8
}

定義

名前 説明
BatchError

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

BatchErrorDetail

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

BatchErrorMessage

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

BatchNodeIdentityReference

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

UploadBatchServiceLogsOptions

Azure Batch サービス ログ ファイルは、コンピューティング ノードのパラメーターをアップロードします。

UploadBatchServiceLogsResult

特定のコンピューティング ノードから Batch サービス ログ ファイルをアップロードした結果。

BatchError

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

名前 説明
code

string

エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。

message

BatchErrorMessage

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

values

BatchErrorDetail[]

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

BatchErrorDetail

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

名前 説明
key

string

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

value

string

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

BatchErrorMessage

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

名前 説明
lang

string

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

value

string

メッセージのテキスト。

BatchNodeIdentityReference

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

名前 説明
resourceId

string (arm-id)

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

UploadBatchServiceLogsOptions

Azure Batch サービス ログ ファイルは、コンピューティング ノードのパラメーターをアップロードします。

名前 説明
containerUrl

string (uri)

Batch ServiceログファイルをアップロードするためのAzure Blob Storage内のコンテナのURLです。 ユーザー割り当ての管理IDが使用されていない場合、URLにはコンテナに書き込み権限を与える共有アクセス署名(SAS)が含まれなければなりません。 SASの持続時間はアップロードが完了するのに十分な時間を確保しなければなりません。 SASの開始時間は任意であり、指定しないことが推奨されます。

endTime

string (date-time)

バッチサービスのログファイルをアップロードする期限の終了範囲。 時間範囲内のログメッセージを含むログファイルはアップロードされます。 つまり、操作はログファイル全体が常にアップロードされるため、要求されたより多くのログを取得する可能性がありますが、要求されたログ数より少ないログを取得するべきではありません。 省略する場合は、デフォルトではstartTime以降に利用可能なすべてのログをアップロードします。

identityReference

BatchNodeIdentityReference

containerUrlで指定されたAzure Blob Storageにアクセスするために使うユーザー割り当てのアイデンティティを参照します。 アイデンティティはAzure Blob Storageコンテナへの書き込みアクセス権を持っている必要があります。

startTime

string (date-time)

バッチサービスのログファイルをアップロードする開始時間の範囲です。 時間範囲内のログメッセージを含むログファイルはアップロードされます。 つまり、操作はログファイル全体が常にアップロードされるため、要求されたより多くのログを取得する可能性がありますが、要求されたログ数より少ないログを取得するべきではありません。

UploadBatchServiceLogsResult

特定のコンピューティング ノードから Batch サービス ログ ファイルをアップロードした結果。

名前 説明
numberOfFilesUploaded

integer (int32)

アップロードされるログファイルの数。

virtualDirectoryName

string

Batch ServiceのログファイルがアップロードされるAzure Blob Storage Container内の仮想ディレクトリです。 仮想ディレクトリ名はアップロードされる各ログファイルのブロブ名の一部であり、poolId、nodeId、そして一意の識別子に基づいて構築されています。