alertRecord resource type

Article
07/23/2024

Namespace: microsoft.graph.deviceManagement

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents the record of an alert event in the Microsoft Endpoint Manager admin center triggered by an alertRule.

When the threshold of an alertRule is reached, an alertRecord is generated and stored, and administrators receive notifications via defined notification channels.

For more information, see the monitoring resource.

Note

This API is part of the alert monitoring API set which currently supports only Windows 365 and Cloud PC scenarios. The API set allows admins to set up rules to alert issues with provisioning Cloud PCs, uploading Cloud PC images, and checking Azure network connections.

Have a different scenario that can use additional programmatic alert support on the Microsoft Endpoint Manager admin center? Suggest the feature or vote for existing feature requests.

Methods

Method	Return type	Description
List	microsoft.graph.deviceManagement.alertRecord collection	Get a list of the alertRecord objects and their properties.
Get	microsoft.graph.deviceManagement.alertRecord	Read the properties and relationships of an alertRecord object.
Get portal notifications	microsoft.graph.deviceManagement.portalNotification collection	Get a list of all portal notifications that one or more users can access, from the Microsoft Endpoint Manager admin center.
Set portal notification as sent	None	Set the status of the specified notification on the Microsoft EndPoint Manager admin center as sent.

Properties

Property	Type	Description
alertImpact	microsoft.graph.deviceManagement.alertImpact	The impact of the alert event. Consists of a list of key-value pair and a number followed by the aggregation type. For example, `6 affectedCloudPcCount` means that 6 Cloud PCs are affected. `12 affectedCloudPcPercentage` means 12% of Cloud PCs are affected. The list of key-value pair indicates the details of the alert impact.
alertRuleId	String	The corresponding ID of the alert rule.
alertRuleTemplate	microsoft.graph.deviceManagement.alertRuleTemplate	The rule template of the alert event. The possible values are: `cloudPcProvisionScenario`, `cloudPcImageUploadScenario`, `cloudPcOnPremiseNetworkConnectionCheckScenario`, `unknownFutureValue`, `cloudPcInGracePeriodScenario`. Note that you must use the `Prefer: include-unknown-enum-members` request header to get the following values from this evolvable enum: `cloudPcInGracePeriodScenario`.
detectedDateTime	DateTimeOffset	The date and time when the alert event was detected. The Timestamp type represents date and time information using ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
displayName	String	The display name of the alert record.
id	String	The unique identifier for the alert record. Inherited from entity.
lastUpdatedDateTime	DateTimeOffset	The date and time when the alert record was last updated. The Timestamp type represents date and time information using ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
resolvedDateTime	DateTimeOffset	The date and time when the alert event was resolved. The Timestamp type represents date and time information using ISO 8601 format. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
severity	microsoft.graph.deviceManagement.ruleSeverityType	The severity of the alert event. The possible values are: `unknown`, `informational`, `warning`, `critical`, `unknownFutureValue`.
status	microsoft.graph.deviceManagement.alertStatusType	The status of the alert record. The possible values are: `active`, `resolved`, `unknownFutureValue`.

alertStatusType values

Member	Description
active	The alert is active.
resolved	The alert is marked as resolved.
unknownFutureValue	Evolvable enumeration sentinel value. Do not use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.deviceManagement.alertRecord",
  "alertImpact": {
    "@odata.type": "microsoft.graph.deviceManagement.alertImpact"
  },  
  "alertRuleId": "String",
  "alertRuleTemplate": "String",
  "detectedDateTime": "String (timestamp)",
  "displayName": "String",
  "id": "String (identifier)",
  "lastUpdatedDateTime": "String (timestamp)",
  "resolvedDateTime": "String (timestamp)",
  "severity": "String",
  "status": "String"
}

Share via