Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Represents monitors for tenant or drift monitoring across all workloads supported by Tenant Configuration Management, enabling periodic detection of deviations from the desired configuration state.
Inherits from entity.
Methods
| Method | Return type | Description |
|---|---|---|
| List | configurationMonitor collection | Get a list of the configurationMonitor objects and their properties. |
| Create | configurationMonitor | Create a new configurationMonitor object that runs periodically in the background at a scheduled frequency. |
| Get | configurationMonitor | Get the properties and relationships of a configurationMonitor object. |
| Update | configurationMonitor | Update the properties of a configurationMonitor object, including the monitor name, description, and baseline. |
| Delete | None | Delete a configurationMonitor object permanently. |
| Get configuration baseline | configurationBaseline collection | Read the properties and relationships of a configurationBaseline object that is attached to a specific monitor. |
Properties
| Property | Type | Description |
|---|---|---|
| createdBy | identitySet | The user, app, or device that created the monitor. Returned only on $select. Supports $filter (eq). |
| createdDateTime | DateTimeOffset | The date and time when the monitor was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ne, ge, le) and $orderby. |
| description | String | User-friendly description of the monitor given by the user. Supports $filter (eq, ne, startsWith) and $orderby. |
| displayName | String | User-friendly name given by the user to the monitor. Supports $filter (eq, ne, startsWith) and $orderby. |
| id | String | Globally unique identifier (GUID) for the monitor. System-generated. Inherited from entity. Supports $filter (eq, ne) and $orderby. |
| inactivationReason | String | The reason for the monitor's inactivation. Returned only on $select. |
| lastModifiedBy | identitySet | The user, app, or device that last modified the monitor. Returned only on $select. Supports $filter (eq). |
| lastModifiedDateTime | DateTimeOffset | The date and time when the monitor was last modified. If no modifications are made to the monitor, it's the same as createdDateTime. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ne, ge, le) and $orderby. |
| mode | monitorMode | Monitor mode in which the monitor runs. The possible values are: monitorOnly, unknownFutureValue. The default value is monitorOnly. Supports $filter (eq, ne). |
| monitorRunFrequencyInHours | Int32 | Frequency at which the monitor runs. The default frequency is six hours. Regardless of when you create or update a monitor, it gets triggered within the next 6 hours. Currently, monitors are picked up at fixed times: 6 AM, 12 PM, 6 PM, and 12 AM (all in GMT). For example, if you create a monitor at 9 AM, it gets triggered around 12 PM. If you update a monitor at 4 PM, it gets triggered around 6 PM. |
| parameters | openComplexDictionaryType | Key-value pairs that contain parameter values which might be used in the baseline. Returned only on $select. |
| status | monitorStatus | Status of the monitor. The possible values are: active, inactive, unknownFutureValue. The default value is active. Supports $filter (eq, ne) and $orderby. |
| tenantId | String | Globally unique identifier (GUID) of the tenant for which the monitor runs. Fetched automatically by the system. Supports $filter (eq, ne). |
Relationships
| Relationship | Type | Description |
|---|---|---|
| baseline | configurationBaseline | A relationship that contains details of at least one resource and one property associated with the resource to be monitored. Returned only with $select. Supports $expand. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.configurationMonitor",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"id": "String (identifier)",
"inactivationReason": "String",
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"mode": "String",
"monitorRunFrequencyInHours": "Int32",
"parameters": {"@odata.type": "microsoft.graph.openComplexDictionaryType"},
"status": "String",
"tenantId": "String"
}