tipo de recurso alertRule

Namespace: 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.

Representa uma regra que um administrador de TI com as funções apropriadas pode configurar para monitorar problemas e disparar alertas no centro de administração do Microsoft Endpoint Manager.

Quando o limite de um alertRule é atingido, um alertaRecord é gerado e armazenado e os administradores recebem notificações por meio de canais de notificação definidos.

Para obter mais informações, consulte o recurso de monitoramento .

Observação

Essa API faz parte do conjunto de API de monitoramento de alertas que atualmente dá suporte apenas a cenários Windows 365 e cloud pc. O conjunto de API permite que os administradores configurem regras para alertar problemas com o provisionamento de PCs na Nuvem, o carregamento de imagens do Cloud PC e a verificação de conexões de rede do Azure.

Tem um cenário diferente que pode usar suporte a alertas programáticos adicionais no centro de administração do Microsoft Endpoint Manager? Sugira o recurso ou vote em solicitações de recurso existentes.

Método Tipo de retorno Descrição
Listar alertasRules coleção microsoft.graph.deviceManagement.alertRule Obtenha uma lista dos objetos alertRule e suas propriedades.
Criar alertRule microsoft.graph.deviceManagement.alertRule Crie um objeto alertRule .
Obter alertRule microsoft.graph.deviceManagement.alertRule Leia as propriedades e as relações de um objeto alertRule .
Atualizar alertRule microsoft.graph.deviceManagement.alertRule Atualize as propriedades de um objeto alertRule .

Propriedades

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. Observe que você deve usar o cabeçalho de Prefer: include-unknown-enum-members solicitação para obter os seguintes valores deste enumerável em evolução: cloudPcInGracePeriodScenario.
description Cadeia de caracteres A descrição da regra.
displayName Cadeia de caracteres O nome de exibição da regra.
habilitadas Booliano O status da regra que indica se a regra está habilitada ou desabilitada. Se true, a regra estiver habilitada; caso contrário, a regra será desabilitada.
id Cadeia de caracteres O identificador exclusivo para a regra de alerta. Herdado da entidade.
isSystemRule Booliano Indica se a regra é uma regra do sistema. Se true, a regra for uma regra do sistema; caso contrário, a regra será definida sob medida e poderá ser editada. As regras do sistema são internas e apenas algumas propriedades podem ser editadas.
notificationChannels coleção microsoft.graph.deviceManagement.notificationChannel Os canais de notificação da regra selecionada pelo usuário.
severity microsoft.graph.deviceManagement.ruleSeverityType A gravidade da regra. Os valores possíveis são: unknown, informational, warning, critical, unknownFutureValue.
Limite microsoft.graph.deviceManagement.ruleThreshold As condições que determinam quando enviar alertas. Por exemplo, você pode configurar uma condição para enviar um alerta quando o provisionamento falhar para seis ou mais PCs de Nuvem. Essa propriedade está preterida. Em vez disso, use condições.
conditions coleção microsoft.graph.deviceManagement.ruleCondition As condições que determinam quando enviar alertas. Por exemplo, você pode configurar uma condição para enviar um alerta quando o provisionamento falhar para seis ou mais PCs de Nuvem.

valores alertRuleTemplate

Member Descrição
cloudPcProvisionScenario A regra de alerta foi disparada para um problema com o provisionamento do CLOUD PC. Para uma regra do sistema, a regra de alerta foi disparada para uma falha de provisionamento do CLOUD PC.
cloudPcImageUploadScenario A regra de alerta foi disparada para um problema com o processo para carregar a imagem do CLOUD PC. Para uma regra do sistema, a regra de alerta foi disparada para uma falha no carregamento da imagem do CLOUD PC.
cloudPcOnPremiseNetworkConnectionCheckScenario A regra de alerta foi disparada para um problema com a marcar de conexão de rede local. Para uma regra do sistema, a regra de alerta foi disparada para uma falha com a conexão de rede local.
unknownFutureValue Valor sentinela de enumeração evoluível. Não usar.
cloudPcInGracePeriodScenario A regra de alerta foi disparada quando o COMPUTADOR de Nuvem entrou no período de carência.
cloudPcFrontlineInsufficientLicensesScenario A regra de alerta foi disparada para os PCs da Nuvem de Linha de Frente, onde conexões de PC de Nuvem mais simultâneas estavam ativas do que o limite de simultaneidade permite.
cloudPcInaccessibleScenario A regra de alerta foi disparada quando os PCs da Nuvem não podiam se conectar devido a falhas de integridade do host, erros de conexão ou uma interrupção de zona. Como alternativa, porque eles estavam sob provisionamento ou restauração do dispositivo status.

valores ruleSeverityType

Member Descrição
desconhecido O nível de gravidade é unknown. Usado para inicialização.
Informativo O nível de gravidade é informational.
warning O nível de gravidade é warning.
Crítico O nível de gravidade é critical.
unknownFutureValue Valor sentinela de enumeração evoluível. Não usar.

Relações

Nenhum

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.deviceManagement.alertRule",
  "alertRuleTemplate": "String",  
  "description": "String",
  "displayName": "String",
  "enabled": "Boolean",
  "id": "String (identifier)",
  "isSystemRule": "Boolean",
  "notificationChannels": [
    {
      "@odata.type": "microsoft.graph.deviceManagement.notificationChannel"
    }
  ], 
  "severity": "String",
  "threshold": {
    "@odata.type": "microsoft.graph.deviceManagement.ruleThreshold"
  },
  "condition": [
    {
      "@odata.type": "microsoft.graph.deviceManagement.ruleCondition"
    }
  ]
}