Get configurationMonitor

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.

Get the properties and relationships of a configurationMonitor object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	ConfigurationMonitoring.Read.All	ConfigurationMonitoring.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	ConfigurationMonitoring.Read.All	ConfigurationMonitoring.ReadWrite.All

HTTP request

To get the details of any particular monitor:

GET /admin/configurationManagement/configurationMonitors/{configurationMonitorId}

Note: Replace configurationMonitorId with the monitor ID for which you want to get the details.

Optional query parameters

This method supports the $select OData query parameter to help customize the response. For general information, see OData query parameters.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a configurationMonitor object in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/admin/configurationManagement/configurationMonitors/b166c9cb-db29-438b-95fb-247da1dc72c3

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": {
    "id": "fe082480-bdc2-a90c-25f8-4c7fb2fe2f81",
    "inactivationReason": null,
    "displayName": "Demo Monitor",
    "description": "This is a demo monitor.",
    "tenantId": "96bf81b4-2694-42bb-9204-70081135ca61",
    "status": "active",
    "monitorRunFrequencyInHours": 6,
    "mode": "monitorOnly",
    "createdBy": {
      "user": {
        "id": "823da47e-fc25-48d8-8b5a-6186c760f0df",
        "displayName": "System Administrator"
      }
    },
    "createdDateTime": "2024-12-12T09:52:18.7982733Z",
    "lastModifiedBy": {
      "user": {
        "id": "823da47e-fc25-48d8-8b5a-6186c760f0df",
        "displayName": "System Administrator"
      }
    },
    "lastModifiedDateTime": "2024-12-12T09:52:18.7982733Z",
    "parameters": {
      "FQDN": "contoso.onmicrosoft.com",
      "TenantId": "2fcf1c68-b412-4c85-bfb2-cb20152a6843"
    }
  }
}