Get alertRule

Namespace: microsoft.graph.deviceManagement

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.

Read the properties and relationships of an alertRule 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) CloudPC.Read.All CloudPC.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application CloudPC.Read.All CloudPC.ReadWrite.All

HTTP request

GET /deviceManagement/monitoring/alertRules/{alertRuleId}

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 an microsoft.graph.deviceManagement.alertRule object in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/deviceManagement/monitoring/alertRules/30070507-6514-443b-8fa5-06979cedacdf

Response

The following example shows the response.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#deviceManagement/monitoring/alertRules/$entity",
    "id": "30070507-6514-443b-8fa5-06979cedacdf",
    "displayName": "Upload failure for Device Images",
    "severity": "warning",
    "isSystemRule": true,
    "description": "Device Image Uploads have failed and can delay the provisioning of new Cloud PCs.",
    "enabled": true,
    "alertRuleTemplate": "cloudPcImageUploadScenario",
    "threshold": {
        "aggregation": "count",
        "operator": "greaterOrEqual",
        "target": 2
    },
    "conditions": [
        {
            "relationshipType": "or",
            "conditionCategory": "imageUploadFailures",
            "aggregation": "count",
            "operator": "greaterOrEqual",
            "thresholdValue": "2"
        }
    ],
    "notificationChannels": [
        {
            "notificationChannelType": "portal",
            "notificationReceivers": []
        },
        {
            "notificationChannelType": "email",
            "notificationReceivers": [
                {
                    "locale": "en-us",
                    "contactInformation": "serena.davis@contoso.com"
                }
            ]
        }
    ]
}