Own Workload? Customize your docs with AI search, analytics, and more.

GET

Lists all of the Tasks that are associated with the specified Job.

https://azure.com/jobs/{jobId}/tasks

For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Access Token Required: API Key

Path Parameters

jobIdstringrequired

The ID of the Job.

Query Params

$filterstring

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.

$selectstring

An OData $select clause.

$expandstring

An OData $expand clause.

maxresultsstring

The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.

timeoutstring

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://azure.com/jobs/{jobId}/tasks' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Lists all of the Tasks that are associated with the specified Job.

https://azure.com/jobs/{jobId}/tasks

For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Access Token Required: API Key

Path Parameters

jobIdstringrequired

The ID of the Job.

Query Params

$filterstring

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.

$selectstring

An OData $select clause.

$expandstring

An OData $expand clause.

maxresultsstring

The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.

timeoutstring

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://azure.com/jobs/{jobId}/tasks' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Lists all of the Tasks that are associated with the specified Job.

https://azure.com/jobs/{jobId}/tasks

For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Access Token Required: API Key

Path Parameters

jobIdstringrequired

The ID of the Job.

Query Params

$filterstring

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.

$selectstring

An OData $select clause.

$expandstring

An OData $expand clause.

maxresultsstring

The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.

timeoutstring

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://azure.com/jobs/{jobId}/tasks' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Lists all of the Tasks that are associated with the specified Job.

https://azure.com/jobs/{jobId}/tasks

For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.

Access Token Required: API Key

Path Parameters

jobIdstringrequired

The ID of the Job.

Query Params

$filterstring

An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.

$selectstring

An OData $select clause.

$expandstring

An OData $expand clause.

maxresultsstring

The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.

timeoutstring

The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://azure.com/jobs/{jobId}/tasks' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}