Compute Node - Upload Batch Service Logs
Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage.
This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2024-07-01.20.0POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?timeout={timeout}&api-version=2024-07-01.20.0| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
batch
|
path | True |
string |
The base URL for all Azure Batch service requests. |
|
node
|
path | True |
string |
The ID of the Compute Node from which you want to upload the Azure Batch service log files. |
|
pool
|
path | True |
string |
The ID of the Pool that contains the Compute Node. |
|
api-version
|
query | True |
string |
Client API Version. |
|
timeout
|
query |
integer (int32) |
The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead. |
Media Types: "application/json; odata=minimalmetadata"
| Name | Required | Type | Description |
|---|---|---|---|
| client-request-id |
string (uuid) |
The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
| return-client-request-id |
boolean |
Whether the server should return the client-request-id in the response. |
|
| ocp-date |
string (date-time-rfc1123) |
The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly. |
Media Types: "application/json; odata=minimalmetadata"
| Name | Required | Type | Description |
|---|---|---|---|
| containerUrl | True |
string |
The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). |
| startTime | True |
string (date-time) |
The start of the time range from which to upload Batch Service log file(s). |
| endTime |
string (date-time) |
The end of the time range from which to upload Batch Service log file(s). |
|
| identityReference |
The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. |
| Name | Type | Description |
|---|---|---|
| 200 OK |
The request to the Batch service was successful. Headers
|
|
| Other Status Codes |
The error from the Batch service. |
Microsoft Entra OAuth 2.0 auth code flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
| Name | Description |
|---|---|
| user_impersonation | Impersonate your user account |
Type:
apiKey
In:
header
Sample request
POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/uploadbatchservicelogs?api-version=2024-07-01.20.0
{
"containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig",
"startTime": "2017-11-27T00:00:00Z"
}
Sample response
{
"virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0",
"numberOfFilesUploaded": 8
}| Name | Description |
|---|---|
|
Batch |
An error response received from the Azure Batch service. |
|
Batch |
An item of additional information included in an Azure Batch error response. |
|
Compute |
The reference to a user assigned identity associated with the Batch pool which a compute node will use. |
|
Error |
An error message received in an Azure Batch error response. |
|
Upload |
The Azure Batch service log files upload configuration for a Compute Node. |
|
Upload |
The result of uploading Batch service log files from a specific Compute Node. |
An error response received from the Azure Batch service.
| Name | Type | Description |
|---|---|---|
| code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
| message |
A message describing the error, intended to be suitable for display in a user interface. |
|
| values |
A collection of key-value pairs containing additional details about the error. |
An item of additional information included in an Azure Batch error response.
| Name | Type | Description |
|---|---|---|
| key |
string |
An identifier specifying the meaning of the Value property. |
| value |
string |
The additional information included with the error response. |
The reference to a user assigned identity associated with the Batch pool which a compute node will use.
| Name | Type | Description |
|---|---|---|
| resourceId |
string |
The ARM resource id of the user assigned identity. |
An error message received in an Azure Batch error response.
| Name | Type | Description |
|---|---|---|
| lang |
string |
The language code of the error message |
| value |
string |
The text of the message. |
The Azure Batch service log files upload configuration for a Compute Node.
| Name | Type | Description |
|---|---|---|
| containerUrl |
string |
The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). |
| endTime |
string (date-time) |
The end of the time range from which to upload Batch Service log file(s). |
| identityReference |
The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. |
|
| startTime |
string (date-time) |
The start of the time range from which to upload Batch Service log file(s). |
The result of uploading Batch service log files from a specific Compute Node.
| Name | Type | Description |
|---|---|---|
| numberOfFilesUploaded |
integer (int32) |
The number of log files which will be uploaded. |
| virtualDirectoryName |
string |
The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded. |