mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-05-29 21:57:23 +00:00
Merge branch 'master' of https://github.com/MicrosoftDocs/windows-docs-pr into sfc01
This commit is contained in:
Greg Lindsay
commit
d4bbef98fa
@ -14,7 +14,7 @@ author: dansimp
|
||||
ms.author: dansimp
|
||||
ms.topic: article
|
||||
ms.audience: itpro
|
||||
ms.date: 10/21/2019
|
||||
ms.date: 11/13/2019
|
||||
---
|
||||
|
||||
# Microsoft Surface Data Eraser
|
||||
@ -160,11 +160,17 @@ After you create a Microsoft Surface Data Eraser USB stick, you can boot a suppo
|
||||
|
||||
Microsoft Surface Data Eraser is periodically updated by Microsoft. For information about the changes provided in each new version, see the following:
|
||||
|
||||
### 3.28.137
|
||||
*Release Date: 11 Nov 2019*
|
||||
This version of Surface Data Eraser:
|
||||
|
||||
- Includes bug fixes
|
||||
|
||||
### Version 3.21.137
|
||||
*Release Date: 21 Oct 2019*
|
||||
This version of Surface Data Eraser is compiled for x86 and adds support for the following devices:
|
||||
|
||||
Supports Surface Pro 7, Surface Pro X, and Surface Laptop 3.
|
||||
- Supports Surface Pro 7, Surface Pro X, and Surface Laptop 3
|
||||
|
||||
### Version 3.2.78.0
|
||||
*Release Date: 4 Dec 2018*
|
||||
|
||||
@ -86,15 +86,18 @@ Successful completion of Surface Dock Firmware Update results in new registry ke
|
||||
|
||||
## Event logging
|
||||
|
||||
**Table 1. Event logging for Surface Dock Firmware Update**
|
||||
**Table 1. Log files for Surface Dock Firmware Update**
|
||||
|
||||
| Log | Location | Notes |
|
||||
| -------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Surface Dock Firmware Update log | Path needs to be specified (see note) | Earlier versions of this tool wrote events to Applications and Services Logs\Microsoft Surface Dock Updater. |
|
||||
| Surface Dock Firmware Update log | /l*v %windir%\logs\ SurfaceDockFWI.log | |
|
||||
| Windows Device Install log | %windir%\inf\setupapi.dev.log | For more information about using Device Install Log, refer to [SetupAPI Logging](https://docs.microsoft.com/windows-hardware/drivers/install/setupapi-logging--windows-vista-and-later-). |
|
||||
|
||||
|
||||
**Table 2. Event log IDs for Surface Dock Firmware Update**
|
||||
Events are logged in the Application Event Log.
|
||||
> [!NOTE]
|
||||
> Earlier versions of this tool wrote events to Applications and Services Logs\Microsoft Surface Dock Updater.
|
||||
|
||||
| Event ID | Event type |
|
||||
| -------- | -------------------------------------------------------------------- |
|
||||
|
||||
@ -368,7 +368,7 @@
|
||||
###### [Get access with user context](microsoft-defender-atp/exposed-apis-create-app-nativeapp.md)
|
||||
|
||||
##### [APIs]()
|
||||
###### [Supported Microsoft Defender ATP query APIs](microsoft-defender-atp/exposed-apis-list.md)
|
||||
###### [Supported Microsoft Defender ATP APIs](microsoft-defender-atp/exposed-apis-list.md)
|
||||
###### [Advanced Hunting](microsoft-defender-atp/run-advanced-query-api.md)
|
||||
|
||||
###### [Alert]()
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: DeviceTvmSecureConfigurationAssessment table in the Advanced hunting schema
|
||||
description: Learn about the DeviceTvmSecureConfigurationAssessment table in the Advanced hunting schema, such as machine ID, computer name, operating system platform, security configuration details, impact, and compliance information.
|
||||
keywords: advanced hunting, atp query, device management, query atp data, query tvm data, query security configuration, intellisense, atp telemetry, events, events telemetry, azure log analytics, description, DeviceTvmSecureConfigurationAssessment
|
||||
description: Learn about Threat & Vulnerability Management security assessment events in the DeviceTvmSecureConfigurationAssessment table of the Advanced hunting schema. These events provide machine information as well as security configuration details, impact, and compliance information.
|
||||
keywords: advanced hunting, threat hunting, cyber threat hunting, search, query, telemetry, schema reference, kusto, table, column, data type, description, threat & vulnerability management, TVM, device management, security configuration, DeviceTvmSecureConfigurationAssessment
|
||||
search.product: eADQiWindows 10XVcnh
|
||||
search.appverid: met150
|
||||
ms.prod: w10
|
||||
@ -15,7 +15,7 @@ manager: dansimp
|
||||
audience: ITPro
|
||||
ms.collection: M365-security-compliance
|
||||
ms.topic: article
|
||||
ms.date: 10/27/2019
|
||||
ms.date: 11/12/2019
|
||||
---
|
||||
|
||||
# DeviceTvmSecureConfigurationAssessment
|
||||
@ -28,7 +28,7 @@ ms.date: 10/27/2019
|
||||
|
||||
[!include[Prerelease information](prerelease.md)]
|
||||
|
||||
Each row in the DeviceTvmSecureConfigurationAssessment table contains an assessment event for a specific security configuration. Use this reference to check the latest assessment results and determine whether device are compliant.
|
||||
Each row in the DeviceTvmSecureConfigurationAssessment table contains an assessment event for a specific security configuration from [Threat & Vulnerability Management](next-gen-threat-and-vuln-mgt.md). Use this reference to check the latest assessment results and determine whether devices are compliant.
|
||||
|
||||
For information on other tables in the Advanced hunting schema, see [the Advanced hunting reference](advanced-hunting-reference.md).
|
||||
|
||||
@ -51,3 +51,4 @@ For information on other tables in the Advanced hunting schema, see [the Advance
|
||||
- [All Advanced hunting tables](advanced-hunting-reference.md)
|
||||
- [Advanced hunting query best practices](advanced-hunting-best-practices.md)
|
||||
- [Query data using Advanced hunting](advanced-hunting.md)
|
||||
- [Overview of Threat & Vulnerability Management](next-gen-threat-and-vuln-mgt.md)
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: DeviceTvmSecureConfigurationAssessmentKB table in the Advanced hunting schema
|
||||
description: Learn about the DeviceTvmSecureConfigurationAssessmentKB table in the Advanced hunting schema, security configuration details, and the associated industry benchmarks that it adheres to.
|
||||
keywords: advanced hunting, atp query, device management, query atp data, query tvm data, query security configuration, intellisense, atp telemetry, events, events telemetry, azure log analytics, description, MITRE ATT&CK framework, DeviceTvmSecureConfigurationAssessmentKB
|
||||
description: Learn about the various secure configurations assessed by Threat & Vulnerability Management in the DeviceTvmSecureConfigurationAssessmentKB table of the Advanced hunting schema.
|
||||
keywords: advanced hunting, threat hunting, cyber threat hunting, search, query, telemetry, schema reference, kusto, table, column, data type, description, threat & vulnerability management, TVM, device management, security configuration, MITRE ATT&CK framework, knowledge base, KB, DeviceTvmSecureConfigurationAssessmentKB
|
||||
search.product: eADQiWindows 10XVcnh
|
||||
search.appverid: met150
|
||||
ms.prod: w10
|
||||
@ -15,7 +15,7 @@ manager: dansimp
|
||||
audience: ITPro
|
||||
ms.collection: M365-security-compliance
|
||||
ms.topic: article
|
||||
ms.date: 10/27/2019
|
||||
ms.date: 11/12/2019
|
||||
---
|
||||
|
||||
# DeviceTvmSecureConfigurationAssessmentKB
|
||||
@ -28,7 +28,7 @@ ms.date: 10/27/2019
|
||||
|
||||
[!include[Prerelease information](prerelease.md)]
|
||||
|
||||
The DeviceTvmSecureConfigurationAssessmentKB table in the Advanced hunting schema contains information about the various secure configuration TVM checks during assessments related to your organization. An example of a security configuration is to block JavaScript or VBScript from launching downloaded executable content to prevent accidentally downloading malicious files in your network. Use this reference to construct queries that return information from the table.
|
||||
The DeviceTvmSecureConfigurationAssessmentKB table in the Advanced hunting schema contains information about the various secure configurations — such as whether a device has automatic updates on — checked by [Threat & Vulnerability Management](next-gen-threat-and-vuln-mgt.md). It also includes risk information, related industry benchmarks, and applicable MITRE ATT&CK techniques and tactics. Use this reference to construct queries that return information from the table.
|
||||
|
||||
For information on other tables in the Advanced hunting schema, see [the Advanced hunting reference](advanced-hunting-reference.md).
|
||||
|
||||
@ -51,3 +51,4 @@ For information on other tables in the Advanced hunting schema, see [the Advance
|
||||
- [All Advanced hunting tables](advanced-hunting-reference.md)
|
||||
- [Advanced hunting query best practices](advanced-hunting-best-practices.md)
|
||||
- [Query data using Advanced hunting](advanced-hunting.md)
|
||||
- [Overview of Threat & Vulnerability Management](next-gen-threat-and-vuln-mgt.md)
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: DeviceTvmSoftwareInventoryVulnerabilities table in the Advanced hunting schema
|
||||
description: Learn about the DeviceTvmSoftwareInventoryVulnerabilities table in the Advanced hunting schema, such as operating system platform, version, and architecture, software vendor, name, and version, CVE ID, vulnerability severity, and descriptions
|
||||
keywords: advanced hunting, atp query, device management, query atp data, query tvm data, query software inventory, query software vulnerability inventory, intellisense, atp telemetry, events, events telemetry, azure log analytics, description, DeviceTvmSoftwareInventoryVulnerabilities
|
||||
description: Learn about the inventory of software in your devices and their vulnerabilities in the DeviceTvmSoftwareInventoryVulnerabilities table of the Advanced hunting schema.
|
||||
keywords: advanced hunting, threat hunting, cyber threat hunting, search, query, telemetry, schema reference, kusto, table, column, data type, description, threat & vulnerability management, TVM, device management, software, inventory, vulnerabilities, CVE ID, OS DeviceTvmSoftwareInventoryVulnerabilities
|
||||
search.product: eADQiWindows 10XVcnh
|
||||
search.appverid: met150
|
||||
ms.prod: w10
|
||||
@ -15,7 +15,7 @@ manager: dansimp
|
||||
audience: ITPro
|
||||
ms.collection: M365-security-compliance
|
||||
ms.topic: article
|
||||
ms.date: 10/27/2019
|
||||
ms.date: 11/12/2019
|
||||
---
|
||||
|
||||
# DeviceTvmSoftwareInventoryVulnerabilities
|
||||
@ -29,7 +29,7 @@ ms.date: 10/27/2019
|
||||
|
||||
[!include[Prerelease information](prerelease.md)]
|
||||
|
||||
The DeviceTvmSoftwareInventoryVulnerabilities table in the Advanced hunting schema contains an inventory of the software on your devices as well as any known vulnerabilities in the software products. Use this reference to construct queries that return information from the table.
|
||||
The DeviceTvmSoftwareInventoryVulnerabilities table in the Advanced hunting schema contains the [Threat & Vulnerability Management](next-gen-threat-and-vuln-mgt.md) inventory of software on your devices as well as any known vulnerabilities in these software products. This table also includes operating system information, CVE IDs, and vulnerability severity information. Use this reference to construct queries that return information from the table.
|
||||
|
||||
For information on other tables in the Advanced hunting schema, see [the Advanced hunting reference](advanced-hunting-reference.md).
|
||||
|
||||
@ -54,3 +54,4 @@ For information on other tables in the Advanced hunting schema, see [the Advance
|
||||
- [All Advanced hunting tables](advanced-hunting-reference.md)
|
||||
- [Advanced hunting query best practices](advanced-hunting-best-practices.md)
|
||||
- [Query data using Advanced hunting](advanced-hunting.md)
|
||||
- [Overview of Threat & Vulnerability Management](next-gen-threat-and-vuln-mgt.md)
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: DeviceTvmSoftwareVulnerabilitiesKB table in the Advanced hunting schema
|
||||
description: Learn about the DeviceTvmSoftwareVulnerabilitiesKB table in the Advanced hunting schema, such as CVE ID, CVSS score, exploit availability, vulnerability severity, last modified time, date the vulnerability was disclosed to public, and affected software in your network.
|
||||
keywords: advanced hunting, atp query, device management, query atp data, query tvm data, query software vulnerability inventory, intellisense, atp telemetry, events, events telemetry, azure log analytics, description, DeviceTvmSoftwareVulnerabilitiesKB
|
||||
description: Learn about the software vulnerabilities tracked by Threat & Vulnerability Management in the DeviceTvmSoftwareVulnerabilitiesKB table of the Advanced hunting schema.
|
||||
keywords: advanced hunting, threat hunting, cyber threat hunting, search, query, telemetry, schema reference, kusto, table, column, data type, description, threat & vulnerability management, TVM, device management, software, inventory, vulnerabilities, CVE ID, CVSS, DeviceTvmSoftwareVulnerabilitiesKB
|
||||
search.product: eADQiWindows 10XVcnh
|
||||
search.appverid: met150
|
||||
ms.prod: w10
|
||||
@ -15,7 +15,7 @@ manager: dansimp
|
||||
audience: ITPro
|
||||
ms.collection: M365-security-compliance
|
||||
ms.topic: article
|
||||
ms.date: 10/27/2019
|
||||
ms.date: 11/12/2019
|
||||
---
|
||||
|
||||
# DeviceTvmSoftwareVulnerabilitiesKB
|
||||
@ -28,7 +28,7 @@ ms.date: 10/27/2019
|
||||
|
||||
[!include[Prerelease information](prerelease.md)]
|
||||
|
||||
The DeviceTvmSoftwareInventoryVulnerabilities table in the Advanced hunting schema contains information about the vulnerabilities Threat & Vulnerability Management assesses devices for. Use this reference along with DeviceTvmSoftwareInventoryVulnerabilities to construct queries that return information on the metadata related to the vulnerabilities in your inventory.
|
||||
The DeviceTvmSoftwareInventoryVulnerabilities table in the Advanced hunting schema contains the list of vulnerabilities [Threat & Vulnerability Management](next-gen-threat-and-vuln-mgt.md) assesses devices for. Use this reference to construct queries that return information from the table.
|
||||
|
||||
For information on other tables in the Advanced hunting schema, see [the Advanced hunting reference](advanced-hunting-reference.md).
|
||||
|
||||
@ -49,3 +49,4 @@ For information on other tables in the Advanced hunting schema, see [the Advance
|
||||
- [All Advanced hunting tables](advanced-hunting-reference.md)
|
||||
- [Advanced hunting query best practices](advanced-hunting-best-practices.md)
|
||||
- [Query data using Advanced hunting](advanced-hunting.md)
|
||||
- [Overview of Threat & Vulnerability Management](next-gen-threat-and-vuln-mgt.md)
|
||||
|
||||
@ -17,12 +17,12 @@ ms.topic: article
|
||||
---
|
||||
|
||||
# Alert resource type
|
||||
**Applies to:**
|
||||
- [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
|
||||
Represents an alert entity in Microsoft Defender ATP.
|
||||
**Applies to:** [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
|
||||
# Methods
|
||||
- Want to experience Microsoft Defender ATP? [Sign up for a free trial.](https://www.microsoft.com/microsoft-365/windows/microsoft-defender-atp?ocid=docs-wdatp-exposedapis-abovefoldlink)
|
||||
|
||||
## Methods
|
||||
Method |Return Type |Description
|
||||
:---|:---|:---
|
||||
[Get alert](get-alert-info-by-id.md) | [Alert](alerts.md) | Get a single [alert](alerts.md) object.
|
||||
@ -35,49 +35,95 @@ Method|Return Type |Description
|
||||
[Get related users](get-alert-related-user-info.md) | [User](user.md) | The [user](user.md) that is associated with the [alert](alerts.md).
|
||||
|
||||
|
||||
# Properties
|
||||
## Properties
|
||||
Property | Type | Description
|
||||
:---|:---|:---
|
||||
id | String | Alert ID.
|
||||
incidentId | String | The [Incident](https://docs.microsoft.com/windows/security/threat-protection/microsoft-defender-atp/view-incidents-queue) ID of the Alert.
|
||||
title | String | Alert title.
|
||||
description | String | Alert description.
|
||||
alertCreationTime | Nullable DateTimeOffset | The date and time (in UTC) the alert was created.
|
||||
lastEventTime | Nullable DateTimeOffset | The last occurrence of the event that triggered the alert on the same machine.
|
||||
firstEventTime | Nullable DateTimeOffset | The first occurrence of the event that triggered the alert on that machine.
|
||||
lastUpdateTime | Nullable DateTimeOffset | The first occurrence of the event that triggered the alert on that machine.
|
||||
resolvedTime | Nullable DateTimeOffset | The date and time in which the status of the alert was changed to 'Resolved'.
|
||||
incidentId | Nullable Long | The [Incident](https://docs.microsoft.com/windows/security/threat-protection/microsoft-defender-atp/view-incidents-queue) ID of the Alert.
|
||||
investigationId | Nullable Long | The [Investigation](https://docs.microsoft.com/windows/security/threat-protection/microsoft-defender-atp/automated-investigations) ID related to the Alert.
|
||||
investigationState | Nullable Enum | The current state of the [Investigation](https://docs.microsoft.com/windows/security/threat-protection/microsoft-defender-atp/automated-investigations). Possible values are: 'Unknown', 'Terminated', 'SuccessfullyRemediated', 'Benign', 'Failed', 'PartiallyRemediated', 'Running', 'PendingApproval', 'PendingResource', 'PartiallyInvestigated', 'TerminatedByUser', 'TerminatedBySystem', 'Queued', 'InnerFailure', 'PreexistingAlert', 'UnsupportedOs', 'UnsupportedAlertType', 'SuppressedAlert'.
|
||||
assignedTo | String | Owner of the alert.
|
||||
severity | Enum | Severity of the alert. Possible values are: 'UnSpecified', 'Informational', 'Low', 'Medium' and 'High'.
|
||||
status | Enum | Specifies the current status of the alert. Possible values are: 'Unknown', 'New', 'InProgress' and 'Resolved'.
|
||||
investigationState | Nullable Enum | The current state of the investigation. Possible values are: 'Unknown', 'Terminated', 'SuccessfullyRemediated', 'Benign Failed PartiallyRemediated', 'Running', 'PendingApproval', 'PendingResource', 'PartiallyInvestigated', 'TerminatedByUser', 'TerminatedBySystem', 'Queued', 'InnerFailure', 'PreexistingAlert', 'UnsupportedOs', 'UnsupportedAlertType', 'SuppressedAlert' .
|
||||
classification | Nullable Enum | Specification of the alert. Possible values are: 'Unknown', 'FalsePositive', 'TruePositive'.
|
||||
determination | Nullable Enum | Specifies the determination of the alert. Possible values are: 'NotAvailable', 'Apt', 'Malware', 'SecurityPersonnel', 'SecurityTesting', 'UnwantedSoftware', 'Other'.
|
||||
category| String | Category of the alert. Possible values are: 'Collection', 'Command and control', 'Credential access', 'Defense evasion', 'Discovery', 'Execution', 'Exfiltration', 'Exploit', 'Initial access', 'Lateral movement', 'Malware', 'Persistence', 'Privilege escalation', 'Ransomware', 'Suspicious activity', 'Unwanted software'.
|
||||
detectionSource | string | Detection source.
|
||||
threatFamilyName | string | Threat family.
|
||||
title | string | Alert title.
|
||||
description | String | Description of the threat, identified by the alert.
|
||||
alertCreationTime | DateTimeOffset | The date and time (in UTC) the alert was created.
|
||||
lastEventTime | DateTimeOffset | The last occurrence of the event that triggered the alert on the same machine.
|
||||
firstEventTime | DateTimeOffset | The first occurrence of the event that triggered the alert on that machine.
|
||||
resolvedTime | DateTimeOffset | The date and time in which the status of the alert was changed to 'Resolved'.
|
||||
category| String | Category of the alert.
|
||||
detectionSource | String | Detection source.
|
||||
threatFamilyName | String | Threat family.
|
||||
machineId | String | ID of a [machine](machine.md) entity that is associated with the alert.
|
||||
comments | List of Alert comments | Alert Comment is an object that contains: comment string, createdBy string and createTime date time.
|
||||
alertFiles | List of Alert Files | **This list will be populated on $expand option, see example below** Alert File is an object that contains: sha1, sha256, filePath and fileName.
|
||||
alertIPs | List of Alert IPs | **This list will be populated on $expand option, see example below** Alert IP is an object that contains: ipAddress string field.
|
||||
alertDomains | List of Alert Domains | **This list will be populated on $expand option, see example below** Alert Domain is an object that contains: host string field.
|
||||
|
||||
|
||||
|
||||
## JSON representation:
|
||||
|
||||
- When querying for alert list the regular way (without expand option, e.g. /api/alerts) the expandable properties will not get populated (empty lists)
|
||||
- To expand expandable properties use $expand option (e.g. to expand all send /api/alerts?$expand=files,ips,domains).
|
||||
- When querying single alert all expandable properties will be expanded.
|
||||
- Check out [OData queries with Microsoft Defender ATP](exposed-apis-odata-samples.md) for more OData examples.
|
||||
|
||||
### Response example for getting single alert:
|
||||
|
||||
# JSON representation
|
||||
```
|
||||
GET https://api.securitycenter.windows.com/api/alerts/da637084217856368682_-292920499
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"@odata.context": "https://api.securitycenter.windows.com/api/$metadata#Alerts",
|
||||
"id": "121688558380765161_2136280442",
|
||||
"incidentId": 7696,
|
||||
"id": "da637084217856368682_-292920499",
|
||||
"incidentId": 66860,
|
||||
"investigationId": 4416234,
|
||||
"assignedTo": "secop@contoso.com",
|
||||
"severity": "High",
|
||||
"severity": "Low",
|
||||
"status": "New",
|
||||
"classification": "TruePositive",
|
||||
"determination": "Malware",
|
||||
"determination": null,
|
||||
"investigationState": "Running",
|
||||
"category": "MalwareDownload",
|
||||
"detectionSource": "WindowsDefenderAv",
|
||||
"threatFamilyName": "Mikatz",
|
||||
"title": "Windows Defender AV detected 'Mikatz', high-severity malware",
|
||||
"description": "Some description"
|
||||
"alertCreationTime": "2018-11-26T16:19:21.8409809Z",
|
||||
"firstEventTime": "2018-11-26T16:17:50.0948658Z",
|
||||
"lastEventTime": "2018-11-26T16:18:01.809871Z",
|
||||
"detectionSource": "WindowsDefenderAtp",
|
||||
"category": "CommandAndControl",
|
||||
"threatFamilyName": null,
|
||||
"title": "Network connection to a risky host",
|
||||
"description": "A network connection was made to a risky host which has exhibited malicious activity.",
|
||||
"alertCreationTime": "2019-11-03T23:49:45.3823185Z",
|
||||
"firstEventTime": "2019-11-03T23:47:16.2288822Z",
|
||||
"lastEventTime": "2019-11-03T23:47:51.2966758Z",
|
||||
"lastUpdateTime": "2019-11-03T23:55:52.6Z",
|
||||
"resolvedTime": null,
|
||||
"machineId": "9d80fbbc1bdbc5ce968f1d37c72384cbe17ee337"
|
||||
"machineId": "986e5df8b73dacd43c8917d17e523e76b13c75cd",
|
||||
"comments": [
|
||||
{
|
||||
"comment": "test comment for docs",
|
||||
"createdBy": "secop@contoso.com",
|
||||
"createdTime": "2019-11-05T14:08:37.8404534Z"
|
||||
}
|
||||
],
|
||||
"alertFiles": [
|
||||
{
|
||||
"sha1": "77e862797dd525fd3e9c3058153247945d0d4cfd",
|
||||
"sha256": "c05823562aee5e6d000b0e041197d5b8303f5aa4eecb49820879b705c926e16e",
|
||||
"filePath": "C:\\Users\\test1212\\AppData\\Local\\Temp\\nsf61D3.tmp.exe",
|
||||
"fileName": "nsf61D3.tmp.exe"
|
||||
}
|
||||
],
|
||||
"alertDomains": [
|
||||
{
|
||||
"host": "login.bullguard.com"
|
||||
}
|
||||
],
|
||||
"alertIps": [
|
||||
{
|
||||
"ipAddress": "91.231.212.53"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
@ -18,11 +18,11 @@ ms.topic: article
|
||||
|
||||
# Create alert from event API
|
||||
|
||||
**Applies to:**
|
||||
**Applies to:** [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
|
||||
- [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
- Want to experience Microsoft Defender ATP? [Sign up for a free trial.](https://www.microsoft.com/microsoft-365/windows/microsoft-defender-atp?ocid=docs-wdatp-exposedapis-abovefoldlink)
|
||||
|
||||
Enables using event data, as obtained from the [Advanced Hunting](run-advanced-query-api.md) for creating a new alert entity.
|
||||
Create alert using event data, as obtained from [Advanced Hunting](run-advanced-query-api.md) for creating a new alert.
|
||||
|
||||
## Permissions
|
||||
|
||||
@ -64,7 +64,7 @@ description | String | Description of the alert. **Required**.
|
||||
recommendedAction| String | Action that is recommended to be taken by security officer when analyzing the alert. **Required**.
|
||||
eventTime | DateTime(UTC) | The time of the event, as obtained from the advanced query. **Required**.
|
||||
reportId | String | The reportId, as obtained from the advanced query. **Required**.
|
||||
category| String | Category of the alert. The property values are: 'None', 'SuspiciousActivity', 'Malware', 'CredentialTheft', 'Exploit', 'WebExploit', 'DocumentExploit', 'PrivilegeEscalation', 'Persistence', 'RemoteAccessTool', 'CommandAndControl', 'SuspiciousNetworkTraffic', 'Ransomware', 'MalwareDownload', 'Reconnaissance', 'WebFingerprinting', 'Weaponization', 'Delivery', 'SocialEngineering', 'CredentialStealing', 'Installation', 'Backdoor', 'Trojan', 'TrojanDownloader', 'LateralMovement', 'ExplorationEnumeration', 'NetworkPropagation', 'Exfiltration', 'NotApplicable', 'EnterprisePolicy' and 'General'.
|
||||
category| String | Category of the alert. The property values are: "General", "CommandAndControl", "Collection", "CredentialAccess", "DefenseEvasion", "Discovery", "Exfiltration", "Exploit", "Execution", "InitialAccess", "LateralMovement", "Malware", "Persistence", "PrivilegeEscalation", "Ransomware", "SuspiciousActivity" **Required**.
|
||||
|
||||
## Response
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Supported Microsoft Defender Advanced Threat Protection query APIs
|
||||
title: Supported Microsoft Defender Advanced Threat Protection APIs
|
||||
ms.reviewer:
|
||||
description: Learn about the specific supported Microsoft Defender Advanced Threat Protection entities where you can create API calls to.
|
||||
keywords: apis, supported apis, actor, alerts, machine, user, domain, ip, file, advanced queries, advanced hunting
|
||||
@ -17,14 +17,11 @@ ms.collection: M365-security-compliance
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Supported Microsoft Defender ATP query APIs
|
||||
# Supported Microsoft Defender ATP APIs
|
||||
|
||||
**Applies to:**
|
||||
- Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)
|
||||
**Applies to:** [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
|
||||
|
||||
|
||||
>Want to experience Microsoft Defender ATP? [Sign up for a free trial.](https://www.microsoft.com/microsoft-365/windows/microsoft-defender-atp?ocid=docs-wdatp-supportedapis-abovefoldlink)
|
||||
- Want to experience Microsoft Defender ATP? [Sign up for a free trial.](https://www.microsoft.com/microsoft-365/windows/microsoft-defender-atp?ocid=docs-wdatp-exposedapis-abovefoldlink)
|
||||
|
||||
## End Point URI and Versioning
|
||||
|
||||
@ -42,7 +39,7 @@ ms.topic: article
|
||||
>
|
||||
> To use a specific version, use this format: https://api.securitycenter.windows.com/api/{Version}. For example: https://api.securitycenter.windows.com/api/v1.0/alerts
|
||||
>
|
||||
> If you don't specify any version (e.g., https://api.securitycenter.windows.com/api/alerts ) you will get to the latest version.
|
||||
> If you don't specify any version (e.g. https://api.securitycenter.windows.com/api/alerts ) you will get to the latest version.
|
||||
|
||||
|
||||
Learn more about the individual supported entities where you can run API calls to and details such as HTTP request values, request headers and expected responses.
|
||||
@ -52,12 +49,14 @@ Learn more about the individual supported entities where you can run API calls t
|
||||
Topic | Description
|
||||
:---|:---
|
||||
Advanced Hunting | Run queries from API.
|
||||
Alerts | Run API calls such as get alerts, alert information by ID, alert related actor information, alert related IP information, and alert related machine information.
|
||||
Domain |Run API calls such as get domain related machines, domain related machines, statistics, and check if a domain is seen in your organization.
|
||||
File | Run API calls such as get file information, file related alerts, file related machines, and file statistics.
|
||||
IP | Run API calls such as get IP related alerts, IP related machines, IP statistics, and check if and IP is seen in your organization.
|
||||
Machines | Run API calls such as find machine information by IP, get machines, get machines by ID, information about logged on users, and alerts related to a given machine ID.
|
||||
User | Run API calls such as get alert related user information, user information, user related alerts, and user related machines.
|
||||
Alerts | Run API calls such as get alerts, create alert, update alert and more.
|
||||
Domains | Run API calls such as get domain related machines, domain statistics and more.
|
||||
Files | Run API calls such as get file information, file related alerts, file related machines, and file statistics.
|
||||
IPs | Run API calls such as get IP related alerts and get IP statistics.
|
||||
Machines | Run API calls such as get machines, get machines by ID, information about logged on users, edit tags and more.
|
||||
Machine Actions | Run API call such as Isolation, Run anti-virus scan and more.
|
||||
Indicators | Run API call such as create Indicator, get Indicators and delete Indicators.
|
||||
Users | Run API calls such as get user related alerts and user related machines.
|
||||
|
||||
## Related topic
|
||||
- [Microsoft Defender ATP APIs](apis-intro.md)
|
||||
|
||||
@ -18,16 +18,15 @@ ms.topic: article
|
||||
|
||||
# List alerts API
|
||||
|
||||
**Applies to:**
|
||||
|
||||
- [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
**Applies to:** [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
|
||||
- Want to experience Microsoft Defender ATP? [Sign up for a free trial.](https://www.microsoft.com/microsoft-365/windows/microsoft-defender-atp?ocid=docs-wdatp-exposedapis-abovefoldlink)
|
||||
|
||||
Retrieves a collection of Alerts.
|
||||
|
||||
Supports [OData V4 queries](https://www.odata.org/documentation/).
|
||||
|
||||
The OData's Filter query is supported on: "Id", "IncidentId", "AlertCreationTime", "Status", "Severity" and "Category".
|
||||
The OData's Filter query is supported on: "alertCreationTime", "incidentId", "InvestigationId", "status", "severity" and "category".
|
||||
|
||||
See examples at [OData queries with Microsoft Defender ATP](exposed-apis-odata-samples.md)
|
||||
|
||||
@ -52,7 +51,8 @@ GET /api/alerts
|
||||
```
|
||||
|
||||
## Optional query parameters
|
||||
Method supports $skip and $top query parameters.
|
||||
Method supports $top, $select, $filter, $expand and $skip query parameters.
|
||||
<br>$expand is available on Files, IPs and Domains. e.g. $expand=files,domains
|
||||
|
||||
## Request headers
|
||||
|
||||
@ -74,18 +74,19 @@ If successful, this method returns 200 OK, and a list of [alert](alerts.md) obje
|
||||
|
||||
Here is an example of the request.
|
||||
|
||||
[!include[Improve request performance](improve-request-performance.md)]
|
||||
|
||||
```
|
||||
GET https://api.securitycenter.windows.com/api/alerts
|
||||
```
|
||||
|
||||
[!include[Improve request performance](improve-request-performance.md)]
|
||||
|
||||
|
||||
**Response**
|
||||
|
||||
Here is an example of the response.
|
||||
|
||||
>[!NOTE]
|
||||
>The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
|
||||
>The response list shown here may be truncated for brevity. All alerts will be returned from an actual call.
|
||||
|
||||
|
||||
```json
|
||||
@ -93,44 +94,36 @@ Here is an example of the response.
|
||||
"@odata.context": "https://api.securitycenter.windows.com/api/$metadata#Alerts",
|
||||
"value": [
|
||||
{
|
||||
"id": "121688558380765161_2136280442",
|
||||
"incidentId": 7696,
|
||||
"assignedTo": "secop@contoso.com",
|
||||
"severity": "High",
|
||||
"status": "New",
|
||||
"classification": "TruePositive",
|
||||
"determination": "Malware",
|
||||
"investigationState": "Running",
|
||||
"category": "MalwareDownload",
|
||||
"detectionSource": "WindowsDefenderAv",
|
||||
"threatFamilyName": "Mikatz",
|
||||
"title": "Windows Defender AV detected 'Mikatz', high-severity malware",
|
||||
"description": "Some description",
|
||||
"alertCreationTime": "2018-11-26T16:19:21.8409809Z",
|
||||
"firstEventTime": "2018-11-26T16:17:50.0948658Z",
|
||||
"lastEventTime": "2018-11-26T16:18:01.809871Z",
|
||||
"resolvedTime": null,
|
||||
"machineId": "9d80fbbc1bdbc5ce968f1d37c72384cbe17ee337"
|
||||
},
|
||||
{
|
||||
"id": "441688558380765161_2136280442",
|
||||
"incidentId": 8633,
|
||||
"id": "da637084217856368682_-292920499",
|
||||
"incidentId": 66860,
|
||||
"investigationId": 4416234,
|
||||
"assignedTo": "secop@contoso.com",
|
||||
"severity": "Low",
|
||||
"status": "InProgress",
|
||||
"status": "New",
|
||||
"classification": "TruePositive",
|
||||
"determination": "Malware",
|
||||
"determination": null,
|
||||
"investigationState": "Running",
|
||||
"category": "MalwareDownload",
|
||||
"detectionSource": "WindowsDefenderAv",
|
||||
"threatFamilyName": "Mikatz",
|
||||
"title": "Windows Defender AV detected 'Mikatz', high-severity malware",
|
||||
"description": "Some description",
|
||||
"alertCreationTime": "2018-11-25T16:19:21.8409809Z",
|
||||
"firstEventTime": "2018-11-25T16:17:50.0948658Z",
|
||||
"lastEventTime": "2018-11-25T16:18:01.809871Z",
|
||||
"detectionSource": "WindowsDefenderAtp",
|
||||
"category": "CommandAndControl",
|
||||
"threatFamilyName": null,
|
||||
"title": "Network connection to a risky host",
|
||||
"description": "A network connection was made to a risky host which has exhibited malicious activity.",
|
||||
"alertCreationTime": "2019-11-03T23:49:45.3823185Z",
|
||||
"firstEventTime": "2019-11-03T23:47:16.2288822Z",
|
||||
"lastEventTime": "2019-11-03T23:47:51.2966758Z",
|
||||
"lastUpdateTime": "2019-11-03T23:55:52.6Z",
|
||||
"resolvedTime": null,
|
||||
"machineId": "9d80fbbc1bdbc5ce968f1d37c72384cbe17ee337"
|
||||
"machineId": "986e5df8b73dacd43c8917d17e523e76b13c75cd",
|
||||
"comments": [
|
||||
{
|
||||
"comment": "test comment for docs",
|
||||
"createdBy": "secop@contoso.com",
|
||||
"createdTime": "2019-11-05T14:08:37.8404534Z"
|
||||
}
|
||||
],
|
||||
"alertFiles": [],
|
||||
"alertDomains": [],
|
||||
"alertIps": []
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@ -343,7 +343,7 @@
|
||||
###### [Get access with user context](exposed-apis-create-app-nativeapp.md)
|
||||
|
||||
##### [APIs]()
|
||||
###### [Supported Microsoft Defender ATP query APIs](exposed-apis-list.md)
|
||||
###### [Supported Microsoft Defender ATP APIs](exposed-apis-list.md)
|
||||
###### [Advanced Hunting](run-advanced-query-api.md)
|
||||
|
||||
###### [Alert]()
|
||||
|
||||
@ -19,15 +19,14 @@ ms.topic: article
|
||||
|
||||
# Advanced hunting API
|
||||
|
||||
**Applies to:**
|
||||
- [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
**Applies to:** [Microsoft Defender Advanced Threat Protection (Microsoft Defender ATP)](https://go.microsoft.com/fwlink/p/?linkid=2069559)
|
||||
|
||||
This API allows you to run programmatic queries that you are used to running from [Microsoft Defender ATP Portal](https://securitycenter.windows.com/hunting).
|
||||
- Want to experience Microsoft Defender ATP? [Sign up for a free trial.](https://www.microsoft.com/microsoft-365/windows/microsoft-defender-atp?ocid=docs-wdatp-exposedapis-abovefoldlink)
|
||||
|
||||
## Limitations
|
||||
1. You can only run a query on data from the last 30 days
|
||||
2. The results will include a maximum of 10,000 rows
|
||||
3. The number of executions is limited (up to 15 calls per minute, 15 minutes of running time every hour and 4 hours of running time a day)
|
||||
1. You can only run a query on data from the last 30 days.
|
||||
2. The results will include a maximum of 100,000 rows.
|
||||
3. The number of executions is limited per tenant: up to 15 calls per minute, 15 minutes of running time every hour and 4 hours of running time a day.
|
||||
4. The maximal execution time of a single request is 10 minutes.
|
||||
|
||||
## Permissions
|
||||
@ -126,24 +125,7 @@ Content-Type: application/json
|
||||
}
|
||||
```
|
||||
|
||||
## Troubleshoot issues
|
||||
|
||||
- Error: (403) Forbidden / (401) Unauthorized
|
||||
|
||||
|
||||
~~~
|
||||
If you get this error when calling Microsoft Defender ATP API, your token might not include the necessary permission.
|
||||
|
||||
Check [app permissions](exposed-apis-create-app-webapp.md#validate-the-token) or [delegated permissions](exposed-apis-create-app-nativeapp.md#validate-the-token) included in your token.
|
||||
|
||||
If the 'roles' section in the token does not include the necessary permission:
|
||||
|
||||
- The necessary permission to your app might not have been granted. For more information, see [Access Microsoft Defender ATP without a user](exposed-apis-create-app-webapp.md#create-an-app) or [Access Microsoft Defender ATP on behalf of a user](exposed-apis-create-app-nativeapp.md#create-an-app) or,
|
||||
- The app was not authorized in the tenant, see [Application consent](exposed-apis-create-app-webapp.md#application-consent).
|
||||
~~~
|
||||
|
||||
|
||||
## Related topic
|
||||
- [Microsoft Defender ATP APIs](apis-intro.md)
|
||||
- [Microsoft Defender ATP APIs introduction](apis-intro.md)
|
||||
- [Advanced Hunting from Portal](advanced-hunting-query-language.md)
|
||||
- [Advanced Hunting using PowerShell](run-advanced-query-sample-powershell.md)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user