Экспорт оценки инвентаризации программного обеспечения, отличного от кода продукта, на устройство

  • Статья

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

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

Этот API возвращает все данные для установленного программного обеспечения, которое не имеет общей платформы перечисления (CPE), на основе каждого устройства. Сведения, возвращаемые этим API, а также сведения, возвращаемые API оценки инвентаризации программного обеспечения для программного обеспечения с CPE, позволяют в полной мере просматривать программное обеспечение, установленное в вашей организации, и устройства, на которых оно установлено.

Примечание.

Программные продукты без 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.

Ограничения

  • Максимальный размер страницы — 200 000.
  • Ограничения скорости для этого API: 30 вызовов в минуту и 1000 вызовов в час.

1.2 Разрешения

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

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

URL-адрес 1.3

GET /api/machines/SoftwareInventoryNoProductCodeByMachine

1.4 Параметры

  • pageSize (по умолчанию = 50 000): количество результатов в ответе.
  • $top: число возвращаемых результатов (не возвращает @odata.nextLink и, следовательно, не извлекет все данные).

1.5. Свойства

Примечание.

  • Каждая запись составляет примерно 0,5 КБ данных. Это следует учитывать при выборе правильного параметра pageSize.
  • Свойства, определенные в следующей таблице, перечислены в алфавитном порядке по идентификатору свойства. При запуске этого API результирующие выходные данные не обязательно будут возвращаться в том же порядке, что и в этой таблице.
  • В ответе могут быть возвращены некоторые дополнительные столбцы. Эти столбцы являются временными и могут быть удалены. Используйте только задокументированные столбцы.

Свойство (идентификатор) Тип данных Описание
DeviceId string Уникальный идентификатор устройства в службе.
DeviceName string Полное доменное имя (FQDN) устройства.
OSPlatform string Платформа операционной системы, работающей на устройстве. Это конкретные операционные системы с вариациями в пределах одного семейства, например Windows 10 и Windows 11. Дополнительные сведения см. в разделе Поддерживаемые операционные системы, платформы и возможности .
RbacGroupName string Группа управления доступом на основе ролей (RBAC). Если это устройство не назначено ни одной группе RBAC, значение будет "Не назначено". Если в организации нет групп RBAC, значение будет "Нет".
RbacGroupId string Идентификатор группы управления доступом на основе ролей (RBAC).
SoftwareLastSeenTimestamp string В последний раз это программное обеспечение было замечено на устройстве.
SoftwareName string Имя программного продукта.
SoftwareVendor string Имя поставщика программного обеспечения.
SoftwareVersion string Номер версии программного продукта.

1.6 Примеры

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

https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryNoProductCodeByMachine?pageSize=3  &sinceTime=2021-05-19

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

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetNonCpeSoftware)",
    "value": [
        {
           "deviceId": "1234512345123451234512345",
            "rbacGroupId": 11,
            "rbacGroupName": "London",
            "deviceName": "Device1",
            "osPlatform": "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "vs_communitymsi",
            "softwareVersion": "11.11.31111.1",
            "softwareLastSeenTimestamp": "2021-01-30 11:31:12.271"
        },
        {
            "deviceId": "232323232323232322323232323",
            "rbacGroupId": 23,
            "rbacGroupName": "Tokyo",
            "deviceName": "Device23",
            "osPlatform": "Windows10",
            "softwareVendor": "intel",
            "softwareName": "intel®_software_installer",
            "softwareVersion": "22.20.2.2",
            "softwareLastSeenTimestamp": "2022-05-30 15:35:12.271"
        },
        {
            "deviceId": "6565656565",
            "rbacGroupId": 65,
            "rbacGroupName": "Center",
            "deviceName": "Device56",
            "osPlatform": "Windows10",
            "softwareVendor": "Lob Apps",
            "softwareName": "Headtrax",
            "softwareVersion": "60.273.3",
            "softwareLastSeenTimestamp": "2022-05-05 15:35:12.271"
        },
    ],
        "@odata.nextLink": "https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryNoProductCodeByMachine?pagesize=3%20%20&sincetime=2021-05-19&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMi0wNS0zMC8xMTAxLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}

2. Экспорт оценки инвентаризации программного обеспечения, отличного от кода продукта (с помощью файлов)

2.1. Описание метода API

Этот ответ API содержит все данные установленного программного обеспечения, у которых нет общего перечисления платформы (CPE) на устройство. Возвращает таблицу с записью для каждого уникального сочетания 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/SoftwareInventoryNonCpeExport

Параметры

  • 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/SoftwareInventoryNonCpeExport

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

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00337-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=aHnmuOKlIvpR0PsdamYfmCCDZ1nhpuXBzK2%2FkJ9xTpg%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00338-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=0fQg%2Ft469x26KvPLmvctLl0g6DC38CNM3lXYi9dnFfo%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00339-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=P6HGHoLXXipMauBpLueoQVrwHL7qmvLoCjcij6ERx8o%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00340-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=VnpVct%2F8vdiIFTf2xXP9DF7ngWv1Zqew30q2jBPVghg%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00341-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=GY0zxMfEmr9v9fZBWYyKEtT2k%2F0ELQIlOP0ct%2B6SdGU%3D",
    ],
    "generatedTime": "2022-05-30T11:01:00Z"
}

См. также

Другие связанные

Совет

Хотите узнать больше? Engage с сообществом Microsoft Security в нашем техническом сообществе: Microsoft Defender для конечной точки Техническое сообщество.