Update 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.

Update the properties 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.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	CloudPC.ReadWrite.All

HTTP request

PATCH /deviceManagement/monitoring/alertRules/{alertRuleId}

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
enabled	Boolean	The status of the rule that indicates whether the rule is enabled or disabled. If true, the rule is enabled; otherwise, the rule is disabled. Optional.
notificationChannels	microsoft.graph.deviceManagement.notificationChannel collection	The notification channels of the rule selected by the user. Optional.
severity	ruleSeverityType	The severity of the rule. The possible values are: unknown, informational, warning, critical, unknownFutureValue. Optional.
threshold	microsoft.graph.deviceManagement.ruleThreshold	The threshold of the rule. Optional.

Response

If successful, this method returns a 200 OK response code and an updated microsoft.graph.deviceManagement.alertRule object in the response body.

Examples

Request

The following is an example of a request.

HTTP

PATCH https://graph.microsoft.com/beta/deviceManagement/monitoring/alertRules/215c55cc-b1c9-4d36-a870-be5778101714
Content-Type: application/json

{
  "severity": "informational",
  "enabled": true,
  "threshold": {
      "aggregation": "count",
      "operator": "greaterOrEqual",
      "target": 90
  },
  "notificationChannels": [
      {
        "notificationChannelType": "portal",
        "receivers": [
            ""
        ],
        "notificationReceivers": []
      },
      {
        "notificationChannelType": "email",
        "receivers": [
            "serena.davis@contoso.com"
        ],
        "notificationReceivers": [
            {
                "locale": "en-us",
                "contactInformation": "serena.davis@contoso.com"
            }
        ]
      }
  ]
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const alertRule = {
  severity: 'informational',
  enabled: true,
  threshold: {
      aggregation: 'count',
      operator: 'greaterOrEqual',
      target: 90
  },
  notificationChannels: [
      {
        notificationChannelType: 'portal',
        receivers: [
            ''
        ],
        notificationReceivers: []
      },
      {
        notificationChannelType: 'email',
        receivers: [
            'serena.davis@contoso.com'
        ],
        notificationReceivers: [
            {
                locale: 'en-us',
                contactInformation: 'serena.davis@contoso.com'
            }
        ]
      }
  ]
};

await client.api('/deviceManagement/monitoring/alertRules/215c55cc-b1c9-4d36-a870-be5778101714')
	.version('beta')
	.update(alertRule);

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 = new AlertRule();
alertRule.severity = RuleSeverityType.INFORMATIONAL;
alertRule.enabled = true;
RuleThreshold threshold = new RuleThreshold();
threshold.aggregation = AggregationType.COUNT;
threshold.operator = OperatorType.GREATER_OR_EQUAL;
threshold.target = 90;
alertRule.threshold = threshold;
LinkedList<NotificationChannel> notificationChannelsList = new LinkedList<NotificationChannel>();
NotificationChannel notificationChannels = new NotificationChannel();
notificationChannels.notificationChannelType = NotificationChannelType.PORTAL;
LinkedList<String> receiversList = new LinkedList<String>();
receiversList.add("");
notificationChannels.receivers = receiversList;
LinkedList<NotificationReceiver> notificationReceiversList = new LinkedList<NotificationReceiver>();
notificationChannels.notificationReceivers = notificationReceiversList;
notificationChannelsList.add(notificationChannels);
NotificationChannel notificationChannels1 = new NotificationChannel();
notificationChannels1.notificationChannelType = NotificationChannelType.EMAIL;
LinkedList<String> receiversList1 = new LinkedList<String>();
receiversList1.add("serena.davis@contoso.com");
notificationChannels1.receivers = receiversList1;
LinkedList<NotificationReceiver> notificationReceiversList1 = new LinkedList<NotificationReceiver>();
NotificationReceiver notificationReceivers = new NotificationReceiver();
notificationReceivers.locale = "en-us";
notificationReceivers.contactInformation = "serena.davis@contoso.com";
notificationReceiversList1.add(notificationReceivers);
notificationChannels1.notificationReceivers = notificationReceiversList1;
notificationChannelsList.add(notificationChannels1);
alertRule.notificationChannels = notificationChannelsList;

graphClient.deviceManagement().monitoring().alertRules("215c55cc-b1c9-4d36-a870-be5778101714")
	.buildRequest()
	.patch(alertRule);

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)

