Delete Job
The Delete Job request deletes the specified job. To delete a Scheduler job, send a DELETE request to a job’s address. The full list of a user’s jobs can be deleted by excluding a job ID from the DELETE call (i.e. /jobs). Deleted jobs will have their history purged, and they will never be returned from a subsequent GET call. If you try to DELETE a job that has already been DELETE’d, the Scheduler service will return a response with status code 404.
Request
The Delete Job request is specified as follows. Replace <subscription-id> with your subscription ID, <cloud-service-id> with your cloud service ID, <job-collection-id> with the ID of the job collection, and <job-id> with the ID of the new job itself.
Method |
Request URI |
|---|---|
DELETE |
To delete one job:https://management.core.windows.net/<subscription-id>/cloudServices/<cloud-service-id>/resources/scheduler/~/jobCollections/<job-collection-id>/jobs/<job-id>?api-version=2014-04-01 |
DELETE |
To delete all jobs in the collection:https://management.core.windows.net/<subscription-id>/cloudServices/<cloud-service-id>/resources/scheduler/~/jobCollections/<job-collection-id>/jobs?api-version=2014-04-01 |
URI Parameters
None.
Request Headers
The following table describes required and optional request headers.
Request Header |
Description |
|---|---|
x-ms-version |
Required. Specifies the version of the operation to use for this request. This header should be set to 2013-06-01 or a later version. |
Request Body
None.
Response
The response includes an HTTP status code, a set of response headers, and a response body.
Status Code
A successful operation returns status code 200 (OK.)
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
Response Header |
Description |
|---|---|
x-ms-request-id |
A value that uniquely identifies a request made against the Management service. For an asynchronous operation, you can call get operation status with the value of the header to determine whether the operation is complete, has failed, or is still in progress. See Tracking Asynchronous Service Management Requests for more information. |
Response Body
None.
Authorization
Any management certificate associated with the subscription specified by <Subscription-Id> can be used to authenticate this operation. For additional details, see Authenticating Service Management Requests
Sample Request and Response
The following sample URI makes a request for fictional subscription named mysub and fictional cloud service mycs:
DELETE https://management.core.windows.net/mysub/cloudServices/mycs/resources/scheduler/~/jobCollections/myjc/jobs/job1?api-version=2014-04-01
The request is sent with the following headers:
x-ms-version: 2013-06-01
Host: management.core.windows.net
Accept: application/json
The request is sent with the following XML body:
None.
After the request has been sent, the following response is returned:
HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Expires: -1
x-ms-request-id: f1ee9ac55612471aa406d340a372dc77
Date: Fri, 30 Aug 2013 21:00:31 GMT
Content-Length: 0
See Also
What is Scheduler?
Get Started Using Scheduler in the Management Portal
Scheduler Concepts, Terminology, and Entity Hierarchy
How to Build Complex Schedules and Advanced Recurrence with Azure Scheduler
Scheduler PowerShell Cmdlets Reference
Scheduler High-Availability and Reliability
Scheduler Outbound Authentication
Scheduler Limits, Defaults, and Error Codes
Plans and Billing in Azure Scheduler
Azure Scheduler Pricing
Azure Scheduler Videos
Register Subscription
Get Resource Provider Properties
Create Cloud Service2
Get Cloud Service1
Get Cloud Services2
Delete Cloud Service2
Create Job1
Update Job1
Get Job1
Delete Job (Scheduler API)
Check Name Availability1
Create Job Collection
Update Job Collection
Get Job Collection
Delete Job Collection
Get All Jobs
Get Job History1