Compartilhar via

Criar alertRule

  • Artigo

Espaço de nomes: microsoft.graph.deviceManagement

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Criar um objeto alertRule .

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ❌

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) CloudPC.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

Solicitação HTTP

POST /deviceManagement/monitoring/alertRules

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade Tipo Descrição
alertRuleTemplate microsoft.graph.deviceManagement.alertRuleTemplate O modelo de regra do evento de alerta. Os valores possíveis são: cloudPcProvisionScenario, cloudPcImageUploadScenario, cloudPcOnPremiseNetworkConnectionCheckScenario, cloudPcInGracePeriodScenario, cloudPcFrontlineInsufficientLicensesScenario, cloudPcInaccessibleScenario. Tem de utilizar o cabeçalho do Prefer: include-unknown-enum-members pedido para obter os seguintes valores desta enumeração evoluível: cloudPcInGracePeriodScenario.
description Cadeia de caracteres A descrição da regra.
displayName Cadeia de caracteres O nome de exibição da regra.
habilitadas Booliano A status da regra que indica se a regra está ativada ou desativada. Se true, a regra estiver ativada; caso contrário, a regra será desativada.
isSystemRule Booliano Um valor que indica se a regra é uma regra de sistema. Se true, a regra for uma regra de sistema; caso contrário, é uma regra definida por personalizado e pode ser editada. Apenas algumas propriedades podem ser editadas em regras de sistema incorporadas.
notificationChannels coleção microsoft.graph.deviceManagement.notificationChannel Os canais de notificação da regra selecionada pelo utilizador.
severity microsoft.graph.deviceManagement.ruleSeverityType A gravidade da regra. Os valores possíveis são: unknown, informational, warning, critical, unknownFutureValue.
limiar microsoft.graph.deviceManagement.ruleThreshold O limiar da regra. Esta propriedade foi preterida. Em vez disso, utilize conditions .
conditions microsoft.graph.deviceManagement.ruleCondition collection As condições da regra. As condições determinam quando enviar um alerta. Por exemplo, pode definir uma condição para que um alerta seja enviado quando seis ou mais PCs na Cloud não são aprovisionados.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto microsoft.graph.deviceManagement.alertRule no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

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