OneTimeSchedule
The OneTimeSchedule 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 Schedule.
Inheritance Hierarchy
Orchestrator.ResourceModel
Schedule
OneTimeSchedule
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 (Inherited from Schedule.) The unique identifier of the schedule. |
CreationTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
(Inherited from Schedule.) The date and time the schedule was created. |
Description |
- |
Optional |
- |
- |
Edm.String |
True |
(Inherited from Schedule.) The description of the schedule. |
ExpiryTime |
- |
Optional |
- |
- |
Edm.DateTime |
True |
(Inherited from Schedule.) The date and time the schedule ends without repeating. |
IsEnabled |
- |
Optional |
- |
- |
Edm.Boolean |
False |
(Inherited from Schedule.) Indicates when the schedule is enabled. |
LastModifiedTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
(Inherited from Schedule.) The date and time the schedule was last modified. |
Name |
- |
Optional |
- |
- |
Edm.String |
False |
(Inherited from Schedule.) The name of the schedule. |
NextRun |
- |
Optional |
- |
- |
Edm.DateTime |
True |
(Inherited from Schedule.) The next date and time the schedule will repeat. |
StartTime |
- |
Optional |
- |
- |
Edm.DateTime |
False |
(Inherited from Schedule.) The start time of the schedule. |
TenantID |
- |
Optional |
- |
- |
Edm.Guid |
False |
(Inherited from Schedule.) 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
This entity does not have any relationships.
Examples
Examples of supported data operations are available in the Schedules collection topic.