{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Tasks API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Retrieve A List Of Tasks For The Provided Search Parameters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/workspaces/:workspaceName/tasks", "params": [ { "name": "filter", "value": "", "type": "query", "description": "An expression on the resource type that selects the resources to be returned." }, { "name": "skip", "value": "", "type": "query", "description": "An offset into the collection of the first resource to be returned." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "An offset into the collection of the first resource to be returned." }, { "name": "workspaceName", "value": "", "type": "path", "description": "The name of the Workspace." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Retrieve A Task By Taskid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/workspaces/:workspaceName/tasks/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path" }, { "name": "workspaceName", "value": "", "type": "path", "description": "The name of the Workspace." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Cancel A Task By Taskid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/workspaces/:workspaceName/tasks/:taskId:cancel", "params": [ { "name": "taskId", "value": "", "type": "path" }, { "name": "workspaceName", "value": "", "type": "path", "description": "The name of the Workspace." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Download Task Data For The Provided Taskid", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/workspaces/:workspaceName/tasks/:taskId:download", "params": [ { "name": "taskId", "value": "", "type": "path" }, { "name": "workspaceName", "value": "", "type": "path", "description": "The name of the Workspace." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Lists All Of The Tasks That Are Associated With The Specified Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/tasks", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job." }, { "name": "$filter", "value": "", "type": "query", "description": "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." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Adds A Task To The Specified Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/tasks", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job to which the Task is to be added." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time." }, { "info": { "name": "Microsoft Azure Adds A Collection Of Tasks To The Specified Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/addtaskcollection", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job to which the Task collection is to be added." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a " }, { "info": { "name": "Microsoft Azure Gets Information About The Specified Task", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job that contains the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task to get information about." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Put Jobs Jobid Tasks Taskid", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job containing the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task to update." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Updates the properties of the specified Task." }, { "info": { "name": "Microsoft Azure Deletes A Task From The Specified Job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job from which to delete the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task to delete." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background." }, { "info": { "name": "Microsoft Azure Lists All Of The Subtasks That Are Associated With The Specified Multi Instance Task", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/subtasksinfo", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "If the Task is not a multi-instance Task then this returns an empty collection." }, { "info": { "name": "Microsoft Azure Terminates The Specified Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/terminate", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job containing the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task to terminate." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background." }, { "info": { "name": "Microsoft Azure Reactivates A Task, Allowing It To Run Again Even If Its Retry Count Has Been Exhausted", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/reactivate", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job containing the Task." }, { "name": "taskId", "value": "", "type": "path", "description": "The ID of the Task to reactivate." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has complet" }, { "info": { "name": "Microsoft Azure Get Tasks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tasks", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "filter", "value": "", "type": "query", "description": "Filter the result list using the given expression." }, { "name": "orderby", "value": "", "type": "query", "description": "A list of expressions that specify the order of the returned resources." }, { "name": "skip", "value": "", "type": "query", "description": "The number of result items to skip." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "The maximum number of result items per page." } ] }, "docs": "Retrieve a list of tasks for the provided search parameters." }, { "info": { "name": "Microsoft Azure Get Tasks Taskid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tasks/:taskId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "taskId", "value": "", "type": "path", "description": "The unique identifier of the task." } ] }, "docs": "Retrieve a task by taskId." }, { "info": { "name": "Microsoft Azure Post Tasks Taskid:cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/tasks/:taskId:cancel", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "taskId", "value": "", "type": "path", "description": "The unique identifier of the task." } ] }, "docs": "Cancel a task by taskId." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename Tasks Taskid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Easm/workspaces/:workspaceName/tasks/:taskId", "params": [ { "name": "workspaceName", "value": "", "type": "path", "description": "The name of the Workspace." }, { "name": "taskId", "value": "", "type": "path", "description": "The id of the Task." } ] }, "docs": "Returns a task in the given workspace." } ] } ], "bundled": true }