Экспорт оценки инвентаризации программного обеспечения на устройство
Область применения:
- Microsoft Defender для конечной точки (план 1)
- Microsoft Defender для конечной точки (план 2)
- Управление уязвимостями в Microsoft Defender
- Microsoft Defender XDR
Хотите попробовать Microsoft Defender для конечной точки? Зарегистрироваться для бесплатной пробной версии.
Этот API возвращает все данные для установленного программного обеспечения с общим перечислением платформ (CPE) на основе каждого устройства.
Различные вызовы API получают данные разных типов. Так как объем данных может быть большим, их можно извлечь двумя способами:
Экспорт ответа JSON оценки инвентаризации программного обеспечения API извлекает все данные в организации в виде ответов JSON. Этот метод лучше всего подходит для небольших организаций с менее чем 100 тыс. устройств. Ответ разбиется на страницы, поэтому для получения следующих результатов можно использовать поле @odata.nextLink из ответа.
Экспорт оценки инвентаризации программного обеспечения с помощью файлов Это решение API позволяет быстрее и надежнее извлекать большие объемы данных. Поэтому рекомендуется использовать его для крупных организаций с более чем 100 тыс. устройств. Этот API извлекает все данные в вашей организации в виде файлов скачивания. Ответ содержит URL-адреса для скачивания всех данных из службы хранилища Azure. Этот API позволяет скачать все данные из службы хранилища Azure следующим образом:
- Вызовите API, чтобы получить список URL-адресов для скачивания со всеми данными организации.
- Скачайте все файлы с помощью URL-адресов для скачивания и обработайте данные по мере того, как вам нравится.
Собираемые данные (с помощью ответа JSON или файлов) — это текущий snapshot текущего состояния. Он не содержит исторических данных. Для сбора исторических данных клиенты должны сохранять данные в собственных хранилищах данных.
Примечание.
Если не указано иное, все перечисленные методы оценки экспорта полностью экспортируются и по устройству (также называются по устройству).
1. Экспорт оценки инвентаризации программного обеспечения (ответ JSON)
1.1 Описание метода API
Этот ответ API содержит все данные установленного программного обеспечения, имеющего общее перечисление платформы (CPE) для каждого устройства. Возвращает таблицу с записью для каждого уникального сочетания DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.
1.1.1. Ограничения
- Максимальный размер страницы — 200 000.
- Ограничения скорости для этого API: 30 вызовов в минуту и 1000 вызовов в час.
1.2 Разрешения
Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая выбор разрешений, см. в статье Использование API Microsoft Defender для конечной точки.
| Тип разрешения | Разрешение | Отображаемое имя разрешения |
|---|---|---|
| Приложение | Software.Read.All | "Чтение сведений о программном обеспечении для управления угрозами и уязвимостями" |
| Делегированные (рабочая или учебная учетная запись) | Software.Read | "Чтение сведений о программном обеспечении для управления угрозами и уязвимостями" |
URL-адрес 1.3
GET /api/machines/SoftwareInventoryByMachine
1.4 Параметры
- pageSize (по умолчанию = 50 000): количество результатов в ответе.
- $top: число возвращаемых результатов (не возвращает @odata.nextLink и, следовательно, не извлекет все данные).
1.5. Свойства
Примечание.
- Каждая запись составляет примерно 0,5 КБ данных. Это следует учитывать при выборе правильного параметра pageSize.
- Свойства, определенные в следующей таблице, перечислены в алфавитном порядке по идентификатору свойства. При запуске этого API результирующие выходные данные не обязательно будут возвращаться в том же порядке, что и в этой таблице.
- В ответе могут быть возвращены некоторые дополнительные столбцы. Эти столбцы являются временными и могут быть удалены. Используйте только задокументированные столбцы.
| Свойство (идентификатор) | Тип данных | Описание | Пример возвращаемого значения |
|---|---|---|---|
| DeviceId | string | Уникальный идентификатор устройства в службе. | 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1 |
| DeviceName | string | Полное доменное имя (FQDN) устройства. | johnlaptop.europe.contoso.com |
| DiskPaths | Array[string] | Диск свидетельствует о том, что продукт установлен на устройстве. | ["C:\Program Files (x86)\Microsoft\Silverlight\Application\silverlight.exe"] |
| EndOfSupportDate | string | Дата окончания поддержки этого программного обеспечения. | 2020-12-30 |
| EndOfSupportStatus | string | Состояние окончания поддержки. Может содержать следующие возможные значения: Нет, Версия EOS, Предстоящая версия EOS, Программное обеспечение EOS, Предстоящее программное обеспечение EOS. | Предстоящие EOS |
| NumberOfWeaknesses | int | Количество слабых мест в этом программном обеспечении на этом устройстве | 3 |
| OSPlatform | string | Платформа операционной системы, работающей на устройстве. Это конкретные операционные системы с вариациями в пределах одного семейства, например Windows 10 и Windows 11. Дополнительные сведения см. в разделе Управление уязвимостями Microsoft Defender поддерживаемых операционных систем и платформ. | Windows10 и Windows 11 |
| RbacGroupName | string | Группа управления доступом на основе ролей (RBAC). Если это устройство не назначено ни одной группе RBAC, значение будет "Не назначено". Если в организации нет групп RBAC, значение будет "Нет". | Серверы |
| RegistryPaths | Array[string] | Реестр свидетельствует о том, что продукт установлен на устройстве. | ["HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Microsoft Silverlight"] |
| SoftwareFirstSeenTimestamp | string | Впервые это программное обеспечение было замечено на устройстве. | 2019-04-07 02:06:47 |
| SoftwareName | string | Имя программного продукта. | Silverlight |
| SoftwareVendor | string | Имя поставщика программного обеспечения. | microsoft |
| SoftwareVersion | string | Номер версии программного продукта. | 81.0.4044.138 |
1.6 Примеры
1.6.1. Пример запроса
GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pageSize=5 &sinceTime=2021-05-19T18%3A35%3A49.924Z
1.6.2. Пример ответа
{
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Collection(contoso.windowsDefenderATP.api.AssetSoftware)",
"value": [
{
"deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
"rbacGroupName": "hhh",
"deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178eadfa25e8de9acfa346.corp.contoso.com",
"osPlatform": "Windows10" "Windows11",
"softwareVendor": "microsoft",
"softwareName": "windows_10" "Windows_11",
"softwareVersion": "10.0.17763.1637",
"numberOfWeaknesses": 58,
"diskPaths": [],
"registryPaths": [],
"softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
"endOfSupportStatus": "Upcoming EOS Version",
"endOfSupportDate": "2021-05-11T00:00:00+00:00"
},
{
"deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
"rbacGroupName": "hhh",
"deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178eadfa25e8de9acfa346.corp.contoso.com",
"osPlatform": "Windows10" "Windows11",
"softwareVendor": "microsoft",
"softwareName": ".net_framework",
"softwareVersion": "4.0.0.0",
"numberOfWeaknesses": 0,
"diskPaths": [],
"registryPaths": [
"SOFTWARE\\Microsoft\\NET Framework Setup\\NDP\\v4.0\\Client\\Install"
],
"softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
"endOfSupportStatus": "None",
"endOfSupportDate": null
},
{
"deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
"rbacGroupName": "hhh",
"deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eed80d086e79bdfa178eadfa25e8de9acfa346.corp.contoso.com",
"osPlatform": "Windows10" "Windows11",
"softwareVendor": "microsoft",
"softwareName": "system_center_2012_endpoint_protection",
"softwareVersion": "4.7.214.0",
"numberOfWeaknesses": 0,
"diskPaths": [],
"registryPaths": [
"HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Microsoft Security Client"
],
"softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
"endOfSupportStatus": "None",
"endOfSupportDate": null
},
{
"deviceId": "00044f68765ddaf71234bde6bd733d6a9c59ad4",
"rbacGroupName": "hhh",
"deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178aedfa25e8be9acfa346.corp.contoso.com",
"osPlatform": "Windows10" "Windows11",
"softwareVendor": "microsoft",
"softwareName": "configuration_manager",
"softwareVersion": "5.0.8634.1000",
"numberOfWeaknesses": 0,
"diskPaths": [],
"registryPaths": [
"HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{B7D3A842-E826-4542-B39B-1D883264B279}"
],
"softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
"endOfSupportStatus": "None",
"endOfSupportDate": null
},
{
"deviceId": "00044f38765bbaf712342dbe6db733b6a9c59ab4",
"rbacGroupName": "hhh",
"deviceName": "ComputerPII_18993b45912eeb224b2de2f5ea3142726e63f16a.DomainPII_21eeb80d086e79bdfa178eadfa25e8be9acfa346.corp.contoso.com",
"osPlatform": "Windows10" "Windows11",
"softwareVendor": "microsoft",
"softwareName": "system_center_2012_endpoint_protection",
"softwareVersion": "4.10.209.0",
"numberOfWeaknesses": 0,
"diskPaths": [],
"registryPaths": [
"HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Microsoft Security Client"
],
"softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
"endOfSupportStatus": "None",
"endOfSupportDate": null
}
],
"@odata.nextLink": "https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pagesize=5&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMS0wMS0yNS8wMjAwLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}
Примечание.
Сведения, возвращаемые этим API, а также сведения, возвращенные API оценки инвентаризации программного обеспечения, отличного от кода продукта , для программного обеспечения, у которых нет CPE, позволяют в полной мере видеть программное обеспечение, установленное в вашей организации, и устройства, на которых оно установлено.
2. Экспорт оценки инвентаризации программного обеспечения (с помощью файлов)
2.1. Описание метода API
Этот ответ API содержит все данные установленного программного обеспечения для каждого устройства. Возвращает таблицу с записью для каждого уникального сочетания DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.
2.1.1. Ограничения
Ограничения скорости для этого API : 5 вызовов в минуту и 20 вызовов в час.
2.2 Разрешения
Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая выбор разрешений, см. в статье Использование API Microsoft Defender для конечной точки.
| Тип разрешения | Разрешение | Отображаемое имя разрешения |
|---|---|---|
| Приложение | Software.Read.All | "Чтение сведений о программном обеспечении для управления угрозами и уязвимостями" |
| Делегированные (рабочая или учебная учетная запись) | Software.Read | "Чтение сведений о программном обеспечении для управления угрозами и уязвимостями" |
URL-адрес 2.3
GET /api/machines/SoftwareInventoryExport
Параметры
- sasValidHours: количество часов, в течение которых будут действовать URL-адреса скачивания (максимум 24 часа).
2.5. Свойства
Примечание.
- Файлы сжаты gzip & в формате JSON с несколькими строками.
- URL-адреса загрузки действительны только в течение 3 часов. В противном случае можно использовать параметр .
- Для максимальной скорости загрузки данных можно убедиться, что вы скачиваются из того же региона Azure, в котором находятся данные.
| Свойство (идентификатор) | Тип данных | Описание | Пример возвращаемого значения |
|---|---|---|---|
| Экспорт файлов | array[string] | Список URL-адресов для скачивания файлов, содержащих текущий snapshot организации | "[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"] |
| GeneratedTime | string | Время создания экспорта. | 2021-05-20T08:00:00Z |
2.6 Примеры
2.6.1. Пример запроса
GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryExport
2.6.2. Пример ответа
{
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
"exportFiles": [
"https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00393-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
"https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
"https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c001.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=..."
],
"generatedTime": "2021-01-11T11:01:00Z"
}
См. также
- Экспорт методов и свойств оценки на устройство
- Экспорт оценки безопасной конфигурации на устройство
- Экспорт оценки уязвимостей программного обеспечения для каждого устройства
- Экспорт оценки инвентаризации программного обеспечения без кода продукта
Другие связанные
Совет
Хотите узнать больше? Engage с сообществом Microsoft Security в нашем техническом сообществе: Microsoft Defender для конечной точки Техническое сообщество.
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по