Экспорт методов и свойств оценки на устройство
Область применения:
- Microsoft Defender для конечной точки (план 1)
- Microsoft Defender для конечной точки (план 2)
- Управление уязвимостями в Microsoft Defender
- Microsoft Defender XDR
Хотите попробовать Microsoft Defender для конечной точки? Зарегистрироваться для бесплатной пробной версии.
Описание API
Предоставляет сведения о методах и свойствах API, которые извлекают данные управления уязвимостями для каждого устройства. Существуют различные вызовы API для получения разных типов данных. Как правило, каждый вызов API содержит необходимые данные для устройств в вашей организации.
Примечание.
Если не указано иное, все перечисленные методы оценки экспорта полностью экспортируются и по устройству (также называются по устройству).
API-интерфейсы оценки экспорта можно использовать для получения (экспорта) различных типов информации:
- 1. Экспорт оценки безопасных конфигураций
- 2. Экспорт оценки инвентаризации программного обеспечения
- 3. Экспорт оценки уязвимостей программного обеспечения
- 4. Экспорт инвентаризации программного обеспечения, отличного от кода продукта
Интерфейсы API, соответствующие типам экспортируемой информации, описаны в разделах 1, 2 и 3.
Каждый метод имеет разные вызовы API для получения данных разных типов. Так как объем данных может быть большим, их можно извлечь двумя способами:
Ответ JSON API извлекает все данные в организации в виде ответов JSON. Этот метод лучше всего подходит для небольших организаций с менее чем 100 тыс. устройств. Ответ разбиется на страницы, поэтому для получения следующих результатов можно использовать поле @odata.nextLink из ответа.
через файлы Это решение API позволяет быстрее и надежнее извлекать большие объемы данных. Поэтому рекомендуется использовать его для крупных организаций с более чем 100 тыс. устройств. Этот API извлекает все данные в вашей организации в виде файлов скачивания. Ответ содержит URL-адреса для скачивания всех данных из службы хранилища Azure. Этот API позволяет скачать все данные из службы хранилища Azure следующим образом:
- Вызовите API, чтобы получить список URL-адресов для скачивания со всеми данными организации.
- Скачайте все файлы с помощью URL-адресов для скачивания и обработайте данные по мере того, как вам нравится.
Данные, собираемые с помощью ответа JSON или с помощью файлов, являются текущим snapshot текущего состояния. Он не содержит исторических данных. Для сбора исторических данных клиенты должны сохранять данные в собственных хранилищах данных.
1. Экспорт оценки безопасных конфигураций
Возвращает все конфигурации и их состояние для каждого устройства.
1.1 Методы
| Метод | Тип данных | Описание |
|---|---|---|
| Защита конфигурации по коллекции устройств. См .: Свойства версии 1.2 (ответ JSON) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId и ConfigurationId. API извлекает все данные в организации в виде ответов JSON. Этот метод лучше всего подходит для небольших организаций с менее чем 100 тыс. устройств. Ответ разбиется на страницы, поэтому вы можете использовать @odata.nextLink поле из ответа для получения следующих результатов. | |
| Защита конфигурации по коллекции устройств. См .: 1.3 Свойства (через файлы) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId и ConfigurationId. Это решение API позволяет быстрее и надежнее извлекать большие объемы данных. Поэтому рекомендуется использовать его для крупных организаций с более чем 100 тыс. устройств. Этот API извлекает все данные в вашей организации в виде файлов скачивания. Ответ содержит URL-адреса для скачивания всех данных из службы хранилища Azure. Этот API позволяет скачать все данные из службы хранилища Azure следующим образом:
|
1.2. Свойства (ответ JSON)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| configurationCategory | String | Категория или группирование, к которым относится конфигурация: приложение, ОС, сеть, учетные записи, элементы управления безопасностью. |
| configurationId | String | Уникальный идентификатор для определенной конфигурации. |
| configurationImpact | String | Оценка влияния конфигурации на общую оценку конфигурации (1–10). |
| configurationName | String | Отображаемое имя конфигурации. |
| configurationSubcategory | String | Подкатегория или подгруппа, к которой относится настройка. Во многих случаях — определенные возможности или функции. |
| deviceId | String | Уникальный идентификатор устройства в службе. |
| deviceName | String | Полное доменное имя (FQDN) устройства. |
| isApplicable | Логический | Указывает, применима ли конфигурация или политика. |
| isCompliant | Логический | Указывает, правильно ли настроена конфигурация или политика. |
| isExpectedUserImpact | Логический | Указывает, будет ли затронут пользователь, если будет применена конфигурация. |
| osPlatform | String | Платформа операционной системы, работающей на устройстве. Конкретные операционные системы с вариациями в пределах одного семейства, например Windows 10 и Windows 11. Дополнительные сведения см. в разделе Поддерживаемые операционные системы, платформы и возможности . |
| osVersion | String | Определенная версия операционной системы, работающей на устройстве. |
| rbacGroupName | String | Группа управления доступом на основе ролей (RBAC). Если устройство не назначено ни одной группе RBAC, значение будет "Не назначено". Если в организации нет групп RBAC, значение будет "Нет". |
| rbacGroupId | String | Идентификатор группы управления доступом на основе ролей (RBAC). |
| recommendationReference | String | Ссылка на идентификатор рекомендации, связанный с программным обеспечением. |
| метка времени | String | В последний раз конфигурация была замечена на устройстве. |
1.3. Свойства (через файлы)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| Экспорт файлов | array[string] | Список URL-адресов для скачивания файлов, содержащих текущие snapshot организации. |
| GeneratedTime | String | Время создания экспорта. |
2. Экспорт оценки инвентаризации программного обеспечения
Возвращает все установленное программное обеспечение и сведения о нем на каждом устройстве.
2.1 Методы
| Метод | Тип данных | Описание |
|---|---|---|
| Экспорт оценки инвентаризации программного обеспечения (ответ JSON) | Инвентаризация программного обеспечения по коллекции устройств. См . статью Свойства версии 2.2 (ответ JSON) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. API извлекает все данные в организации в виде ответов JSON. Этот метод лучше всего подходит для небольших организаций с менее чем 100 тыс. устройств. Ответ разбиется на страницы, поэтому вы можете использовать @odata.nextLink поле из ответа для получения следующих результатов. |
| Экспорт оценки инвентаризации программного обеспечения (с помощью файлов) | Инвентаризация программного обеспечения по файлам устройств. См .: 2.3 Свойства (через файлы) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. Это решение API позволяет быстрее и надежнее извлекать большие объемы данных. Поэтому рекомендуется использовать его для крупных организаций с более чем 100 тыс. устройств. Этот API извлекает все данные в вашей организации в виде файлов скачивания. Ответ содержит URL-адреса для скачивания всех данных из службы хранилища Azure. Этот API позволяет скачивать данные из службы хранилища Azure следующим образом:
|
2.2. Свойства (ответ JSON)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| DeviceId | String | Уникальный идентификатор устройства в службе. |
| DeviceName | String | Полное доменное имя (FQDN) устройства. |
| DiskPaths | Array[string] | Диск свидетельствует о том, что продукт установлен на устройстве. |
| EndOfSupportDate | String | Дата окончания поддержки этого программного обеспечения. |
| EndOfSupportStatus | String | Состояние окончания поддержки. Может содержать следующие возможные значения: Нет, Версия EOS, Предстоящая версия EOS, Программное обеспечение EOS, Предстоящее программное обеспечение EOS. |
| NumberOfWeaknesses | Целое | Количество слабых мест в этом программном обеспечении на этом устройстве. |
| OSPlatform | String | Платформа операционной системы, работающей на устройстве; конкретные операционные системы с вариациями в пределах одного семейства, например Windows 10 и Windows 11. Дополнительные сведения см. в разделе Поддерживаемые операционные системы, платформы и возможности . |
| RbacGroupName | String | Группа управления доступом на основе ролей (RBAC). Если это устройство не назначено ни одной группе RBAC, значение будет "Не назначено". Если в организации нет групп RBAC, значение будет "Нет". |
| rbacGroupId | String | Идентификатор группы управления доступом на основе ролей (RBAC). |
| RegistryPaths | Array[string] | Реестр свидетельствует о том, что продукт установлен на устройстве. |
| SoftwareFirstSeenTimestamp | String | Впервые это программное обеспечение было замечено на устройстве. |
| SoftwareName | String | Имя программного продукта. |
| SoftwareVendor | String | Имя поставщика программного обеспечения. |
| SoftwareVersion | String | Номер версии программного продукта. |
2.3. Свойства (через файлы)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| Экспорт файлов | array[string] | Список URL-адресов для скачивания файлов, содержащих текущие snapshot организации. |
| GeneratedTime | String | Время создания экспорта. |
3. Экспорт оценки уязвимостей программного обеспечения
Возвращает все известные уязвимости на устройстве и их сведения для всех устройств.
3.1 Методы
| Метод | Тип данных | Описание |
|---|---|---|
| Коллекция исследований См . статью Свойства версии 3.2 (ответ JSON) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId. API извлекает все данные в организации в виде ответов JSON. Этот метод лучше всего подходит для небольших организаций с менее чем 100 тыс. устройств. Ответ разбиется на страницы, поэтому вы можете использовать @odata.nextLink поле из ответа для получения следующих результатов. | |
| Сущность исследования См .: Свойства 3.3 (через файлы) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId. Это решение API позволяет быстрее и надежнее извлекать большие объемы данных. Поэтому рекомендуется использовать его для крупных организаций с более чем 100 тыс. устройств. Этот API извлекает все данные в вашей организации в виде файлов скачивания. Ответ содержит URL-адреса для скачивания всех данных из службы хранилища Azure. Этот API позволяет скачать все данные из службы хранилища Azure следующим образом:
|
|
| Коллекция исследований См . раздел 3.4 Properties Delta export (ответ JSON) | Возвращает таблицу с записью для каждого уникального сочетания: DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId и EventTimestamp. API извлекает данные в организации в виде ответов JSON. Ответ разбиется на страницы, поэтому вы можете использовать @odata.nextLink поле из ответа для получения следующих результатов. Полная оценка уязвимостей программного обеспечения (ответ JSON) используется для получения полного snapshot оценки уязвимостей программного обеспечения вашей организации по устройствам. Однако вызов API разностного экспорта используется для получения только изменений, произошедших между выбранной датой и текущей датой (вызов API delta). Вместо того, чтобы каждый раз получать полный экспорт с большим объемом данных, вы будете получать только конкретную информацию о новых, исправленных и обновленных уязвимостях. Вызов API разностного экспорта также можно использовать для вычисления различных ключевых показателей эффективности, таких как "сколько уязвимостей было исправлено?" или "сколько новых уязвимостей было добавлено в мою организацию?" Так как вызов API разностного экспорта для уязвимостей программного обеспечения возвращает данные только для целевого диапазона дат, он не считается полным экспортом. |
3.2. Свойства (ответ JSON)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| CveId | String | Уникальный идентификатор, присвоенный уязвимости безопасности в системе Common Vulnerabilityies and Exposures (CVE). |
| CvssScore | String | Оценка CVSS для CVE. |
| DeviceId | String | Уникальный идентификатор устройства в службе. |
| DeviceName | String | Полное доменное имя (FQDN) устройства. |
| DiskPaths | Array[string] | Диск свидетельствует о том, что продукт установлен на устройстве. |
| ExploitabilityLevel | String | Уровень эксплуатируемости этой уязвимости (NoExploit, ExploitIsPublic, ExploitIsVerified, ExploitIsInKit) |
| FirstSeenTimestamp | String | При первом обнаружении CVE этого продукта на устройстве. |
| Id | String | Уникальный идентификатор записи. |
| LastSeenTimestamp | String | В последний раз cve был замечен на устройстве. |
| OSPlatform | String | Платформа операционной системы, работающей на устройстве; конкретные операционные системы с вариациями в пределах одного семейства, например Windows 10 и Windows 11. Дополнительные сведения см. в разделе Поддерживаемые операционные системы, платформы и возможности . |
| RbacGroupName | String | Группа управления доступом на основе ролей (RBAC). Если это устройство не назначено ни одной группе RBAC, значение будет "Не назначено". Если в организации нет групп RBAC, значение будет "Нет". |
| rbacGroupId | String | Идентификатор группы управления доступом на основе ролей (RBAC). |
| RecommendationReference | String | Ссылка на идентификатор рекомендации, связанный с этим программным обеспечением. |
| RecommendedSecurityUpdate | String | Имя или описание обновления для системы безопасности, предоставленного поставщиком программного обеспечения для устранения уязвимости. |
| RecommendedSecurityUpdateId | String | Идентификатор применимых обновлений для системы безопасности или идентификатор соответствующих руководств или статей база знаний (KB). |
| Пути к реестру | Array[string] | Реестр свидетельствует о том, что продукт установлен на устройстве. |
| SecurityUpdateAvailable | Логический | Указывает, доступно ли обновление для системы безопасности для программного обеспечения. |
| SoftwareName | String | Имя программного продукта. |
| SoftwareVendor | String | Имя поставщика программного обеспечения. |
| SoftwareVersion | String | Номер версии программного продукта. |
| VulnerabilitySeverityLevel | String | Уровень серьезности, назначенный уязвимости безопасности на основе оценки CVSS. |
3.3 Свойства (через файлы)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| Экспорт файлов | array[string] | Список URL-адресов для скачивания файлов, содержащих текущие snapshot организации. |
| GeneratedTime | String | Время создания экспорта. |
3.4. Свойства (ответ JSON разностного экспорта)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| CveId | String | Уникальный идентификатор, присвоенный уязвимости безопасности в системе Common Vulnerabilityies and Exposures (CVE). |
| CvssScore | String | Оценка CVSS для CVE. |
| DeviceId | String | Уникальный идентификатор устройства в службе. |
| DeviceName | String | Полное доменное имя (FQDN) устройства. |
| DiskPaths | Array[string] | Диск свидетельствует о том, что продукт установлен на устройстве. |
| EventTimestamp | String | Время обнаружения разностного события. |
| ExploitabilityLevel | String | Уровень уязвимости для уязвимости (NoExploit, ExploitIsPublic, ExploitIsVerified, ExploitIsInKit) |
| FirstSeenTimestamp | String | При первом обнаружении CVE продукта на устройстве. |
| Id | String | Уникальный идентификатор записи. |
| LastSeenTimestamp | String | В последний раз cve был замечен на устройстве. |
| OSPlatform | String | Платформа операционной системы, работающей на устройстве; конкретные операционные системы с вариациями в пределах одного семейства, например Windows 10 и Windows 11. Дополнительные сведения см. в разделе Поддерживаемые операционные системы, платформы и возможности . |
| RbacGroupName | String | Группа управления доступом на основе ролей (RBAC). Если это устройство не назначено ни одной группе RBAC, значение будет "Не назначено". Если в организации нет групп RBAC, значение будет "Нет". |
| RecommendationReference | String | Ссылка на идентификатор рекомендации, связанный с этим программным обеспечением. |
| RecommendedSecurityUpdate | String | Имя или описание обновления для системы безопасности, предоставленного поставщиком программного обеспечения для устранения уязвимости. |
| RecommendedSecurityUpdateId | String | Идентификатор применимых обновлений для системы безопасности или идентификатор для соответствующих руководств или база знаний статей (KB) |
| RegistryPaths | Array[string] | Реестр свидетельствует о том, что продукт установлен на устройстве. |
| SoftwareName | String | Имя программного продукта. |
| SoftwareVendor | String | Имя поставщика программного обеспечения. |
| SoftwareVersion | String | Номер версии программного продукта. |
| Состояние | String | Новое (для новой уязвимости, появилась на устройстве). Исправлено (для уязвимости, которая больше не существует на устройстве, что означает, что она была исправлена). Обновлено (для уязвимости на измененном устройстве. Возможные изменения: оценка CVSS, уровень уязвимости, уровень серьезности, DiskPaths, RegistryPaths, RecommendedSecurityUpdate. |
| VulnerabilitySeverityLevel | String | Уровень серьезности, назначенный уязвимости безопасности на основе оценки CVSS. |
4. Экспорт инвентаризации программного обеспечения, отличного от кода продукта
Возвращает все установленное программное обеспечение, которое не имеет Common Platform Enumeration (CPE), и сведения об этом программном обеспечении на каждом устройстве.
4.1 Методы
| Метод | Тип данных | Описание |
|---|---|---|
| Экспорт оценки инвентаризации программного обеспечения, отличного от кода продукта (ответ JSON) | Инвентаризация программного обеспечения, отличного от кода продукта, по коллекции устройств. См . статью Свойства версии 4.2 (ответ JSON) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. API извлекает все данные в организации в виде ответов JSON. Этот метод лучше всего подходит для небольших организаций с менее чем 100 тыс. устройств. Ответ разбиется на страницы, поэтому вы можете использовать @odata.nextLink поле из ответа для получения следующих результатов. |
| Экспорт оценки инвентаризации программного обеспечения, отличного от кода продукта (с помощью файлов) | Инвентаризация программного обеспечения, отличного от кода продукта, по файлам устройств. См .: 4.3 Свойства (через файлы) | Возвращает таблицу с записью для каждого уникального сочетания DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. Это решение API позволяет быстрее и надежнее извлекать большие объемы данных. Поэтому рекомендуется использовать его для крупных организаций с более чем 100 тыс. устройств. Этот API извлекает все данные в вашей организации в виде файлов скачивания. Ответ содержит URL-адреса для скачивания всех данных из службы хранилища Azure. Этот API позволяет скачивать данные из службы хранилища Azure следующим образом:
|
4.2. Свойства (ответ JSON)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| 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 | Номер версии программного продукта. |
4.3. Свойства (через файлы)
| Свойство (идентификатор) | Тип данных | Описание |
|---|---|---|
| Экспорт файлов | array[string] | Список URL-адресов для скачивания файлов, содержащих текущие snapshot организации. |
| GeneratedTime | String | Время создания экспорта. |
См. также
- Экспорт оценки безопасной конфигурации на устройство
- Экспорт оценки инвентаризации программного обеспечения на устройство
- Экспорт оценки уязвимостей программного обеспечения для каждого устройства
- Экспорт оценки инвентаризации программного обеспечения без CPE на устройство
Другие связанные
Совет
Хотите узнать больше? Engage с сообществом Microsoft Security в нашем техническом сообществе: Microsoft Defender для конечной точки Техническое сообщество.