Экспорт методов и свойств API сведений о работоспособности антивирусной программы
Область применения:
- Microsoft Defender для конечной точки
- Microsoft Defender для конечной точки (план 2)
- Microsoft Defender XDR
Хотите попробовать 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 сведений о работоспособности антивирусной программы
Возвращает список сведений о работоспособности устройства антивирусной программы в Microsoft Defender. Этот API имеет различные вызовы API (методы) для получения разных типов данных. Так как объем данных может быть большим, их можно извлечь двумя способами:
Ответ JSON API извлекает все данные в организации в виде ответов JSON. Этот метод лучше всего подходит для небольших организаций с менее чем 100 тыс. устройств. Ответ разбиется на страницы, поэтому для получения следующих результатов можно использовать поле @odata.nextLink из ответа.
через файлы Это решение API позволяет быстрее и надежнее извлекать большие объемы данных. Поэтому рекомендуется использовать его для крупных организаций с более чем 100 тыс. устройств. Этот API извлекает все данные в вашей организации в виде файлов скачивания. Ответ содержит URL-адреса для скачивания всех данных из службы хранилища Azure. Этот API позволяет скачать все данные из службы хранилища Azure следующим образом:
- Вызовите API, чтобы получить список URL-адресов для скачивания со всеми данными организации.
- Скачайте все файлы с помощью URL-адресов для скачивания и обработайте данные по мере того, как вам нравится.
Данные, собираемые с помощью ответа JSON или с помощью файлов, являются текущим моментальным снимком текущего состояния. Он не содержит исторических данных. Для сбора исторических данных клиенты должны сохранять данные в собственных хранилищах данных.
Важно!
Чтобы Windows Server 2012 R2 и Windows Server 2016 отображались в отчетах о работоспособности устройств, эти устройства должны быть подключены с помощью современного унифицированного пакета решения. Дополнительные сведения см. в статье Новые функции в современном унифицированном решении для Windows Server 2012 R2 и 2016.
Сведения об использовании средства отчетов о работоспособности устройств и соответствии антивирусной программы на портале Microsoft Defender см . в статье Отчет о работоспособности устройств и антивирусной программе в Microsoft Defender для конечной точки.
1.1. Экспорт методов API сведений о работоспособности антивирусной программы
| Метод | Тип данных | Описание |
|---|---|---|
| (ответ JSON) | Работоспособности антивирусной программы в Microsoft Defender для каждой коллекции устройств. См . статью 1.2. Экспорт свойств API сведений о работоспособности антивирусной программы устройства (ответ JSON) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId и ConfigurationId. API извлекает все данные в организации в виде ответов JSON. Этот метод лучше всего подходит для небольших организаций с менее чем 100 тыс. устройств. Ответ разбиется на страницы, поэтому вы можете использовать @odata.nextLink поле из ответа для получения следующих результатов. |
| (через файлы) | Работоспособности антивирусной программы в Microsoft Defender для каждой коллекции устройств. См . статью 1.3. Экспорт свойств API сведений о работоспособности антивирусной программы устройства (с помощью файлов) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId и ConfigurationId. Это решение API позволяет быстрее и надежнее извлекать большие объемы данных. Поэтому рекомендуется использовать его для крупных организаций с более чем 100 тыс. устройств. Этот API извлекает все данные в вашей организации в виде файлов скачивания. Ответ содержит URL-адреса для скачивания всех данных из службы хранилища Azure. Этот API позволяет скачать все данные из службы хранилища Azure следующим образом:
|
1.2. Ограничения
- Максимальный размер страницы: 200 000
- Ограничения скорости для этого API: 30 вызовов в минуту и 1000 вызовов в час
1.3. Экспорт свойств API сведений о работоспособности антивирусной программы (ответ JSON)
Примечание.
- Свойства, определенные в следующей таблице, перечислены в алфавитном порядке по идентификатору свойства. При запуске этого API результирующие выходные данные не обязательно будут возвращаться в том же порядке, что и в этой таблице.
- Обратите внимание, что rbacgroupname и Id не поддерживают операторы фильтра.
- В ответе могут быть возвращены некоторые дополнительные столбцы. Эти столбцы могут быть временными и могут быть удалены; используйте только задокументированные столбцы.
| Свойство (идентификатор) | Тип данных | Описание | Пример возвращаемого значения |
|---|---|---|---|
| avEngineUpdateTime | DateTimeOffset | Дата последнего обновления обработчика AV на устройстве | "2022-08-04T12:44:02Z" |
| avEngineVersion | String | Версия антивирусного ядра | "1.1.19400.3" |
| avIsEngineUpToDate | String | Актуальное состояние обработчика AV | "True", "False", "Unknown" |
| avIsPlatformUpToDate | String | Актуальное состояние платформы AV | "True", "False", "Unknown" |
| avIsSignatureUpToDate | String | Актуальное состояние подписи av | "True", "False", "Unknown" |
| avMode | String | Режим антивирусной программы. | Каждый режим будет иметь строковое типизированное целое число в диапазоне от 0 до 5. Ознакомьтесь с приведенным ниже сопоставлением, чтобы увидеть значение его значения:
|
| avPlatformUpdateTime | DateTimeOffset | Дата последнего обновления платформы AV на устройстве | "2022-08-04T12:44:02Z" |
| avPlatformVersion | String | Версия антивирусной платформы | "4.18.2203.5" |
| avSignaturePublishTime | DateTimeOffset | Дата выпуска сборки аналитики безопасности AV | "2022-08-04T12:44:02Z" |
| avSignatureUpdateTime | DateTimeOffset | Дата последнего обновления аналитики безопасности AV на устройстве | "2022-08-04T12:44:02Z" |
| avSignatureVersion | String | Версия антивирусной аналитики безопасности | "1.371.1323.0" |
| computerDnsName | String | DNS-имя | SampleDns |
| dataRefreshTimestamp | DateTimeOffset | Дата и время обновления данных для этого отчета | "2022-08-04T12:44:02Z" |
| fullScanError | String | Коды ошибок при полной проверке | "0x80508023" |
| fullScanResult | String | Полный результат сканирования этого устройства | "Завершено" "Отменено" "Сбой" |
| fullScanTime | DateTimeOffset | Дата завершения полной проверки | "2022-08-04T12:44:02Z" |
| id | String | Идентификатор GUID компьютера | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
| lastSeenTime | DateTimeOffset | Последнее просмотренное время даты и времени на этом компьютере | "2022-08-04T12:44:02Z" |
| machineId | String | Идентификатор GUID компьютера | "30a8fa2826abf24d24379b23f8a44d471f00feab" |
| osKind | String | Тип операционной системы | "windows", "mac", "linux" |
| osPlatform | String | Имя основной версии операционной системы | Windows 10, macOs |
| osVersion | String | Версия операционной системы | 10.0.18363.1440, 12.4.0.0 |
| quickScanError | String | Коды ошибок при быстрой проверке | "0x80508023" |
| quickScanResult | String | Результат быстрой проверки этого устройства | "Завершено" "Отменено" "Сбой" |
| quickScanTime | DateTimeOffset | Дата завершения быстрой проверки | "2022-08-04T12:44:02Z" |
| rbacGroupId | Long | Идентификатор группы устройств, к которому принадлежит этот компьютер | 712 |
| rbacGroupName | String | Имя группы устройств, к которой принадлежит этот компьютер | SampleGroup |
1.4. Экспорт свойств API сведений о работоспособности антивирусной программы устройства (с помощью файлов)
Важно!
Сведения в этом разделе относятся к предварительно выпущенной продукции, которая может быть существенно изменена до его коммерческого выпуска. Корпорация Майкрософт не дает никаких гарантий, явных или подразумеваемых, относительно предоставленных здесь сведений.
Примечание.
- Файлы сжаты gzip & в многострочных форматах JSON.
- URL-адреса для скачивания действительны только в течение 3 часов; В противном случае можно использовать параметр .
- Для максимальной скорости загрузки данных можно убедиться, что вы скачиваются из того же региона Azure, в котором находятся данные.
- Каждая запись составляет примерно 1 КБ данных. Это следует учитывать при выборе правильного параметра pageSize.
- В ответе могут быть возвращены некоторые дополнительные столбцы. Эти столбцы являются временными и могут быть удалены. Используйте только задокументированные столбцы.
| Свойство (идентификатор) | Тип данных | Описание | Пример возвращаемого значения |
|---|---|---|---|
| Экспорт файлов | array[string] | Список URL-адресов для скачивания файлов, содержащих текущий моментальный снимок организации. | ["https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"] |
| GeneratedTime | String | Время создания экспорта. | 2022-05-20T08:00:00Z |
Примечание.
В каждом из файлов экспорта можно найти свойство DeviceGatheredInfo, содержащее сведения об антивирусной программе. Каждый из его атрибутов может предоставить сведения о работоспособности устройства и его состоянии.
См. также
Экспорт отчета о состоянии антивирусной программы устройства
Отчеты о работоспособности и соответствии устройств
Совет
Хотите узнать больше? Обратитесь к сообществу Майкрософт по безопасности в техническом сообществе Microsoft Defender для конечной точки Tech Community.