healthIssue resource type

Article
09/13/2024

Namespace: microsoft.graph.security

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 potential issues identified by Microsoft Defender for Identity within a customer's Microsoft Defender for Identity configuration.

Inherits from entity.

Methods

Method	Return type	Description
List	microsoft.graph.security.healthIssue collection	Get a list of healthIssue objects and their properties.
Get	microsoft.graph.security.healthIssue	Read the properties and relationships of a healthIssue object.
Update	microsoft.graph.security.healthIssue	Update the properties of a healthIssue object.

Properties

Property	Type	Description
additionalInformation	String collection	Contains additional information about the issue, such as a list of items to fix.
createdDateTime	DateTimeOffset	The date and time when the health issue was generated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
description	String	Contains more detailed information about the health issue.
displayName	String	The display name of the health issue.
domainNames	String collection	A list of the fully qualified domain names of the domains or the sensors the health issue is related to.
healthIssueType	microsoft.graph.security.healthIssueType	The type of the health issue. The possible values are: `sensor`, `global`, `unknownFutureValue`. For a list of all health issues and their identifiers, see Microsoft Defender for Identity health issues.
id	String	A unique identifier that represents the health issue. Inherited from entity.
issueTypeId	String	The type identifier of the health issue. For a list of all health issues and their identifiers, see Microsoft Defender for Identity health issues.
lastModifiedDateTime	DateTimeOffset	The date and time when the health issue was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.
recommendations	String collection	A list of recommended actions that can be taken to resolve the issue effectively and efficiently. These actions might include instructions for further investigation and aren't limited to prewritten responses.
recommendedActionCommands	String collection	A list of commands from the PowerShell module for the product that can be used to resolve the issue, if available. If no commands can be used to solve the issue, this property is empty. The commands, if present, provide a quick and efficient way to address the issue. These commands run in sequence for the single recommended fix.
sensorDNSNames	String collection	A list of the DNS names of the sensors the health issue is related to.
severity	microsoft.graph.security.healthIssueSeverity	The severity of the health issue. The possible values are: `low`, `medium`, `high`, `unknownFutureValue`.
status	microsoft.graph.security.healthIssueStatus	The status of the health issue. The possible values are: `open`, `closed`, `suppressed`, `unknownFutureValue`.

healthIssueSeverity values

Member	Description
low	Low severity health issues usually indicate minor issues that don't have a significant impact on your environment. These issues require further investigation, but they usually don't require immediate action.
medium	Medium severity health issues indicate more significant issues that could potentially impact your environment. These issues may require further investigation and action to prevent any potential problems.
high	High severity health issues indicate critical issues that could have a severe impact on your environment. These issues require immediate attention and action.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

healthIssueStatus values

Member	Description
open	The issue is open and should be addressed.
closed	The issue was addressed. Either someone manually closed the issue or took an action on the affected item, or it was closed automatically by the system.
suppressed	The operator suppressed the issue manually.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

healthIssueType values

Member	Description
sensor	The issue is on specific sensor.
global	The issue is in the Defender for identity system configuration.
unknownFutureValue	Evolvable enumeration sentinel value. Don't use.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.security.healthIssue",
  "additionalInformation": ["String"],
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "domainNames": ["String"],
  "healthIssueType": "String",
  "id": "String (identifier)",
  "issueTypeId": "String",
  "lastModifiedDateTime": "String (timestamp)",
  "recommendations": ["String"],
  "recommendedActionCommands": ["String"],
  "sensorDNSNames": ["String"],
  "severity": "String",
  "status": "String"
}

Share via