ruleCondition resource type
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 rule conditions for an alert rule.
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.
Properties
| Property | Type | Description |
|---|---|---|
| relationshipType | microsoft.graph.deviceManagement.relationshipType | The relationship type. Possible values are: and, or. |
| conditionCategory | microsoft.graph.deviceManagement.conditionCategory | The property that the rule condition monitors. Possible values are: provisionFailures, imageUploadFailures, azureNetworkConnectionCheckFailures, cloudPcInGracePeriod, frontlineInsufficientLicenses, cloudPcConnectionErrors, cloudPcHostHealthCheckFailures, cloudPcZoneOutage, unknownFutureValue. |
| aggregation | microsoft.graph.deviceManagement.aggregationType | The built-in aggregation method for the rule condition. The possible values are: count, percentage, affectedCloudPcCount, affectedCloudPcPercentage, unknownFutureValue. |
| operator | microsoft.graph.deviceManagement.operatorType | The built-in operator for the rule condition. The possible values are: greaterOrEqual, equal, greater, less, lessOrEqual, notEqual, unknownFutureValue. |
| thresholdValue | String | The threshold value of the alert condition. The threshold value can be a number in string form or string like "WestUS". |
relationshipType values
| Member | Description |
|---|---|
| and | The rule conditions have an "and" relationship |
| or | The rule conditions have an "or" relationship. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
conditionCategory values
| Member | Description |
|---|---|
| provisionFailures | The rule condition targets provision failures. |
| imageUploadFailures | The rule condition targets image upload failures. |
| azureNetworkConnectionCheckFailures | The rule condition targets Azure network connection check failures. |
| cloudPcInGracePeriod | The rule condition targets Cloud PCs entering grace period state. |
| frontlineInsufficientLicenses | The rule condition targets Frontline insufficient licenses. |
| cloudPcConnectionErrors | The rule condition targets Cloud PC connection errors. |
| cloudPcHostHealthCheckFailures | The rule condition targets Cloud PC host health check failures. |
| cloudPcZoneOutage | The rule condition targets Cloud PC zone outage. |
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
aggregationType values
| Member | Description |
|---|---|
| count | The number of items that match the rule conditions. |
| percentage | The percentage of the items that match the rule conditions. |
| affectedCloudPcCount | The total number of Cloud PCs that meet the rule conditions. |
| affectedCloudPcPercentage | The percentage of Cloud PCs that meet the rule conditions. |
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
operatorType values
| Member | Description |
|---|---|
| greaterOrEqual | The operator is greater than or equal to the threshold target. |
| equal | The operator is equal to the threshold target. |
| greater | The operator is greater than the threshold target. |
| less | The operator is less than the threshold target. |
| lessOrEqual | The operator is less than or equal to the threshold target. |
| notEqual | The operator isn't equal to the threshold target. |
| 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.ruleCondition",
"relationshipType": "String",
"conditionCategory": "String",
"aggregation": "String",
"operator": "String",
"thresholdValue": "String"
}