Получение журнала сканирования по определению

Статья
05/03/2024

Область применения:

Хотите попробовать Microsoft Defender для конечной точки? Зарегистрироваться для бесплатной пробной версии.

Хотите воспользоваться управлением уязвимостями в Microsoft Defender? Узнайте, как зарегистрироваться для получения бесплатной пробной версии.

Важно!

Некоторые сведения относятся к предварительно выпущенному продукту, который может быть существенно изменен перед выпуском. Корпорация Майкрософт не дает явных или подразумеваемых гарантий относительно предоставленных здесь сведений.

Примечание.

Если вы являетесь клиентом для государственных организаций США, используйте URI, перечисленные в Microsoft Defender для конечной точки для клиентов государственных организаций США.

Совет

Для повышения производительности можно использовать сервер ближе к географическому расположению:

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

Описание API

Извлекает список журнала сканирования по определениям.

Поддерживает операции OData.
Поддерживаемые операторы OData:
- $top с максимальным значением 4096. Возвращает количество сеансов, указанное в запросе.
- $skip со значением по умолчанию 0. Пропускает количество сеансов, указанное в запросе.

Пример использования операций OData см. в разделе пример $top запроса.

Ограничения

Ограничения скорости для этого API : 100 вызовов в минуту и 1500 вызовов в час.

Разрешения

Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая выбор разрешений, см. в статье Использование API Microsoft Defender для конечных точек.

Тип разрешения	Разрешение	Отображаемое имя разрешения
Приложение	Machine.Read.All	Чтение всех сведений о проверке.
Делегированные (рабочая или учебная учетная запись)	Machine.Read.All	Чтение всех сведений о проверке.

Примечание.

При получении маркера с использованием учетных данных пользователя:

Для просмотра данных пользователю требуется по крайней мере следующее разрешение роли: "ViewData" или "TvmViewData" (дополнительные сведения см. в разделе Создание ролей и управление ими ).

HTTP-запрос

POST api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId

Заголовки запросов

Имя	Тип	Описание
Авторизация	String	Bearer {token}. Обязательное поле.
Content-Type	string	application/json. Обязательное поле.

Текст запроса

В тексте запроса укажите объект JSON со следующими параметрами:

Параметр	Тип	Описание
ScanDefinitionIds	String	Идентификатор сканирования. Обязательный.

Отклик

В случае успешного выполнения этот метод возвращает код ответа 200 — ОК со списком журнала сканирования по определению.

Пример запроса

Ниже приведен пример запроса.

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"]
}

Пример ответа

{
"@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"
    },
   ]
}

Пример запроса $top

Ниже приведен пример запроса, который возвращает только 1 сеанс.

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId?$top=1

Пример ответа $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"
    },
 ]
}

Поделиться через