Activity
The Activity entity represents an activity in a System Management Automation runbook. The Activities collection includes all of the activities in all the runbooks in the local System Management Automation environment.
Inheritance Hierarchy
Orchestrator.ResourceModel
Activity
Supported HTTP Verbs
| 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 |
|---|---|---|---|---|---|---|---|
ActivityID |
- |
Optional* |
- |
- |
Edm.Guid |
False |
Key Property The unique identifier of the activity. |
CreationTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the activity is created. |
Definition |
- |
Optional |
- |
- |
Edm.String |
False |
The definition of the activity. |
Description |
- |
Optional |
- |
- |
Edm.String |
True |
The description of the activity. |
LastModifiedTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The last date and time the activity is modified. |
ModuleID |
- |
Optional |
- |
- |
Edm.Guid |
False |
The unique identifier of the module that contains the activity. |
ModuleName |
- |
Optional |
- |
- |
Edm.String |
False |
The name of the module that contains the activity. |
Name |
- |
Optional |
- |
- |
Edm.String |
False |
The name of the activity. |
Tags |
- |
Optional |
- |
- |
Edm.String |
True |
|
TenantID |
- |
Optional |
- |
- |
Edm.Guid |
False |
The unique identifier of the tenant that manages the System Management Automation service. |
Type |
- |
Optional |
- |
- |
Edm.String |
True |
The name of the activity’s type. |
Note
Direct access to the entity requires the key property ActivityID. This property is not required to simply enumerate the Activities 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 |
|---|---|---|---|---|
Module |
One |
ModuleID |
Module |
ModuleID |
ActivityParameterSets |
Many |
ActivityID |
ActivityParameterSet |
ActivityID |
ActivityOutputTypes |
Many |
ActivityID |
ActivityOutputType |
ActivityID |
Examples
Examples of supported data operations are available in the Activities collection topic.