Job
The Job entity represents a runbook job for System Management Automation. The Jobs collection includes all of the jobs for all of the runbooks in the local System Management Automation environment.
This entity supports streams. For more information, see Working with Binary Data (WCF Data Services).
Inheritance Hierarchy
Orchestrator.ResourceModel
Job
Supported HTTP Verbs
| Create (POST) | Read (GET) | Update (PUT) | Delete (DELETE) |
|---|---|---|---|
False |
True |
False |
False |
Supported Operations
| Operation | Description |
|---|---|
Resumes a suspended job. |
|
Stops a currently running job. |
|
Suspends a currently running job. |
| Create (POST) | Read (GET) | Update (PUT) | Delete (DELETE) |
|---|---|---|---|
False |
True |
False |
False |
Entity Properties
For more information about how the properties of an entity interact with HTTP operations, see Service Management Automation Web Service Fundamentals.
| Name | Create (PUT) | Read (GET) | Update (POST) | Delete (DELETE) | Type | Nullable | Description |
|---|---|---|---|---|---|---|---|
JobID |
- |
Optional* |
- |
- |
Edm.Guid |
False |
Key Property The unique identifier of the job. |
CreationTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the job was created. |
EndTime |
- |
Optional |
- |
- |
Edm.DateTime |
True |
The date time the job ended. |
ErrorCount |
- |
Optional |
- |
- |
Edm.Int16 |
True |
The number of errors for the job. |
JobContextID |
- |
Optional |
- |
- |
Edm.Guid |
False |
The context ID of the job. |
JobException |
- |
Optional |
- |
- |
Edm.String |
True |
The message and stacktrace of the last exception that suspended the job. |
JobStatus |
- |
Optional |
- |
- |
Edm.String |
False |
The status of the job. |
LastModifiedTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the job was last modified. |
StartTime |
- |
Optional |
- |
- |
Edm.DateTime |
True |
The date and time the job started. |
TenantID |
- |
Optional |
- |
- |
Edm.Guid |
False |
The unique identifier of the tenant that hosts the System Management Automation service. |
WarningCount |
- |
Optional |
- |
- |
Edm.Int16 |
True |
The number of warnings for the job. |
Note
*Direct access to the entity requires the key property JobID. This property is not required to simply enumerate the Jobs collection.
Relationships
For more information about how the relationships of an entity are used, see Service Management Automation Web Service Fundamentals.
| Name | Relationship Type | From Property | To Entity | To Property |
|---|---|---|---|---|
JobContext |
One |
JobContextID |
JobContext |
JobContextID |
Examples
Examples of supported data operations are available in the Jobs collection topic.