Exportar métodos e propriedades de avaliação por dispositivo
Aplica-se a:
- Plano 1 do Microsoft Defender para Ponto de Extremidade
- Plano 2 do Microsoft Defender para Ponto de Extremidade
- Gerenciamento de Vulnerabilidades do Microsoft Defender
- Microsoft Defender XDR
Deseja experimentar o Microsoft Defender para Ponto de Extremidade? Inscreva-se para uma avaliação gratuita.
Descrição da API
Fornece métodos e detalhes de propriedade sobre as APIs que puxam dados de gerenciamento de vulnerabilidades por dispositivo. Há diferentes chamadas de API para obter diferentes tipos de dados. Em geral, cada chamada de API contém os dados necessários para dispositivos em sua organização.
Observação
A menos que indicado o contrário, todos os métodos de avaliação de exportação listados são exportação completa e por dispositivo (também conhecido como por dispositivo).
Você pode usar as APIs de avaliação de exportação para recuperar (exportar) diferentes tipos de informações:
- 1. Exportar avaliação de configurações seguras
- 2. Exportar avaliação de inventário de software
- 3. Exportar avaliação de vulnerabilidades de software
- 4. Exportar avaliação de inventário de software de código não produto
As APIs que correspondem aos tipos de informações de exportação são descritas nas seções 1, 2 e 3.
Cada método tem chamadas de API diferentes para obter diferentes tipos de dados. Como a quantidade de dados pode ser grande, há duas maneiras de serem recuperados:
Resposta JSON A API puxa todos os dados em sua organização como respostas JSON. Esse método é melhor para organizações pequenas com menos de 100 K dispositivos. A resposta é paginada, para que você possa usar o campo @odata.nextLink da resposta para buscar os próximos resultados.
por meio de arquivos Essa solução de API permite extrair quantidades maiores de dados de forma mais rápida e confiável. Portanto, é recomendável para organizações grandes, com mais de 100 K dispositivos. Essa API puxa todos os dados em sua organização como arquivos de download. A resposta contém URLs para baixar todos os dados do Armazenamento do Azure. Essa API permite baixar todos os dados do Armazenamento do Azure da seguinte maneira:
- Chame a API para obter uma lista de URLs de download com todos os dados da organização.
- Baixe todos os arquivos usando as URLs de download e processe os dados como quiser.
Os dados coletados usando 'resposta JSON ou por meio de arquivos' são os instantâneo atuais do estado atual. Ele não contém dados históricos. Para coletar dados históricos, os clientes devem salvar os dados em seus próprios armazenamentos de dados.
1. Exportar avaliação de configurações seguras
Retorna todas as configurações e seus status, por dispositivo.
1.1 Métodos
| Método | Tipo de dados | Descrição |
|---|---|---|
| Configuração segura por coleção de dispositivos. Confira: 1.2 Propriedades (resposta JSON) | Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, ConfigurationId. A API puxa todos os dados em sua organização como respostas JSON. Esse método é melhor para organizações pequenas com menos de 100 K dispositivos. A resposta é paginada, para que você possa usar o @odata.nextLink campo da resposta para buscar os próximos resultados. | |
| Configuração segura por coleção de dispositivos. Confira: 1.3 Propriedades (por meio de arquivos) | Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, ConfigurationId. Essa solução de API permite extrair quantidades maiores de dados de forma mais rápida e confiável. Portanto, é recomendável para organizações grandes, com mais de 100 K dispositivos. Essa API puxa todos os dados em sua organização como arquivos de download. A resposta contém URLs para baixar todos os dados do Armazenamento do Azure. Essa API permite baixar todos os dados do Armazenamento do Azure da seguinte maneira:
|
1.2 Propriedades (resposta JSON)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| configurationCategory | Cadeia de caracteres | Categoria ou agrupamento ao qual a configuração pertence: aplicativo, sistema operacional, rede, contas, controles de segurança. |
| configurationId | Cadeia de caracteres | Identificador exclusivo para uma configuração específica. |
| configurationImpact | Cadeia de caracteres | Efeito classificado da configuração para a pontuação geral de configuração (1 a 10). |
| Configurationname | Cadeia de caracteres | Nome de exibição da configuração. |
| configurationSubcategory | Cadeia de caracteres | Subcategoria ou subgrupo ao qual a configuração pertence. Em muitos casos, recursos ou recursos específicos. |
| deviceId | Cadeia de caracteres | Identificador exclusivo para o dispositivo no serviço. |
| deviceName | Cadeia de caracteres | FQDN (nome de domínio totalmente qualificado) do dispositivo. |
| isApplicable | Bool | Indica se a configuração ou a política é aplicável. |
| isCompliant | Bool | Indica se a configuração ou a política está configurada corretamente. |
| isExpectedUserImpact | Bool | Indica se o usuário será afetado se a configuração será aplicada. |
| osPlatform | Cadeia de caracteres | Plataforma do sistema operacional em execução no dispositivo. Sistemas operacionais específicos com variações na mesma família, como Windows 10 e Windows 11. Consulte Sistemas operacionais, plataformas e recursos com suporte para obter detalhes. |
| osVersion | Cadeia de caracteres | Versão específica do sistema operacional em execução no dispositivo. |
| rbacGroupName | Cadeia de caracteres | O grupo RBAC (controle de acesso baseado em função). Se o dispositivo não for atribuído a nenhum grupo RBAC, o valor será "Não atribuído". Se a organização não contiver nenhum grupo RBAC, o valor será "Nenhum". |
| rbacGroupId | Cadeia de caracteres | A ID do grupo RBAC (controle de acesso baseado em função). |
| recommendationReference | Cadeia de caracteres | Uma referência à ID de recomendação relacionada ao software. |
| Timestamp | Cadeia de caracteres | Da última vez que a configuração foi vista no dispositivo. |
1.3 Propriedades (por meio de arquivos)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| Exportar arquivos | array[string] | Uma lista de URLs de download para arquivos que contêm o instantâneo atual da organização. |
| GeneratedTime | Cadeia de caracteres | O tempo em que a exportação foi gerada. |
2. Exportar avaliação de inventário de software
Retorna todos os softwares instalados e seus detalhes em cada dispositivo.
Métodos 2.1
| Método | Tipo de dados | Descrição |
|---|---|---|
| Exportar avaliação de inventário de software (resposta JSON) | Inventário de software por coleção de dispositivos. Confira: 2.2 Propriedades (resposta JSON) | Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. A API puxa todos os dados em sua organização como respostas JSON. Esse método é melhor para organizações pequenas com menos de 100 K dispositivos. A resposta é paginada, para que você possa usar o @odata.nextLink campo da resposta para buscar os próximos resultados. |
| Exportar avaliação de inventário de software (por meio de arquivos) | Inventário de software por arquivos de dispositivo. Confira: 2.3 Propriedades (por meio de arquivos) | Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. Essa solução de API permite extrair quantidades maiores de dados de forma mais rápida e confiável. Portanto, é recomendável para organizações grandes, com mais de 100 K dispositivos. Essa API puxa todos os dados em sua organização como arquivos de download. A resposta contém URLs para baixar todos os dados do Armazenamento do Azure. Essa API permite baixar dados do Armazenamento do Azure da seguinte maneira:
|
2.2 Propriedades (resposta JSON)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| DeviceId | Cadeia de caracteres | Identificador exclusivo para o dispositivo no serviço. |
| DeviceName | Cadeia de caracteres | FQDN (nome de domínio totalmente qualificado) do dispositivo. |
| DiskPaths | Matriz[cadeia de caracteres] | Evidência de disco de que o produto está instalado no dispositivo. |
| EndOfSupportDate | Cadeia de caracteres | A data em que o suporte para esse software tem ou terminará. |
| EndOfSupportStatus | Cadeia de caracteres | Fim do status de suporte. Pode conter esses valores possíveis: Nenhum, Versão do EOS, Versão EOS futura, Software EOS, Software EOS próximo. |
| NumberOfWeaknesses | Int | Número de fraquezas neste software neste dispositivo. |
| OSPlatform | Cadeia de caracteres | Plataforma do sistema operacional em execução no dispositivo; sistemas operacionais específicos com variações na mesma família, como Windows 10 e Windows 11. Consulte Sistemas operacionais, plataformas e recursos com suporte para obter detalhes. |
| RbacGroupName | Cadeia de caracteres | O grupo RBAC (controle de acesso baseado em função). Se esse dispositivo não for atribuído a nenhum grupo RBAC, o valor será "Não atribuído". Se a organização não contiver nenhum grupo RBAC, o valor será "Nenhum". |
| rbacGroupId | Cadeia de caracteres | A ID do grupo RBAC (controle de acesso baseado em função). |
| RegistryPaths | Matriz[cadeia de caracteres] | Evidência do registro de que o produto está instalado no dispositivo. |
| SoftwareFirstSeenTimestamp | Cadeia de caracteres | A primeira vez que esse software foi visto no dispositivo. |
| SoftwareName | Cadeia de caracteres | Nome do produto de software. |
| SoftwareVendor | Cadeia de caracteres | Nome do fornecedor de software. |
| SoftwareVersion | Cadeia de caracteres | Número de versão do produto de software. |
2.3 Propriedades (por meio de arquivos)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| Exportar arquivos | array[string] | Uma lista de URLs de download para arquivos que contêm o instantâneo atual da organização. |
| GeneratedTime | Cadeia de caracteres | O tempo em que a exportação foi gerada. |
3. Exportar avaliação de vulnerabilidades de software
Retorna todas as vulnerabilidades conhecidas em um dispositivo e seus detalhes, para todos os dispositivos.
Métodos 3.1
| Método | Tipo de dados | Descrição |
|---|---|---|
| Coleção de investigação Consulte: 3.2 Propriedades (resposta JSON) | Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId. A API puxa todos os dados em sua organização como respostas JSON. Esse método é melhor para organizações pequenas com menos de 100 K dispositivos. A resposta é paginada, para que você possa usar o @odata.nextLink campo da resposta para buscar os próximos resultados. | |
| Entidade de investigação Consulte: 3.3 Propriedades (por meio de arquivos) | Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId. Essa solução de API permite extrair quantidades maiores de dados de forma mais rápida e confiável. Portanto, é recomendável para organizações grandes, com mais de 100 K dispositivos. Essa API puxa todos os dados em sua organização como arquivos de download. A resposta contém URLs para baixar todos os dados do Armazenamento do Azure. Essa API permite baixar todos os dados do Armazenamento do Azure da seguinte maneira:
|
|
| Coleção de investigação Consulte: 3.4 Propriedades exportação Delta (resposta JSON) | Retorna uma tabela com uma entrada para cada combinação exclusiva de: DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId e EventTimestamp. A API puxa dados em sua organização como respostas JSON. A resposta é paginada, para que você possa usar o @odata.nextLink campo da resposta para buscar os próximos resultados. A avaliação completa de vulnerabilidades de software (resposta JSON) é usada para obter uma instantâneo inteira da avaliação de vulnerabilidades de software da sua organização por dispositivo. No entanto, a chamada de API de exportação delta é usada para buscar apenas as alterações que ocorreram entre uma data selecionada e a data atual (a chamada de API "delta"). Em vez de obter uma exportação completa com uma grande quantidade de dados todas as vezes, você só obterá informações específicas sobre vulnerabilidades novas, fixas e atualizadas. A chamada de API de exportação delta também pode ser usada para calcular diferentes KPIs, como "quantas vulnerabilidades foram corrigidas?" ou "quantas novas vulnerabilidades foram adicionadas à minha organização?" Como a chamada de API de exportação delta para vulnerabilidades de software retorna dados apenas para um intervalo de datas de destino, ela não é considerada uma exportação completa. |
3.2 Propriedades (resposta JSON)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| CveId | Cadeia de caracteres | Identificador exclusivo atribuído à vulnerabilidade de segurança no sistema CVE (Vulnerabilidades Comuns e Exposições). |
| CvssScore | Cadeia de caracteres | A pontuação CVSS da CVE. |
| DeviceId | Cadeia de caracteres | Identificador exclusivo para o dispositivo no serviço. |
| DeviceName | Cadeia de caracteres | FQDN (nome de domínio totalmente qualificado) do dispositivo. |
| DiskPaths | Matriz[cadeia de caracteres] | Evidência de disco de que o produto está instalado no dispositivo. |
| ExploitabilityLevel | Cadeia de caracteres | O nível de explorabilidade dessa vulnerabilidade (NoExploit, ExploitIsPublic, ExploitIsVerified, ExploitIsInKit) |
| FirstSeenTimestamp | Cadeia de caracteres | Primeira vez que a CVE desse produto foi vista no dispositivo. |
| Id | Cadeia de caracteres | Identificador exclusivo para o registro. |
| LastSeenTimestamp | Cadeia de caracteres | Da última vez que o CVE foi visto no dispositivo. |
| OSPlatform | Cadeia de caracteres | Plataforma do sistema operacional em execução no dispositivo; sistemas operacionais específicos com variações na mesma família, como Windows 10 e Windows 11. Consulte Sistemas operacionais, plataformas e recursos com suporte para obter detalhes. |
| RbacGroupName | Cadeia de caracteres | O grupo RBAC (controle de acesso baseado em função). Se esse dispositivo não for atribuído a nenhum grupo RBAC, o valor será "Não atribuído". Se a organização não contiver nenhum grupo RBAC, o valor será "Nenhum". |
| rbacGroupId | Cadeia de caracteres | A ID do grupo RBAC (controle de acesso baseado em função). |
| RecommendationReference | Cadeia de caracteres | Uma referência à ID de recomendação relacionada a este software. |
| RecommendedSecurityUpdate | Cadeia de caracteres | Nome ou descrição da atualização de segurança fornecida pelo fornecedor de software para resolver a vulnerabilidade. |
| RecommendedSecurityUpdateId | Cadeia de caracteres | Identificador das atualizações de segurança ou identificador aplicáveis para os artigos de orientação ou base de dados de conhecimento (KB) correspondentes. |
| Caminhos do Registro | Matriz[cadeia de caracteres] | Evidência do registro de que o produto está instalado no dispositivo. |
| SecurityUpdateAvailable | Booliano | Indica se uma atualização de segurança está disponível para o software. |
| SoftwareName | Cadeia de caracteres | Nome do produto de software. |
| SoftwareVendor | Cadeia de caracteres | Nome do fornecedor de software. |
| SoftwareVersion | Cadeia de caracteres | Número de versão do produto de software. |
| VulnerabilitySeverityLevel | Cadeia de caracteres | Nível de gravidade atribuído à vulnerabilidade de segurança com base na pontuação CVSS. |
3.3 Propriedades (por meio de arquivos)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| Exportar arquivos | array[string] | Uma lista de URLs de download para arquivos que contêm o instantâneo atual da organização. |
| GeneratedTime | Cadeia de caracteres | O tempo em que a exportação foi gerada. |
3.4 Propriedades (resposta JSON de exportação delta)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| CveId | Cadeia de caracteres | Identificador exclusivo atribuído à vulnerabilidade de segurança no sistema CVE (Vulnerabilidades Comuns e Exposições). |
| CvssScore | Cadeia de caracteres | A pontuação CVSS da CVE. |
| DeviceId | Cadeia de caracteres | Identificador exclusivo para o dispositivo no serviço. |
| DeviceName | Cadeia de caracteres | FQDN (nome de domínio totalmente qualificado) do dispositivo. |
| DiskPaths | Matriz[cadeia de caracteres] | Evidência de disco de que o produto está instalado no dispositivo. |
| EventTimestamp | Cadeia de caracteres | A hora em que o evento delta foi encontrado. |
| ExploitabilityLevel | Cadeia de caracteres | O nível de explorabilidade da vulnerabilidade (NoExploit, ExploitIsPublic, ExploitIsVerified, ExploitIsInKit) |
| FirstSeenTimestamp | Cadeia de caracteres | Primeira vez que a CVE do produto foi vista no dispositivo. |
| Id | Cadeia de caracteres | Identificador exclusivo para o registro. |
| LastSeenTimestamp | Cadeia de caracteres | Da última vez que o CVE foi visto no dispositivo. |
| OSPlatform | Cadeia de caracteres | Plataforma do sistema operacional em execução no dispositivo; sistemas operacionais específicos com variações na mesma família, como Windows 10 e Windows 11. Consulte Sistemas operacionais, plataformas e recursos com suporte para obter detalhes. |
| RbacGroupName | Cadeia de caracteres | O grupo RBAC (controle de acesso baseado em função). Se esse dispositivo não for atribuído a nenhum grupo RBAC, o valor será "Não atribuído". Se a organização não contiver nenhum grupo RBAC, o valor será "Nenhum". |
| RecommendationReference | Cadeia de caracteres | Uma referência à ID de recomendação relacionada a este software. |
| RecommendedSecurityUpdate | Cadeia de caracteres | Nome ou descrição da atualização de segurança fornecida pelo fornecedor de software para resolver a vulnerabilidade. |
| RecommendedSecurityUpdateId | Cadeia de caracteres | Identificador das atualizações de segurança ou identificador aplicáveis para os artigos de orientação ou base de dados de conhecimento (KB) correspondentes |
| RegistryPaths | Matriz[cadeia de caracteres] | Evidência do registro de que o produto está instalado no dispositivo. |
| SoftwareName | Cadeia de caracteres | Nome do produto de software. |
| SoftwareVendor | Cadeia de caracteres | Nome do fornecedor de software. |
| SoftwareVersion | Cadeia de caracteres | Número de versão do produto de software. |
| Status | Cadeia de caracteres | Novo (para uma nova vulnerabilidade introduzida em um dispositivo). Corrigido (para uma vulnerabilidade que não existe mais no dispositivo, o que significa que ele foi corrigido). Atualizado (para uma vulnerabilidade em um dispositivo que foi alterado. As possíveis alterações são: pontuação CVSS, nível de explorabilidade, nível de gravidade, DiskPaths, RegistryPaths, RecommendedSecurityUpdate). |
| VulnerabilitySeverityLevel | Cadeia de caracteres | Nível de gravidade atribuído à vulnerabilidade de segurança com base na pontuação CVSS. |
4. Exportar avaliação de inventário de software de código não produto
Retorna todo o software instalado que não tem um CPE (Common Platform Enumeration) e seus detalhes em cada dispositivo.
Métodos 4.1
| Método | Tipo de dados | Descrição |
|---|---|---|
| Exportar avaliação de inventário de software de código não produto (resposta JSON) | Inventário de software de código não produto por coleção de dispositivos. Confira: 4.2 Propriedades (resposta JSON) | Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. A API puxa todos os dados em sua organização como respostas JSON. Esse método é melhor para organizações pequenas com menos de 100 K dispositivos. A resposta é paginada, para que você possa usar o @odata.nextLink campo da resposta para buscar os próximos resultados. |
| Exportar avaliação de inventário de software de código não produto (por meio de arquivos) | Inventário de software de código não produto por arquivos de dispositivo. Confira: 4.3 Propriedades (por meio de arquivos) | Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. Essa solução de API permite extrair quantidades maiores de dados de forma mais rápida e confiável. Portanto, é recomendável para organizações grandes, com mais de 100 K dispositivos. Essa API puxa todos os dados em sua organização como arquivos de download. A resposta contém URLs para baixar todos os dados do Armazenamento do Azure. Essa API permite baixar dados do Armazenamento do Azure da seguinte maneira:
|
4.2 Propriedades (resposta JSON)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| DeviceId | string | Identificador exclusivo para o dispositivo no serviço. |
| DeviceName | string | FQDN (nome de domínio totalmente qualificado) do dispositivo. |
| OSPlatform | string | Plataforma do sistema operacional em execução no dispositivo. São sistemas operacionais específicos com variações na mesma família, como Windows 10 e Windows 11. Consulte Sistemas operacionais, plataformas e recursos com suporte para obter detalhes. |
| RbacGroupName | string | O grupo RBAC (controle de acesso baseado em função). Se esse dispositivo não for atribuído a nenhum grupo RBAC, o valor será "Não atribuído". Se a organização não contiver nenhum grupo RBAC, o valor será "Nenhum". |
| RbacGroupId | string | A ID do grupo RBAC (controle de acesso baseado em função). |
| SoftwareLastSeenTimestamp | string | A última vez que este software foi visto no dispositivo. |
| SoftwareName | string | Nome do produto de software. |
| SoftwareVendor | cadeia de caracteres | Nome do fornecedor de software. |
| SoftwareVersion | cadeia de caracteres | Número de versão do produto de software. |
4.3 Propriedades (por meio de arquivos)
| Propriedade (ID) | Tipo de dados | Descrição |
|---|---|---|
| Exportar arquivos | array[string] | Uma lista de URLs de download para arquivos que contêm o instantâneo atual da organização. |
| GeneratedTime | Cadeia de caracteres | O tempo em que a exportação foi gerada. |
Confira também
- Exportar avaliação de configuração segura por dispositivo
- Exportar avaliação de inventário de software por dispositivo
- Exportar avaliação de vulnerabilidades de software por dispositivo
- Exportar avaliação de inventário de software não cpe por dispositivo
Outros relacionados
Dica
Você deseja aprender mais? Engage com a comunidade de Segurança da Microsoft em nossa Comunidade Tecnológica: Microsoft Defender para Ponto de Extremidade Tech Community.