RunbookParameter
The RunbookParameter entity represents a parameter of a System Management Automation runbook. The RunbookParameters collection includes all of the runbook parameters in all of the runbooks in the local System Management Automation environment.
Inheritance Hierarchy
Orchestrator.ResourceModel
RunbookParameter
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 |
|---|---|---|---|---|---|---|---|
Name |
- |
Optional* |
Required |
Required |
Edm.String |
False |
Key Property The name of the runbook parameter. |
RunbookVersionID |
- |
Optional |
- |
- |
Edm.Guid |
False |
Key Property The unique identifier of the runbook version. |
IsMandatory |
- |
Optional |
- |
- |
Edm.Boolean |
False |
Indicates whether the runbook parameter is mandatory. |
Position |
- |
Optional |
- |
- |
Edm.Int32 |
False |
|
Type |
- |
Optional |
- |
- |
Edm.String |
False |
The type of the runbook parameter. |
Note
*Direct access to the entity requires the key property RunbookParameterID. This property is not required to simply enumerate the RunbookParameters 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 |
|---|---|---|---|---|
RunbookVersion |
One |
RunbookVersionID |
RunbookVersion |
RunbookVersionID |
Examples
Examples of supported data operations are available in the RunbookParameters collection topic.