Runbook
The Runbook entity represents a System Management Automation runbook. The Runbooks collection includes all of the runbooks in the local System Management Automation environment.
Inheritance Hierarchy
Orchestrator.ResourceModel
Runbook
Supported HTTP Verbs
| Create (POST) | Read (GET) | Update (PUT) | Delete (DELETE) |
|---|---|---|---|
False |
True |
True |
True |
Supported Operations
| Operation | Description |
|---|---|
Edits a runbook. |
|
Publishes a runbook. |
|
Starts a runbook job. |
|
Configures a runbook to start when a specific schedule fires. |
|
Starts a runbook job using the draft version of the runbook. |
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 |
|---|---|---|---|---|---|---|---|
RunbookID |
- |
Optional* |
Required |
Required |
Edm.Guid |
False |
Key Property The unique identifier of the runbook. |
CreationTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the runbook was created. |
Description |
- |
Optional |
- |
- |
Edm.String |
True |
The description of the runbook. |
DraftRunbookVersionID |
- |
Optional |
- |
- |
Edm.Guid |
True |
The unique identifier of the runbook draft version. |
IsApiOnly |
- |
Optional |
- |
- |
Edm.Boolean |
False |
If true, this runbook will not be shown in the portal. |
IsGlobal |
- |
Optional |
- |
- |
Edm.Boolean |
False |
If true, this runbook will be shown to all tenants. |
LastModifiedBy |
- |
Optional |
- |
- |
Edm.String |
True |
The last user account to modify the runbook. |
LastModifiedTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the runbook was last modified. |
LogDebug |
- |
Optional |
- |
- |
Edm.Boolean |
False |
Enables or disables the debug stream for a job. |
LogProgress |
- |
Optional |
- |
- |
Edm.Boolean |
False |
Enables or disables the progress stream for a job. |
LogVerbose |
- |
Optional |
- |
- |
Edm.Boolean |
False |
Enables or disables the verbose stream for a job. |
PublishedRunbookVersionID |
- |
Optional |
- |
- |
Edm.Guid |
True |
The unique identifier of the published runbook version. |
RunbookName |
- |
Optional |
- |
- |
Edm.String |
False |
The name of the runbook. |
Tags |
- |
Optional |
- |
- |
Edm.String |
True |
A comma separated list of keywords. |
TenantID |
- |
Optional |
- |
- |
Edm.Guid |
False |
The unique identifier of the tenant that manages the Service Management Automation web service. |
Note
*Direct access to the entity requires the key property RunbookID. This property is not required to simply enumerate the Runbooks 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 |
|---|---|---|---|---|
Statistics |
One |
RunbookID |
Statistics |
RunbookID |
DraftRunbookVersion |
One or None |
DraftRunbookVersionID |
RunbookVersion |
RunbookVersionID |
PublishedRunbookVersion |
One or None |
PublishedRunbookVersionID |
RunbookVersion |
RunbookVersionID |
Schedules |
Many |
Not specified |
Schedule |
Not specified |
Examples
Examples of supported data operations are available in the Runbooks collection topic.