Обновление alertRule

Статья
04/16/2023

Пространство имен: microsoft.graph.deviceManagement

Важно!

Api в /beta версии Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий .

Обновление свойств объекта alertRule .

Разрешения

Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.

Тип разрешения	Разрешения (в порядке повышения привилегий)
Делегированные (рабочая или учебная учетная запись)	CloudPC.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.
Приложение	CloudPC.ReadWrite.All

HTTP-запрос

PATCH /deviceManagement/monitoring/alertRules/{alertRuleId}

Заголовки запросов

Имя	Описание
Авторизация	Носитель {token}. Обязательно.
Content-Type	application/json. Обязательно.

Текст запроса

Укажите в тексте запроса только значения обновляемых свойств. Предыдущие значения существующих свойств, не включенных в текст запроса, будут сохранены или вычислены повторно с учетом изменений, внесенных в значения других свойств.

В следующей таблице указаны свойства, которые можно обновить.

Свойство	Тип	Описание
enabled	Boolean	Состояние правила, указывающее, включено или отключено правило. Если `true`задано значение , правило включено; в противном случае правило будет отключено. Необязательный параметр.
notificationChannels	коллекция microsoft.graph.deviceManagement.notificationChannel	Каналы уведомлений правила, выбранные пользователем. Необязательный параметр.
severity	microsoft.graph.deviceManagement.ruleSeverityType	Серьезность правила. Допустимые значения: `unknown`, `informational`, `warning`, `critical`, `unknownFutureValue`. Необязательный параметр.
Порог	microsoft.graph.deviceManagement.ruleThreshold	Пороговое значение правила. Необязательный параметр.

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код ответа и обновленный объект microsoft.graph.deviceManagement.alertRule в тексте ответа.

Примеры

Запрос

Ниже приведен пример запроса.

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


// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Beta.Models.DeviceManagement.AlertRule
{
	Severity = Microsoft.Graph.Beta.Models.DeviceManagement.RuleSeverityType.Informational,
	Enabled = true,
	Threshold = new Microsoft.Graph.Beta.Models.DeviceManagement.RuleThreshold
	{
		Aggregation = Microsoft.Graph.Beta.Models.DeviceManagement.AggregationType.Count,
		Operator = Microsoft.Graph.Beta.Models.DeviceManagement.OperatorType.GreaterOrEqual,
		Target = 90,
	},
	NotificationChannels = new List<Microsoft.Graph.Beta.Models.DeviceManagement.NotificationChannel>
	{
		new Microsoft.Graph.Beta.Models.DeviceManagement.NotificationChannel
		{
			NotificationChannelType = Microsoft.Graph.Beta.Models.DeviceManagement.NotificationChannelType.Portal,
			Receivers = new List<string>
			{
				"",
			},
			NotificationReceivers = new List<NotificationReceiver>
			{
			},
		},
		new Microsoft.Graph.Beta.Models.DeviceManagement.NotificationChannel
		{
			NotificationChannelType = Microsoft.Graph.Beta.Models.DeviceManagement.NotificationChannelType.Email,
			Receivers = new List<string>
			{
				"serena.davis@contoso.com",
			},
			NotificationReceivers = new List<Microsoft.Graph.Beta.Models.DeviceManagement.NotificationReceiver>
			{
				new Microsoft.Graph.Beta.Models.DeviceManagement.NotificationReceiver
				{
					Locale = "en-us",
					ContactInformation = "serena.davis@contoso.com",
				},
			},
		},
	},
};
var result = await graphClient.DeviceManagement.Monitoring.AlertRules["{alertRule-id}"].PatchAsync(requestBody);

Важно!

Пакеты SDK Microsoft Graph по умолчанию используют версию API версии 1.0 и не поддерживают все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к API бета-версии с помощью пакета SDK см. в статье Использование пакетов SDK Microsoft Graph с бета-версией API.

Дополнительные сведения о добавлении пакета SDK в проект и создании экземпляра authProvider см. в документации по пакету SDK.


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);

Важно!


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);

Важно!



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodelsdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/models/devicemanagement"
	  //other-imports
)

graphClient, err := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodelsdevicemanagement.NewAlertRule()
severity := graphmodels.INFORMATIONAL_RULESEVERITYTYPE 
requestBody.SetSeverity(&severity) 
enabled := true
requestBody.SetEnabled(&enabled) 
threshold := graphmodelsdevicemanagement.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 := graphmodelsdevicemanagement.NewNotificationChannel()
notificationChannelType := graphmodels.PORTAL_NOTIFICATIONCHANNELTYPE 
notificationChannel.SetNotificationChannelType(&notificationChannelType) 
receivers := []string {
	"",

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

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

}
notificationChannel1.SetReceivers(receivers)


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

notificationReceivers := []graphmodelsdevicemanagement.NotificationReceiverable {
	notificationReceiver,

}
notificationChannel1.SetNotificationReceivers(notificationReceivers)

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

}
requestBody.SetNotificationChannels(notificationChannels)

result, err := graphClient.DeviceManagement().Monitoring().AlertRules().ByAlertRuleId("alertRule-id").Patch(context.Background(), requestBody, nil)

Важно!


<?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);




$result = $graphServiceClient->deviceManagement()->monitoring()->alertRules()->byAlertRuleId('alertRule-id')->patch($requestBody);

Важно!


// THE PYTHON SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
client =  GraphServiceClient(request_adapter)

request_body = AlertRule()
request_body.severity(RuleSeverityType.Informational('ruleseveritytype.informational'))

request_body.enabled = True

threshold = RuleThreshold()
threshold.aggregation(AggregationType.Count('aggregationtype.count'))

threshold.operator(OperatorType.GreaterOrEqual('operatortype.greaterorequal'))

threshold.Target = 90


request_body.threshold = threshold
notification_channels_notification_channel1 = NotificationChannel()
notification_channels_notification_channel1.notificationchanneltype(NotificationChannelType.Portal('notificationchanneltype.portal'))

notification_channels_notification_channel1.Receivers(['', ])

notification_channels_notification_channel1.NotificationReceivers([])


notificationChannelsArray []= notificationChannelsNotificationChannel1;
notification_channels_notification_channel2 = NotificationChannel()
notification_channels_notification_channel2.notificationchanneltype(NotificationChannelType.Email('notificationchanneltype.email'))

notification_channels_notification_channel2.Receivers(['serena.davis@contoso.com', ])

notification_receivers_notification_receiver1 = NotificationReceiver()
notification_receivers_notification_receiver1.locale = 'en-us'

notification_receivers_notification_receiver1.contact_information = 'serena.davis@contoso.com'


notificationReceiversArray []= notificationReceiversNotificationReceiver1;
notification_channels_notification_channel2.notificationreceivers(notificationReceiversArray)



notificationChannelsArray []= notificationChannelsNotificationChannel2;
request_body.notificationchannels(notificationChannelsArray)





result = await client.device_management.monitoring.alert_rules.by_alert_rule_id('alertRule-id').patch(request_body = request_body)

Важно!

Отклик

Ниже приведен пример отклика.

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

Обновление alertRule

Разрешения

HTTP-запрос

Заголовки запросов

Текст запроса

Отклик

Примеры

Запрос

Отклик

Дополнительные ресурсы

Дополнительные ресурсы