How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Tasks API

Provides access to task resources.

Microsoft Azure Tasks API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Task. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 17 operations across 14 paths, and defines 61 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

17 operations 14 paths 61 schemas 1 DELETE8 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 17

Across 14 paths, the API surfaces 17 operations — 1 DELETE, 8 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Tasks 17

Provides access to task resources.

GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks
Microsoft Azure Retrieve A List Of Tasks For The Provided Search Parameters
microsoftAzureTasksList 7 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}
Microsoft Azure Retrieve A Task By Taskid
microsoftAzureTasksGet 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}:cancel
Microsoft Azure Cancel A Task By Taskid
microsoftAzureTasksCancel 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks/{taskId}:download
Microsoft Azure Download Task Data For The Provided Taskid
microsoftAzureTasksDownload 5 params → 200default
POST
/jobs/{jobId}/tasks
Microsoft Azure Adds A Task To The Specified Job
microsoftAzureTaskAdd 6 params body → 201default
GET
/jobs/{jobId}/tasks
Microsoft Azure Lists All Of The Tasks That Are Associated With The Specified Job
microsoftAzureTaskList 10 params → 200default
POST
/jobs/{jobId}/addtaskcollection
Microsoft Azure Adds A Collection Of Tasks To The Specified Job
microsoftAzureTaskAddcollection 6 params body → 200default
DELETE
/jobs/{jobId}/tasks/{taskId}
Microsoft Azure Deletes A Task From The Specified Job
microsoftAzureTaskDelete 11 params → 200default
GET
/jobs/{jobId}/tasks/{taskId}
Microsoft Azure Gets Information About The Specified Task
microsoftAzureTaskGet 13 params → 200default
PUT
/jobs/{jobId}/tasks/{taskId}
Microsoft Azure Put Jobs Jobid Tasks Taskid
microsoftAzureTaskUpdate 11 params body → 200default
GET
/jobs/{jobId}/tasks/{taskId}/subtasksinfo
Microsoft Azure Lists All Of The Subtasks That Are Associated With The Specified Multi Instance Task
microsoftAzureTaskListsubtasks 8 params → 200default
POST
/jobs/{jobId}/tasks/{taskId}/terminate
Microsoft Azure Terminates The Specified Task
microsoftAzureTaskTerminate 11 params → 204default
POST
/jobs/{jobId}/tasks/{taskId}/reactivate
Microsoft Azure Reactivates A Task, Allowing It To Run Again Even If Its Retry Count Has Been Exhausted
microsoftAzureTaskReactivate 11 params → 204default
GET
/tasks
Microsoft Azure Get Tasks
microsoftAzureTasksListtask 5 params → 200default
GET
/tasks/{taskId}
Microsoft Azure Get Tasks Taskid
microsoftAzureTasksGettask 2 params → 200default
POST
/tasks/{taskId}:cancel
Microsoft Azure Post Tasks Taskid:cancel
microsoftAzureTasksCanceltask 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}/tasks/{taskId}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename Tasks Taskid
microsoftAzureTasksGetbyworkspace 5 params → 200default

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are CloudTask (27 properties), TaskAddParameter (16 properties), SubtaskInformation (12 properties), TaskStatistics (11 properties). Each schema is shown below with its type and property counts.

TaskExecutionInformation
object
10 properties 2 required
TaskStatistics
object
11 properties 11 required
TaskAddCollectionResult
object
1 property
OutputFile
object
On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn m…
3 properties 3 required
ErrorMessage
object
2 properties
Azure.Core.Foundations.Error
object
The error object.
5 properties 2 required
CloudTaskListSubtasksResult
object
1 property
ExitOptions
object
2 properties
TaskFailureInformation
object
4 properties 1 required
TaskUpdateParameter
object
1 property
ComputeNodeInformation
object
6 properties
AutoUserSpecification
object
2 properties
InnerError
object
This is an object containing more specific information than the current object about the error.
1 property
TaskAddParameter
object
Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Nod…
16 properties 2 required
ContainerRegistry
object
3 properties 2 required
SubtaskState
string
PagedTask
object
Paged collection of Task items
3 properties 1 required
AuthenticationTokenSettings
object
1 property
OutputFileBlobContainerDestination
object
2 properties 1 required
OutputFileUploadCondition
string
Azure.Core.Foundations.InnerError
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
TaskResource
object
Task details
1 property
CloudTask
object
Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Nod…
27 properties
OutputFileUploadOptions
object
1 property 1 required
TaskPageResponse
object
9 properties
EnvironmentSetting
object
2 properties 1 required
TaskResourceProperties
object
Task properties.
7 properties
ExitCodeRangeMapping
object
3 properties 3 required
TaskContainerSettings
object
4 properties 1 required
BatchError
object
3 properties
Task
object
8 properties 1 required
AffinityInformation
object
1 property 1 required
ResourceState
string
Resources provisioning states.
OutputFileDestination
object
1 property
TaskDependencies
object
2 properties
MultiInstanceSettings
object
Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code…
3 properties 1 required
ExitCodeMapping
object
2 properties 2 required
ResourceFile
object
6 properties
UserIdentity
object
Specify either the userName or autoUser property, but not both.
2 properties
ResourceBaseProperties
object
Resource base properties.
1 property
TaskAddResult
object
6 properties 2 required
TaskAddCollectionParameter
object
1 property 1 required
TaskState
string
TaskConstraints
object
3 properties
ApplicationPackageReference
object
2 properties 1 required
Azure.Core.Foundations.ErrorResponse
object
A response containing error details.
1 property 1 required
ErrorCategory
string
TaskExecutionResult
string
ErrorResponse
object
1 property 1 required
NameValuePair
object
2 properties
TaskContainerExecutionInformation
object
3 properties
TaskState_2
string
The state the task is in.
TaskPhase
string
The phase the task is in.
SubtaskInformation
object
12 properties
BatchErrorDetail
object
2 properties
ExitConditions
object
5 properties
ElevationLevel
string
TaskResponse
object
7 properties
ErrorDetail
object
This is the top-level error object whose code matches the x-ms-error-code response header
5 properties 2 required
TaskIdRange
object
The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'.
2 properties 2 required
CloudTaskListResult
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-tasks-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Tasks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.