RunbookVersion
The RunbookVersion entity represents a version of a runbook.
This entity supports streams. For more information, see Working with Binary Data (WCF Data Services).
Inheritance Hierarchy
Orchestrator.ResourceModel
RunbookVersion
Supported HTTP Verbs
| Create (POST) | Read (GET) | Update (PUT) | Delete (DELETE) |
|---|---|---|---|
True |
True |
True |
True |
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 |
|---|---|---|---|---|---|---|---|
RunbookVersionID |
- |
Optional* |
Required |
Required |
Edm.Guid |
False |
Key Property The unique identifier of the runbook version. |
CreationTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the runbook version was created. |
IsDraft |
- |
Optional |
- |
- |
Edm.Boolean |
False |
Indicates whether the runbook is a draft or if it’s published. true if the runbook is a draft, otherwise false. |
LastModifiedTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the runbook version was last modified. |
RunbookID |
- |
Optional |
- |
- |
Edm.Guid |
False |
The unique identifier of the runbook. |
TenantID |
- |
Optional |
- |
- |
Edm.Guid |
False |
Unique identifier of the tenant that manages the System Management Automation service. |
VersionNumber |
- |
Optional |
- |
- |
Edm.Int32 |
False |
The version number of the runbook. |
Note
*Direct access to the entity requires the key property RunbookVersionID. This property is not required to simply enumerate the RunbookVersions 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 |
|---|---|---|---|---|
JobContexts |
Many |
RunbookVersionID |
JobContext |
RunbookVersionID |
Runbook |
One |
RunbookID |
Runbook |
RunbookID |
RunbookParameters |
Many |
RunbookVersionID |
RunbookParameter |
RunbookVersionID |
Examples
Examples of supported data operations are available in the RunbookVersions collection topic.