Statistics
The Statistics entity represents the statistics for a runbook instance. The Statistics collection includes all of the statistic sets for all the runbooks in the local System Management Automation environment.
Inheritance Hierarchy
Orchestrator.ResourceModel
Statistics
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 |
---|---|---|---|---|---|---|---|
RunbookID |
- |
Optional* |
- |
- |
Edm.Guid |
False |
Key Property The unique identifier of the Runbook. |
CompletedCount |
- |
Optional |
- |
- |
Edm.Int32 |
True |
The number of completed Runbook jobs. |
FailedCount |
- |
Optional |
- |
- |
Edm.Int32 |
True |
The number of failed Runbook jobs. |
LastStart |
- |
Optional |
- |
- |
Edm.DateTime |
True |
The last time a Runbook job started. |
RunningCount |
- |
Optional |
- |
- |
Edm.Int32 |
True |
The number of running Runbook jobs. |
StoppedCount |
- |
Optional |
- |
- |
Edm.Int32 |
True |
The number of stopped Runbook jobs. |
SuspendedCount |
- |
Optional |
- |
- |
Edm.Int32 |
True |
The number of suspended Runbook jobs. |
TenantID |
- |
Optional |
- |
- |
Edm.Guid |
True |
Unique identifier of the tenant that manages the System Management Automation service. |
TotalJobCount |
- |
Optional |
- |
- |
Edm.Int32 |
True |
The total number of Runbook jobs. |
Note
*Direct access to the entity requires the key property RunbookID. This property is not required to simply enumerate the Statistics 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 |
---|---|---|---|---|
Runbook |
One |
RunbookID |
Runbook |
RunbookID |
Examples
Examples of supported data operations are available in the Statistics collection topic.