Compute Node - Reimage
Reinstalls the operating system on the specified Compute Node.
You can reinstall the operating system on a Compute Node only if it is in an idle or running state.
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/reimage?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/reimage?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 that you want to restart. |
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 | Type | Description |
---|---|---|
nodeReimageOption |
When to reimage the Compute Node and what to do with currently running Tasks. |
Name | Type | Description |
---|---|---|
202 Accepted |
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-20161122t193202z/reimage?api-version=2024-07-01.20.0
{
"nodeReimageOption": "terminate"
}
Sample response
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 |
When to reimage the Compute Node and what to do with currently running Tasks. |
Error |
An error message received in an Azure Batch error response. |
Node |
Options for reimaging a 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. |
When to reimage the Compute Node and what to do with currently running Tasks.
Name | Type | Description |
---|---|---|
requeue |
string |
Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Reimage the Compute Node as soon as Tasks have been terminated. |
retaineddata |
string |
Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Reimage the Compute Node when all Task retention periods have expired. |
taskcompletion |
string |
Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Reimage the Compute Node when all Tasks have completed. |
terminate |
string |
Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Reimage the Compute Node as soon as Tasks have been terminated. |
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. |
Options for reimaging a Compute Node.
Name | Type | Description |
---|---|---|
nodeReimageOption |
When to reimage the Compute Node and what to do with currently running Tasks. |