configurationMonitor resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents the information and properties of a configurationMonitor object. This resource allows administrators to create and manage monitors for tenant or drift monitoring across all workloads supported by unified 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 who created the monitor.
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.
description	String	User-friendly description of the monitor given by the user.
displayName	String	User-friendly name given by the user to the monitor.
id	String	Globally unique identifier (GUID) for the monitor. System-generated. Inherited from entity.
inactivationReason	String	The reason for the monitor's inactivation.
lastModifiedBy	identitySet	The user who last modified the monitor.
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.
mode	monitorMode	Monitor mode in which the monitor runs. The possible values are: monitorOnly, unknownFutureValue. The default value is monitorOnly.
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.
status	monitorStatus	Status of the monitor The possible values are: active, unknownFutureValue. The default value is active.
tenantId	String	Globally unique identifier (GUID) of the tenant for which the monitor runs. Fetched automatically by the system.

Relationships

Relationship	Type	Description
baseline	configurationBaseline	A complex object that contains details of at least one resource and one property associated with the resource to be monitored.

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"
}