Stop
The Stop operation stops a runbook job.
Request
| Method | Request URI | HTTP Version |
|---|---|---|
POST |
HTTPS://<HOST>:<PORT>/00000000-0000-0000-0000-000000000000/Jobs(guid'<GUID>')/Stop |
HTTP/1.1 |
Note
This OData operation requires the request URL to point to an instance of the Job entity.
Behavior
The following table describes how this operation behaves.
| Setting | Value |
|---|---|
Is composable? |
False |
Has side effects? |
True |
Requires an entity instance? |
True |
Return type |
None |
Results belong to an entity set? |
None |
Parameters
Parameters are passed in either the URL of the operation, or the body, depending on the HTTP method used. The following table describes the parameters of this operation.
| Name | Type | Nullable | Description |
|---|---|---|---|
GUID |
Edm.Guid |
False |
The unique identifier of the job. |
Code Example
POST https://sma-server:9090/00000000-0000-0000-0000-000000000000/Jobs(guid'ba12b433-342e-4c15-88a1-942020c7a92e')/Stop HTTP/1.1
Uri stopJobUri = new Uri(string.Concat(SMAService.Jobs, string.Format("(guid'{0}')/{1}", jobID, "Stop")), UriKind.Absolute);
var returnValue = SMAService.Execute<Guid>(stopJobUri, "POST", true);