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.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	CloudPC.Read.All, CloudPC.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	CloudPC.Read.All, CloudPC.ReadWrite.All

HTTP request

GET /deviceManagement/monitoring/alertRules/{alertRuleId}

Request headers

Name	Description
Authorization	Bearer {token}. Required.

Request body

Do not 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 is an example of a request.

HTTP

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

C#

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.DeviceManagement.Monitoring.AlertRules["{alertRule-id}"].GetAsync();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let alertRule = await client.api('/deviceManagement/monitoring/alertRules/30070507-6514-443b-8fa5-06979cedacdf')
	.version('beta')
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

AlertRule alertRule = graphClient.deviceManagement().monitoring().alertRules("30070507-6514-443b-8fa5-06979cedacdf")
	.buildRequest()
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


result, err := graphClient.DeviceManagement().Monitoring().AlertRulesById("alertRule-id").Get(context.Background(), nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);


$requestResult = $graphServiceClient->deviceManagement()->monitoring()->alertRulesById('alertRule-id')->get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of 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
    },
    "notificationChannels": [
        {
            "notificationChannelType": "portal",
            "receivers": [
                ""
            ],
            "notificationReceivers": []
        },
        {
            "notificationChannelType": "email",
            "receivers": [
                "serena.davis@contoso.com"
            ],
            "notificationReceivers": [
                {
                    "locale": "en-us",
                    "contactInformation": "serena.davis@contoso.com"
                }
            ]
        }
    ]
}