Task - Update
Updates the properties of the specified Task.
PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0
PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?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. |
job
|
path | True |
string |
The ID of the Job containing the Task. |
task
|
path | True |
string |
The ID of the Task to update. |
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. |
|
If-Match |
string |
An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client. |
|
If-None-Match |
string |
An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client. |
|
If-Modified-Since |
string date-time-rfc1123 |
A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time. |
Media Types: "application/json; odata=minimalmetadata"
Name | Type | Description |
---|---|---|
constraints |
Constraints that apply to this Task. |
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
PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0
{
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": 3,
"retentionTime": "PT1H"
}
}
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. |
Error |
An error message received in an Azure Batch error response. |
Task |
Execution constraints to apply to a Task. |
Task |
The set of changes to be made to a Task. |
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. |
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. |
Execution constraints to apply to a Task.
Name | Type | Description |
---|---|---|
maxTaskRetryCount |
integer |
The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. |
maxWallClockTime |
string |
The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. |
retentionTime |
string |
The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents. |
The set of changes to be made to a Task.
Name | Type | Description |
---|---|---|
constraints |
Constraints that apply to this Task. |