Создание alertRule

  • Статья

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

Важно!

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

Создайте объект alertRule .

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ❌ ❌ ❌

Разрешения

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

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

HTTP-запрос

POST /deviceManagement/monitoring/alertRules

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

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

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

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

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

Свойство Тип Описание
alertRuleTemplate microsoft.graph.deviceManagement.alertRuleTemplate Шаблон правила события оповещения. Допустимые значения: cloudPcProvisionScenario, cloudPcImageUploadScenario, cloudPcOnPremiseNetworkConnectionCheckScenario, cloudPcInGracePeriodScenario, cloudPcFrontlineInsufficientLicensesScenario, cloudPcInaccessibleScenario. Чтобы получить следующие значения из этого развиваемого перечисленияPrefer: include-unknown-enum-members, необходимо использовать заголовок запроса: cloudPcInGracePeriodScenario.
description String Описание правила.
displayName String Отображаемое имя правила.
включено Логический Состояние правила, указывающее, включено или отключено правило. Если trueзадано значение , правило включено; в противном случае правило будет отключено.
isSystemRule Логический Значение типа , указывающее, является ли правило системным. Если trueзадано значение , это правило является системным правилом; в противном случае это пользовательское правило, которое можно изменить. Во встроенных системных правилах можно изменить только несколько свойств.
notificationChannels коллекция microsoft.graph.deviceManagement.notificationChannel Каналы уведомлений правила, выбранные пользователем.
severity microsoft.graph.deviceManagement.ruleSeverityType Серьезность правила. Допустимые значения: unknown, informational, warning, critical, unknownFutureValue.
Порог microsoft.graph.deviceManagement.ruleThreshold Пороговое значение правила. Это свойство устарело. Вместо этого используйте conditions .
conditions коллекция microsoft.graph.deviceManagement.ruleCondition Условия правила. Условия определяют, когда следует отправлять оповещение. Например, можно задать условие, чтобы оповещение отправлялось в случае сбоя подготовки шести или более облачных компьютеров.

Отклик

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

Пример

Запрос

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

POST https://graph.microsoft.com/beta/deviceManagement/monitoring/alertRules
Content-Type: application/json

{
  "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
  },
  "conditions": [
      {
        "relationshipType": "or",
        "conditionCategory": "azureNetworkConnectionCheckFailures",
        "aggregation": "count",
        "operator": "greaterOrEqual",
        "thresholdValue": "90"
      }
  ],
  "notificationChannels": [
      {
        "notificationChannelType": "portal",
        "notificationReceivers": []
      },
      {
        "notificationChannelType": "email",
        "notificationReceivers": [
            {
                "locale": "en-us",
                "contactInformation": "serena.davis@contoso.com"
            }
        ]
      }
  ]
}

Отклик

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

HTTP/1.1 201 CREATED
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
  },
  "conditions": [
      {
        "relationshipType": "or",
        "conditionCategory": "azureNetworkConnectionCheckFailures",
        "aggregation": "count",
        "operator": "greaterOrEqual",
        "thresholdValue": "90"
      }
  ],
  "notificationChannels": [
      {
        "notificationChannelType": "portal",
        "notificationReceivers": []
      },
      {
        "notificationChannelType": "email",
        "notificationReceivers": [
            {
                "locale": "en-us",
                "contactInformation": "serena.davis@contoso.com"
            }
        ]
      }
  ]
}