Obtención del historial de exámenes por definición
Se aplica a:
- Microsoft Defender para punto de conexión Plan 1
- Microsoft Defender para punto de conexión
- Administración de vulnerabilidades de Microsoft Defender
- Microsoft Defender XDR
- Microsoft Defender para Empresas
¿Quiere experimentar Microsoft Defender para punto de conexión? Regístrese para obtener una prueba gratuita.
¿Quieres experimentar Administración de vulnerabilidades de Microsoft Defender? Obtenga información sobre cómo registrarse para obtener una evaluación gratuita.
Importante
Parte de la información contenida en este artículo se refiere a un producto preliminar que puede sufrir modificaciones sustanciales antes de su lanzamiento comercial. Microsoft no otorga garantías, expresas o implícitas, con respecto a la información que aquí se proporciona.
Nota:
Si es cliente del Gobierno de EE. UU., use los URI que aparecen en Microsoft Defender para punto de conexión para los clientes del Gobierno de EE. UU.
Sugerencia
Para mejorar el rendimiento, puede usar el servidor más cercano a la ubicación geográfica:
- us.api.security.microsoft.com
- eu.api.security.microsoft.com
- uk.api.security.microsoft.com
- au.api.security.microsoft.com
- swa.api.security.microsoft.com
- ina.api.security.microsoft.com
Descripción de la API
Recupera una lista del historial de examen por definiciones.
- Admite operaciones de OData.
- Operadores compatibles con OData:
- $top con un valor máximo de 4096. Devuelve el número de sesiones especificadas en la solicitud.
- $skip con un valor predeterminado de 0. Omite el número de sesiones especificadas en la solicitud.
Para obtener un ejemplo del uso de la operación de OData, vea ejemplo $top solicitud.
Limitaciones
- Las limitaciones de velocidad de esta API son 100 llamadas por minuto y 1500 llamadas por hora.
Permisos
Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, consulte Uso de api de Microsoft Defender para punto de conexión.
Tipo de permiso | Permiso | Nombre para mostrar del permiso |
---|---|---|
Aplicación | Machine.Read.All | Lea toda la información del examen. |
Delegado (cuenta profesional o educativa) | Machine.Read.All | Lea toda la información del examen. |
Al obtener un token con credenciales de usuario, para ver los datos, el usuario debe tener al menos el siguiente permiso de rol: ViewData
o TvmViewData
(Vea Crear y administrar roles).
Solicitud HTTP
POST api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId
Encabezados de solicitud
Nombre | Tipo | Descripción |
---|---|---|
Authorization | Cadena | {token} de portador. Necesario. |
Content-Type | string | application/json. Necesario. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione un objeto JSON con los parámetros siguientes:
Parámetro | Tipo | Descripción |
---|---|---|
ScanDefinitionIds | Cadena | Id. de examen. Obligatorio. |
Respuesta
Si se ejecuta correctamente, este método devuelve el código de respuesta 200 - Ok con una lista del historial de examen por definición.
Ejemplo de solicitud
Este es un ejemplo de la solicitud.
POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId
{
"ScanDefinitionIds": ["4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae", "60c4aa57-c573-4488-8d18-230914792a92", "c6220f67-2cad-4ba3-a2fa-7ded6384da56"]
}
Ejemplo de respuesta
{
"@odata.context": "https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId",
"value": [
{
"ScanDefinitionIds": "4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae",
"LastScanned": "2022-12-20T11:14:24.5561791Z",
"ScanStatus": "Partial Success",
"ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
},
{
"ScanDefinitionIds": "60c4aa57-c573-4488-8d18-230914792a92",
"LastScanned": "2022-11-17T15:13:24.5561791Z",
"ScanStatus": "Partial Success",
"ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
},
{
"ScanDefinitionIds": "c6220f67-2cad-4ba3-a2fa-7ded6384da56",
"LastScanned": "2022-11-10T18:15:24.5561791Z",
"ScanStatus": "Partial Success",
"ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
},
]
}
Ejemplo $top solicitud
Este es un ejemplo de una solicitud que devuelve solo una sesión.
POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId?$top=1
ejemplo de respuesta de $top
{
"@odata.context": "https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId",
"value": [
{
"ScanDefinitionIds": "4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae",
"LastScanned": "2022-12-20T11:14:24.5561791Z",
"ScanStatus": "Partial Success",
"ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
},
]
}