创建 alertRule

  • 项目

命名空间：microsoft.graph.deviceManagement

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

创建 alertRule 对象。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ❌ ❌ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） CloudPC.ReadWrite.All 不可用。
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 CloudPC.ReadWrite.All 不可用。

HTTP 请求

POST /deviceManagement/monitoring/alertRules

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中，仅提供应更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值，或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

属性 类型 说明
alertRuleTemplate microsoft.graph.deviceManagement.alertRuleTemplate 警报事件的规则模板。 可能的值包括 cloudPcProvisionScenario、cloudPcImageUploadScenario、cloudPcOnPremiseNetworkConnectionCheckScenario、cloudPcInGracePeriodScenario、cloudPcFrontlineInsufficientLicensesScenario、cloudPcInaccessibleScenario。 必须使用 Prefer: include-unknown-enum-members 请求标头从此 可演变枚举中获取以下值： cloudPcInGracePeriodScenario。
说明 String 规则说明。
displayName String 规则的显示名称。
enabled 布尔值 指示规则是启用还是禁用的规则的状态。 如果 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"
            }
        ]
      }
  ]
}