{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Jobs API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Jobs", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Lists All Of The Jobs In The Specified Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." } ] }, "docs": "Lists all of the Jobs in the specified Account." }, { "info": { "name": "Microsoft Azure Creates A Job To The Specified Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." } ] }, "docs": "The Batch service supports two ways to control the work done as part of a Job.
In the first approach, the user specifies a Job Manager Task. The Batch service
launches this Task when it is ready to start the Job. The Job Manager Task
controls all other Tasks that run under this Job, by using the Task APIs. In
the second approach, the user directly controls the execution of Tasks under an
active Job, by using the Task APIs. Also note: when naming Jobs, avoid
including sensitive " }, { "info": { "name": "Microsoft Azure Gets Information About The Specified Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "$expand", "value": "", "type": "query", "description": "An OData $expand clause." } ] }, "docs": "Gets information about the specified Job." }, { "info": { "name": "Microsoft Azure Updates The Properties Of The Specified Job", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/jobs/:jobId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job whose properties you want to update." } ] }, "docs": "This fully replaces all the updatable properties of the Job. For example, if
the Job has constraints associated with it and if constraints is not specified
with this request, then the Batch service will remove the existing constraints." }, { "info": { "name": "Microsoft Azure Updates The Properties Of The Specified Job", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/jobs/:jobId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job whose properties you want to update." } ] }, "docs": "This replaces only the Job properties specified in the request. For example, if
the Job has constraints, and a request does not specify the constraints
element, then the Job keeps the existing constraints." }, { "info": { "name": "Microsoft Azure Deletes A Job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/jobs/:jobId", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job to delete." } ] }, "docs": "Deleting a Job also deletes all Tasks that are part of that Job, and all Job
statistics. This also overrides the retention period for Task data; that is, if
the Job contains Tasks which are still retained on Compute Nodes, the Batch
services deletes those Tasks' working directories and all their contents. When
a Delete Job request is received, the Batch service sets the Job to the
deleting state. All update operations on a Job that is in deleting state will
fail with status co" }, { "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": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job to which the Task collection is to be added." } ] }, "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 " }, { "info": { "name": "Microsoft Azure Disables The Specified Job, Preventing New Tasks From Running", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/disable", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job to disable." } ] }, "docs": "The Batch Service immediately moves the Job to the disabling state. Batch then
uses the disableTasks parameter to determine what to do with the currently
running Tasks of the Job. The Job remains in the disabling state until the
disable operation is completed and all Tasks have been dealt with according to
the disableTasks option; the Job then moves to the disabled state. No new Tasks
are started under the Job until it moves back to active state. If you try to
disable a Job tha" }, { "info": { "name": "Microsoft Azure Enables The Specified Job, Allowing New Tasks To Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/enable", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job to enable." } ] }, "docs": "When you call this API, the Batch service sets a disabled Job to the enabling
state. After the this operation is completed, the Job moves to the active
state, and scheduling of new Tasks under the Job resumes. The Batch service
does not allow a Task to remain in the active state for more than 180 days.
Therefore, if you enable a Job containing active Tasks which were added more
than 180 days ago, those Tasks will not run." }, { "info": { "name": "Microsoft Azure Lists The Execution Status Of The Job Preparation And Job Release Task For The\nspecified Job Across The Compute Nodes Where The Job Has Run", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/jobpreparationandreleasetaskstatus", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "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\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." } ] }, "docs": "This API returns the Job Preparation and Job Release Task status on all Compute
Nodes that have run the Job Preparation or Job Release Task. This includes
Compute Nodes which have since been removed from the Pool. If this API is
invoked on a Job which has no Job Preparation or Job Release Task, the Batch
service returns HTTP status code 409 (Conflict) with an error code of
JobPreparationTaskNotSpecified." }, { "info": { "name": "Microsoft Azure Gets The Task Counts For The Specified Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/taskcounts", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job." } ] }, "docs": "Task counts provide a count of the Tasks by active, running or completed Task
state, and a count of Tasks which succeeded or failed. Tasks in the preparing
state are counted as running. Note that the numbers returned may not always be
up to date. If you need exact task counts, use a list query." }, { "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": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "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\nhttps://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." } ] }, "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 Creates 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": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job to which the Task is to be created." } ] }, "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 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-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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." } ] }, "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-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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." } ] }, "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-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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." } ] }, "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 The Files In A Task S Directory On Its Compute Node", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/files", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "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 whose files you want to list." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files." }, { "name": "recursive", "value": "", "type": "query", "description": "Whether to list children of the Task directory. This parameter can be used in\ncombination with the filter parameter to list specific type of files." } ] }, "docs": "Lists the files in a Task's directory on its Compute Node." }, { "info": { "name": "Microsoft Azure Get Jobs Jobid Tasks Taskid Files Filepath", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "ocp-range", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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 whose file you want to retrieve." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the Task file that you want to get the content of." } ] }, "docs": "Returns the content of the specified Task file." }, { "info": { "name": "Microsoft Azure Deletes The Specified Task File From The Compute Node Where The Task Ran", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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 whose file you want to retrieve." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the Task file that you want to get the content of." }, { "name": "recursive", "value": "", "type": "query", "description": "Whether to delete children of a directory. If the filePath parameter represents\na directory instead of a file, you can set recursive to true to delete the\ndirectory and all of the files and subdirectories in it. If recursive is false\nthen the directory must be empty or deletion will fail." } ] }, "docs": "Deletes the specified Task file from the Compute Node where the Task ran." }, { "info": { "name": "Microsoft Azure Head Jobs Jobid Tasks Taskid Files Filepath", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/jobs/:jobId/tasks/:taskId/files/:filePath", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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 whose file you want to retrieve." }, { "name": "filePath", "value": "", "type": "path", "description": "The path to the Task file that you want to get the content of." } ] }, "docs": "Gets the properties of the specified Task file." }, { "info": { "name": "Microsoft Azure Reactivates A Task, Allowing It To Run Again Even If Its Retry Count Has Been\nexhausted", "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-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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." } ] }, "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 t" }, { "info": { "name": "Microsoft Azure Lists All Of The Subtasks That Are Associated With The Specified Multi Instance\ntask", "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": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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." } ] }, "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-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "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." } ] }, "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 Terminates The Specified Job, Marking It As Completed", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/terminate", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" }, { "name": "If-Modified-Since", "value": "" }, { "name": "If-Unmodified-Since", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "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.\"." }, { "name": "jobId", "value": "", "type": "path", "description": "The ID of the Job to terminate." } ] }, "docs": "When a Terminate Job request is received, the Batch service sets the Job to the
terminating state. The Batch service then terminates any running Tasks
associated with the Job and runs any required Job release Tasks. Then the Job
moves into the completed state. If there are any Tasks in the Job in the active
state, they will remain in the active state. Once a Job is terminated, new
Tasks cannot be added and any remaining active Tasks will not be scheduled." }, { "info": { "name": "Microsoft Azure Get Device Statuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobs/:jobId/devices", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "jobId", "value": "", "type": "path", "description": "Unique ID of the job." } ] }, "docs": "Get the list of individual device statuses by job ID." }, { "info": { "name": "Microsoft Azure Rerun A Job On Failed Devices", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/jobs/:jobId/rerun/:rerunId", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "jobId", "value": "", "type": "path", "description": "Unique ID of the job." }, { "name": "rerunId", "value": "", "type": "path", "description": "Unique ID of the job rerun." } ] }, "docs": "Execute a rerun of an existing job on all failed devices." }, { "info": { "name": "Microsoft Azure Resume A Stopped Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/resume", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "jobId", "value": "", "type": "path", "description": "Unique ID of the job." } ] }, "docs": "Resume execution of an existing stopped job." }, { "info": { "name": "Microsoft Azure Stop A Running Job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/jobs/:jobId/stop", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API being called." }, { "name": "jobId", "value": "", "type": "path", "description": "Unique ID of the job." } ] }, "docs": "Stop execution of a job that is currently running." }, { "info": { "name": "Microsoft Azure Gets Lifetime Summary Statistics For All Of The Jobs In The Specified Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lifetimejobstats", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "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": "Statistics are aggregated across all Jobs that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." }, { "info": { "name": "Microsoft Azure Lists The Jobs That Have Been Created Under The Specified Job Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/jobschedules/:jobScheduleId/jobs", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "jobScheduleId", "value": "", "type": "path", "description": "The ID of the Job Schedule from which you want to get a list of Jobs." }, { "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-jobs-in-a-job-schedule." }, { "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 Jobs 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": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Details Of A Specified Job On A Data Box Edge Data Box Gateway Device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/:deviceName/jobs/:name", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name." }, { "name": "name", "value": "", "type": "path", "description": "The job name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databox Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.DataBox/jobs", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" }, { "name": "$skipToken", "value": "", "type": "query", "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs." } ] }, "docs": "Lists all the jobs available under the subscription." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Mitigate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName/mitigate", "params": [ { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "Request to mitigate for a given job" }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Markdevicesshipped", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName/markDevicesShipped", "params": [ { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "Request to mark devices for a given job as shipped" }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" }, { "name": "$skipToken", "value": "", "type": "query", "description": "$skipToken is supported on Get list of jobs, which provides the next page in the list of jobs." } ] }, "docs": "Lists all the jobs available under the given resource group." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" }, { "name": "$expand", "value": "", "type": "query", "description": "$expand is supported on details parameter for job, which provides details on the job stages." } ] }, "docs": "Gets information about the specified job." }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API." }, { "info": { "name": "Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "Updates the properties of an existing job." }, { "info": { "name": "Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "Deletes a job." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Bookshipmentpickup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName/bookShipmentPickUp", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "Book shipment pick up." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName/cancel", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "CancelJob." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Listcredentials", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.DataBox/jobs/:jobName/listCredentials", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "jobName", "value": "", "type": "path", "description": "The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "This method gets the unencrypted secrets related to the job." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitionname Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HybridData/dataManagers/:dataManagerName/dataServices/:dataServiceName/jobDefinitions/:jobDefinitionName/jobs", "params": [ { "name": "dataServiceName", "value": "", "type": "path", "description": "The name of the data service of the job definition." }, { "name": "jobDefinitionName", "value": "", "type": "path", "description": "The name of the job definition for which jobs are needed." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "dataManagerName", "value": "", "type": "path", "description": "The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" }, { "name": "$filter", "value": "", "type": "query", "description": "OData Filter options" } ] }, "docs": "This method gets all the jobs of a given job definition." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitionname Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HybridData/dataManagers/:dataManagerName/dataServices/:dataServiceName/jobDefinitions/:jobDefinitionName/jobs/:jobId", "params": [ { "name": "dataServiceName", "value": "", "type": "path", "description": "The name of the data service of the job definition." }, { "name": "jobDefinitionName", "value": "", "type": "path", "description": "The name of the job definition of the job." }, { "name": "jobId", "value": "", "type": "path", "description": "The job id of the job queried." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "dataManagerName", "value": "", "type": "path", "description": "The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" }, { "name": "$expand", "value": "", "type": "query", "description": "$expand is supported on details parameter for job, which provides details on the job stages." } ] }, "docs": "This method gets a data manager job given the jobId." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitionname Jobs Jobid Cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HybridData/dataManagers/:dataManagerName/dataServices/:dataServiceName/jobDefinitions/:jobDefinitionName/jobs/:jobId/cancel", "params": [ { "name": "dataServiceName", "value": "", "type": "path", "description": "The name of the data service of the job definition." }, { "name": "jobDefinitionName", "value": "", "type": "path", "description": "The name of the job definition of the job." }, { "name": "jobId", "value": "", "type": "path", "description": "The job id of the job queried." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "dataManagerName", "value": "", "type": "path", "description": "The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "Cancels the given job." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitionname Jobs Jobid Resume", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HybridData/dataManagers/:dataManagerName/dataServices/:dataServiceName/jobDefinitions/:jobDefinitionName/jobs/:jobId/resume", "params": [ { "name": "dataServiceName", "value": "", "type": "path", "description": "The name of the data service of the job definition." }, { "name": "jobDefinitionName", "value": "", "type": "path", "description": "The name of the job definition of the job." }, { "name": "jobId", "value": "", "type": "path", "description": "The job id of the job queried." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "dataManagerName", "value": "", "type": "path", "description": "The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" } ] }, "docs": "Resumes the given job." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HybridData/dataManagers/:dataManagerName/dataServices/:dataServiceName/jobs", "params": [ { "name": "dataServiceName", "value": "", "type": "path", "description": "The name of the data service of interest." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "dataManagerName", "value": "", "type": "path", "description": "The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" }, { "name": "$filter", "value": "", "type": "query", "description": "OData Filter options" } ] }, "docs": "This method gets all the jobs of a data service type in a given resource." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.HybridData/dataManagers/:dataManagerName/jobs", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The Subscription Id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The Resource Group Name" }, { "name": "dataManagerName", "value": "", "type": "path", "description": "The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only" }, { "name": "api-version", "value": "", "type": "query", "description": "The API Version" }, { "name": "$filter", "value": "", "type": "query", "description": "OData Filter options" } ] }, "docs": "This method gets all the jobs at the data manager resource level." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobsexport", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.RecoveryServices/vaults/:vaultName/backupJobsExport", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "Client Api Version." }, { "name": "vaultName", "value": "", "type": "path", "description": "The name of the recovery services vault." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group where the recovery services vault is present." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription Id." }, { "name": "$filter", "value": "", "type": "query", "description": "OData filter options." } ] }, "docs": "Triggers export of jobs specified by filters and returns an OperationID to track." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Scheduler/jobCollections/:jobCollectionName/jobs/:jobName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "jobCollectionName", "value": "", "type": "path", "description": "The job collection name." }, { "name": "jobName", "value": "", "type": "path", "description": "The job name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Gets a job." }, { "info": { "name": "Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Scheduler/jobCollections/:jobCollectionName/jobs/:jobName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "jobCollectionName", "value": "", "type": "path", "description": "The job collection name." }, { "name": "jobName", "value": "", "type": "path", "description": "The job name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Provisions a new job or updates an existing job." }, { "info": { "name": "Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Scheduler/jobCollections/:jobCollectionName/jobs/:jobName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "jobCollectionName", "value": "", "type": "path", "description": "The job collection name." }, { "name": "jobName", "value": "", "type": "path", "description": "The job name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Patches an existing job." }, { "info": { "name": "Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Scheduler/jobCollections/:jobCollectionName/jobs/:jobName", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "jobCollectionName", "value": "", "type": "path", "description": "The job collection name." }, { "name": "jobName", "value": "", "type": "path", "description": "The job name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Deletes a job." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname Run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Scheduler/jobCollections/:jobCollectionName/jobs/:jobName/run", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "jobCollectionName", "value": "", "type": "path", "description": "The job collection name." }, { "name": "jobName", "value": "", "type": "path", "description": "The job name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." } ] }, "docs": "Runs a job." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Scheduler/jobCollections/:jobCollectionName/jobs", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "jobCollectionName", "value": "", "type": "path", "description": "The job collection name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." }, { "name": "$top", "value": "", "type": "query", "description": "The number of jobs to request, in the of range of [1..100]." }, { "name": "$skip", "value": "", "type": "query", "description": "The (0-based) index of the job history list from which to begin requesting entries." }, { "name": "$filter", "value": "", "type": "query", "description": "The filter to apply on the job state." } ] }, "docs": "Lists all jobs under the specified job collection." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Scheduler/jobCollections/:jobCollectionName/jobs/:jobName/history", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name." }, { "name": "jobCollectionName", "value": "", "type": "path", "description": "The job collection name." }, { "name": "jobName", "value": "", "type": "path", "description": "The job name." }, { "name": "api-version", "value": "", "type": "query", "description": "The API version." }, { "name": "$top", "value": "", "type": "query", "description": "the number of job history to request, in the of range of [1..100]." }, { "name": "$skip", "value": "", "type": "query", "description": "The (0-based) index of the job history list from which to begin requesting entries." }, { "name": "$filter", "value": "", "type": "query", "description": "The filter to apply on the job state." } ] }, "docs": "Lists job history." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/jobs", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" }, { "name": "$filter", "value": "", "type": "query", "description": "OData Filter options" } ] }, "docs": "Gets all the jobs for specified device. With optional OData query parameters, a filtered set of jobs is returned." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs Jobname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/jobs/:jobName", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "jobName", "value": "", "type": "path", "description": "The job Name." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Gets the details of the specified job name." }, { "info": { "name": "Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs Jobname Cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/devices/:deviceName/jobs/:jobName/cancel", "params": [ { "name": "deviceName", "value": "", "type": "path", "description": "The device name" }, { "name": "jobName", "value": "", "type": "path", "description": "The jobName." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" } ] }, "docs": "Cancels a job on the device." }, { "info": { "name": "Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.StorSimple/managers/:managerName/jobs", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription id" }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The resource group name" }, { "name": "managerName", "value": "", "type": "path", "description": "The manager name" }, { "name": "api-version", "value": "", "type": "query", "description": "The api version" }, { "name": "$filter", "value": "", "type": "query", "description": "OData Filter options" } ] }, "docs": "Gets all the jobs for the specified manager. With optional OData query parameters, a filtered set of jobs is returned." } ] } ], "bundled": true }