requestBody := graphmodels.NewAlertRule()
severity := graphmodels.INFORMATIONAL_RULESEVERITYTYPE 
requestBody.SetSeverity(&severity) 
enabled := true
requestBody.SetEnabled(&enabled) 
threshold := graphmodels.NewRuleThreshold()
aggregation := graphmodels.COUNT_AGGREGATIONTYPE 
threshold.SetAggregation(&aggregation) 
operator := graphmodels.GREATEROREQUAL_OPERATORTYPE 
threshold.SetOperator(&operator) 
target := int32(90)
threshold.SetTarget(&target) 
requestBody.SetThreshold(threshold)


notificationChannel := graphmodels.NewNotificationChannel()
notificationChannelType := graphmodels.PORTAL_NOTIFICATIONCHANNELTYPE 
notificationChannel.SetNotificationChannelType(&notificationChannelType) 
receivers := []string {
	"",

}
notificationChannel.SetReceivers(receivers)
notificationReceivers := []graphmodels.NotificationReceiverable {

}
notificationChannel.SetNotificationReceivers(notificationReceivers)
notificationChannel1 := graphmodels.NewNotificationChannel()
notificationChannelType := graphmodels.EMAIL_NOTIFICATIONCHANNELTYPE 
notificationChannel1.SetNotificationChannelType(&notificationChannelType) 
receivers := []string {
	"serena.davis@contoso.com",

}
notificationChannel1.SetReceivers(receivers)


notificationReceiver := graphmodels.NewNotificationReceiver()
locale := "en-us"
notificationReceiver.SetLocale(&locale) 
contactInformation := "serena.davis@contoso.com"
notificationReceiver.SetContactInformation(&contactInformation) 

notificationReceivers := []graphmodels.NotificationReceiverable {
	notificationReceiver,

}
notificationChannel1.SetNotificationReceivers(notificationReceivers)

notificationChannels := []graphmodels.NotificationChannelable {
	notificationChannel,
	notificationChannel1,

}
requestBody.SetNotificationChannels(notificationChannels)

result, err := graphClient.DeviceManagement().Monitoring().AlertRulesById("alertRule-id").Patch(context.Background(), requestBody, 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);

$requestBody = new AlertRule();
$requestBody->setSeverity(new RuleSeverityType('informational'));

$requestBody->setEnabled(true);

$threshold = new RuleThreshold();
$threshold->setAggregation(new AggregationType('count'));

$threshold->setOperator(new OperatorType('greaterorequal'));

$threshold->setTarget(90);


$requestBody->setThreshold($threshold);
$notificationChannelsNotificationChannel1 = new NotificationChannel();
$notificationChannelsNotificationChannel1->setNotificationChannelType(new NotificationChannelType('portal'));

$notificationChannelsNotificationChannel1->setReceivers(['', ]);

$notificationChannelsNotificationChannel1->setNotificationReceivers([]);


$notificationChannelsArray []= $notificationChannelsNotificationChannel1;
$notificationChannelsNotificationChannel2 = new NotificationChannel();
$notificationChannelsNotificationChannel2->setNotificationChannelType(new NotificationChannelType('email'));

$notificationChannelsNotificationChannel2->setReceivers(['serena.davis@contoso.com', ]);

$notificationReceiversNotificationReceiver1 = new NotificationReceiver();
$notificationReceiversNotificationReceiver1->setLocale('en-us');

$notificationReceiversNotificationReceiver1->setContactInformation('serena.davis@contoso.com');


$notificationReceiversArray []= $notificationReceiversNotificationReceiver1;
$notificationChannelsNotificationChannel2->setNotificationReceivers($notificationReceiversArray);



$notificationChannelsArray []= $notificationChannelsNotificationChannel2;
$requestBody->setNotificationChannels($notificationChannelsArray);




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

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": "215c55cc-b1c9-4d36-a870-be5778101714",
  "displayName": "Azure network connection failure impacting Cloud PCs",
  "severity": "informational",
  "isSystemRule": true,
  "description": "Azure network connection checks have failed and is potentially impacting existing Cloud PCs and blocking the provisioning of new Cloud PCs",
  "enabled": true,
  "alertRuleTemplate": "cloudPcOnPremiseNetworkConnectionCheckScenario",
  "threshold": {
      "aggregation": "count",
      "operator": "greaterOrEqual",
      "target": 90
  },
  "notificationChannels": [
      {
        "notificationChannelType": "portal",
        "receivers": [
            ""
        ],
        "notificationReceivers": []
      },
      {
        "notificationChannelType": "email",
        "receivers": [
            "serena.davis@contoso.com"
        ],
        "notificationReceivers": [
            {
                "locale": "en-us",
                "contactInformation": "serena.davis@contoso.com"
            }
        ]
      }
  ]
}