Schedule
The Schedule entity represents a schedule in System Management Automation. The Schedules collection includes all of the schedules in the local System Management Automation environment.
Also see: DailySchedule and OneTimeSchedule.
Inheritance Hierarchy
Orchestrator.ResourceModel
Schedule
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 |
|---|---|---|---|---|---|---|---|
ScheduleID |
- |
Optional* |
Required |
Required |
Edm.Guid |
False |
Key Property The unique identifier of the schedule. |
CreationTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the schedule was created. |
Description |
- |
Optional |
Optional |
- |
Edm.String |
True |
The description of the schedule. |
ExpiryTime |
- |
Optional |
Optional |
- |
Edm.DateTime |
True |
The date and time the schedule ends without repeating. |
IsEnabled |
- |
Optional |
Optional |
- |
Edm.Boolean |
False |
Indicates when the schedule is enabled. |
LastModifiedTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
The date and time the schedule was last modified. |
Name |
- |
Optional |
- |
- |
Edm.String |
False |
The name of the schedule. |
NextRun |
- |
Optional |
- |
- |
Edm.DateTime |
True |
The next date and time the schedule will repeat. |
StartTime |
- |
Optional |
Optional |
- |
Edm.DateTime |
False |
The start time of the schedule. |
TenantID |
- |
Optional |
- |
- |
Edm.Guid |
False |
Unique identifier of the tenant that manages the System Management Automation service. |
Note
*Direct access to the entity requires the key property ScheduleID. This property is not required to simply enumerate the Schedules 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 |
ScheduleID |
JobContext |
ScheduleID |
Runbooks |
Many |
Not specified |
Runbook |
Not specified |
Examples
Examples of supported data operations are available in the Schedules collection topic.