Partilhar via


Exportar métodos e propriedades de avaliação por dispositivo

Aplica-se a:

Quer experimentar o Microsoft Defender para Ponto Final? Inscrever-se para uma avaliação gratuita.

Descrição da API

Fornece métodos e detalhes de propriedade sobre as APIs que extraem dados de gestão de vulnerabilidades por dispositivo. Existem diferentes chamadas à API para obter diferentes tipos de dados. Em geral, cada chamada à API contém os dados necessários para os dispositivos na sua organização.

Nota

Salvo indicação em contrário, todos os métodos de avaliação de exportação listados são de exportação completa e por dispositivo (também referidos como por dispositivo).

Pode utilizar as APIs de avaliação de exportação para obter (exportar) diferentes tipos de informações:

As APIs que correspondem aos tipos de informações de exportação estão descritas nas secções 1, 2 e 3.

Cada método tem diferentes chamadas à API para obter diferentes tipos de dados. Uma vez que a quantidade de dados pode ser grande, existem duas formas de os obter:

  • Resposta JSON A API extrai todos os dados na sua organização como respostas JSON. Este método é melhor para pequenas organizações com menos de 100 K dispositivos. A resposta é paginada, pelo que pode utilizar o campo @odata.nextLink da resposta para obter os resultados seguintes.

  • através de ficheiros Esta solução de API permite extrair grandes quantidades de dados de forma mais rápida e fiável. Por isso, é recomendado para grandes organizações, com mais de 100 K dispositivos. Esta API extrai todos os dados na sua organização como ficheiros de transferência. A resposta contém URLs para transferir todos os dados do Armazenamento do Azure. Esta API permite-lhe transferir todos os seus dados do Armazenamento do Azure da seguinte forma:

    • Chame a API para obter uma lista de URLs de transferência com todos os dados da sua organização.
    • Transfira todos os ficheiros com os URLs de transferência e processe os dados conforme quiser.

Os dados recolhidos através de "resposta JSON ou através de ficheiros" são o instantâneo atual do estado atual. Não contém dados históricos. Para recolher dados históricos, os clientes têm de guardar os dados nos seus próprios armazenamentos de dados.

1. Exportar avaliação de configurações seguras

Devolve todas as configurações e o respetivo estado, por dispositivo.

Métodos 1.1

Método Tipo de dados Descrição
Proteger a configuração por coleção de dispositivos. Veja: 1.2 Propriedades (resposta JSON) Devolve uma tabela com uma entrada para cada combinação exclusiva de DeviceId, ConfigurationId. A API extrai todos os dados na sua organização como respostas JSON. Este método é melhor para pequenas organizações com menos de 100 K dispositivos. A resposta é paginada, pelo que pode utilizar o @odata.nextLink campo da resposta para obter os resultados seguintes.
Proteger a configuração por coleção de dispositivos. Veja: 1.3 Propriedades (através de ficheiros) Devolve uma tabela com uma entrada para cada combinação exclusiva de DeviceId, ConfigurationId. Esta solução de API permite extrair grandes quantidades de dados de forma mais rápida e fiável. Por isso, é recomendado para grandes organizações, com mais de 100 K dispositivos. Esta API extrai todos os dados na sua organização como ficheiros de transferência. A resposta contém URLs para transferir todos os dados do Armazenamento do Azure. Esta API permite-lhe transferir todos os seus dados do Armazenamento do Azure da seguinte forma:
  1. Chame a API para obter uma lista de URLs de transferência com todos os dados da sua organização.
  2. Transfira todos os ficheiros com os URLs de transferência e processe os dados conforme quiser.

1.2 Propriedades (resposta JSON)

Propriedade (ID) Tipo de dados Descrição
configurationCategory Cadeia Categoria ou agrupamento ao qual a configuração pertence: Aplicação, SO, Rede, Contas, Controlos de segurança.
configurationId Cadeia Identificador exclusivo para uma configuração específica.
configurationImpact Cadeia Efeito classificado da configuração para a classificação de configuração geral (1-10).
configurationName Cadeia Nome a apresentar da configuração.
configurationSubcategory Cadeia Subcategoria ou subgrupo ao qual a configuração pertence. Em muitos casos, funcionalidades ou capacidades específicas.
deviceId Cadeia Identificador exclusivo do dispositivo no serviço.
deviceName Cadeia Nome de domínio completamente qualificado (FQDN) 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 utilizador é afetado se a configuração será aplicada.
osPlatform Cadeia Plataforma do sistema operativo em execução no dispositivo. Sistemas operativos específicos com variações na mesma família, como Windows 10 e Windows 11. Veja Sistemas operativos, plataformas e capacidades suportados para obter detalhes.
osVersion Cadeia Versão específica do sistema operativo em execução no dispositivo.
rbacGroupName Cadeia O grupo de controlo de acesso baseado em funções (RBAC). Se o dispositivo não estiver 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 O ID de grupo do controlo de acesso baseado em funções (RBAC).
recommendationReference Cadeia Uma referência ao ID de recomendação relacionado com o software.
carimbo de data/hora Cadeia A última vez que a configuração foi vista no dispositivo.

1.3 Propriedades (através de ficheiros)

Propriedade (ID) Tipo de dados Descrição
Exportar ficheiros matriz[cadeia] Uma lista de URLs de transferência para ficheiros que contêm o instantâneo atual da organização.
GeneratedTime Cadeia A hora em que a exportação foi gerada.

2. Exportar a avaliação do inventário de software

Devolve todo o software instalado e os respetivos detalhes em cada dispositivo.

Métodos 2.1

Método Tipo de dados Descrição
Exportar a avaliação do inventário de software (resposta JSON) Inventário de software por coleção de dispositivos. Veja: 2.2 Propriedades (resposta JSON) Devolve uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. A API extrai todos os dados na sua organização como respostas JSON. Este método é melhor para pequenas organizações com menos de 100 K dispositivos. A resposta é paginada, pelo que pode utilizar o @odata.nextLink campo da resposta para obter os resultados seguintes.
Exportar a avaliação do inventário de software (através de ficheiros) Inventário de software por ficheiros de dispositivo. Veja: 2.3 Propriedades (através de ficheiros) Devolve uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. Esta solução de API permite extrair grandes quantidades de dados de forma mais rápida e fiável. Por isso, é recomendado para grandes organizações, com mais de 100 K dispositivos. Esta API extrai todos os dados na sua organização como ficheiros de transferência. A resposta contém URLs para transferir todos os dados do Armazenamento do Azure. Esta API permite-lhe transferir dados do Armazenamento do Azure da seguinte forma:
  1. Chamar a API para obter uma lista de URLs de transferência com os dados da sua organização
  2. Transfira os ficheiros com os URLs de transferência e processe os dados conforme quiser.

2.2 Propriedades (resposta JSON)

Propriedade (ID) Tipo de dados Descrição
DeviceId Cadeia Identificador exclusivo do dispositivo no serviço.
DeviceName Cadeia Nome de domínio completamente qualificado (FQDN) do dispositivo.
DiskPaths Matriz[cadeia] Prova de disco de que o produto está instalado no dispositivo.
EndOfSupportDate Cadeia A data em que o suporte para este software tem ou terminará.
EndOfSupportStatus Cadeia Fim do estado de suporte. Pode conter estes valores possíveis: None, EOS Version, Upcoming EOS Version, EOS Software, Upcoming EOS Software.
NumberOfWeaknesses Int Número de pontos fracos neste software neste dispositivo.
OSPlatform Cadeia Plataforma do sistema operativo em execução no dispositivo; sistemas operativos específicos com variações na mesma família, como Windows 10 e Windows 11. Veja Sistemas operativos, plataformas e capacidades suportados para obter detalhes.
RbacGroupName Cadeia O grupo de controlo de acesso baseado em funções (RBAC). Se este dispositivo não estiver 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 O ID de grupo do controlo de acesso baseado em funções (RBAC).
RegistryPaths Matriz[cadeia] Prova de registo de que o produto está instalado no dispositivo.
SoftwareFirstSeenTimestamp Cadeia A primeira vez que este software foi visto no dispositivo.
SoftwareName Cadeia Nome do produto de software.
SoftwareVendor Cadeia Nome do fornecedor de software.
SoftwareVersion Cadeia Número da versão do produto de software.

2.3 Propriedades (através de ficheiros)

Propriedade (ID) Tipo de dados Descrição
Exportar ficheiros matriz[cadeia] Uma lista de URLs de transferência para ficheiros que contêm o instantâneo atual da organização.
GeneratedTime Cadeia A hora em que a exportação foi gerada.

3. Exportar avaliação de vulnerabilidades de software

Devolve todas as vulnerabilidades conhecidas num dispositivo e os respetivos detalhes, para todos os dispositivos.

Métodos 3.1

Método Tipo de dados Descrição
Coleção de investigação Veja: 3.2 Propriedades (resposta JSON) Devolve uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId. A API extrai todos os dados na sua organização como respostas JSON. Este método é melhor para pequenas organizações com menos de 100 K dispositivos. A resposta é paginada, pelo que pode utilizar o @odata.nextLink campo da resposta para obter os resultados seguintes.
Entidade de investigação Veja: 3.3 Propriedades (através de ficheiros) Devolve uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId. Esta solução de API permite extrair grandes quantidades de dados de forma mais rápida e fiável. Por isso, é recomendado para grandes organizações, com mais de 100 K dispositivos. Esta API extrai todos os dados na sua organização como ficheiros de transferência. A resposta contém URLs para transferir todos os dados do Armazenamento do Azure. Esta API permite-lhe transferir todos os seus dados do Armazenamento do Azure da seguinte forma:
  1. Chame a API para obter uma lista de URLs de transferência com todos os dados da sua organização.
  2. Transfira todos os ficheiros com os URLs de transferência e processe os dados conforme quiser.
Coleção de investigação Veja: 3.4 Exportação delta de propriedades (resposta JSON) Devolve uma tabela com uma entrada para cada combinação exclusiva de: DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion, CveId e EventTimestamp.

A API extrai dados na sua organização como respostas JSON. A resposta é paginada, pelo que pode utilizar o @odata.nextLink campo da resposta para obter os resultados seguintes. A avaliação completa de vulnerabilidades de software (resposta JSON) é utilizada para obter um instantâneo completo da avaliação de vulnerabilidades de software da sua organização por dispositivo. No entanto, a chamada à API de exportação delta é utilizada para obter apenas as alterações que ocorreram entre uma data selecionada e a data atual (a chamada à API "delta"). Em vez de obter sempre uma exportação completa com uma grande quantidade de dados, só obterá informações específicas sobre vulnerabilidades novas, corrigidas e atualizadas. A chamada à API de exportação delta também pode ser utilizada para calcular KPIs diferentes, como "quantas vulnerabilidades foram corrigidas?" ou "quantas novas vulnerabilidades foram adicionadas à minha organização?"

Uma vez que a chamada à API de exportação delta para vulnerabilidades de software devolve dados apenas para um intervalo de datas de destino, não é considerada uma exportação completa.

3.2 Propriedades (resposta JSON)

Propriedade (ID) Tipo de dados Descrição
CveId Cadeia Identificador exclusivo atribuído à vulnerabilidade de segurança no sistema CVE (Common Vulnerabilities and Exposures).
CvssScore Cadeia A pontuação CVSS do CVE.
DeviceId Cadeia Identificador exclusivo do dispositivo no serviço.
DeviceName Cadeia Nome de domínio completamente qualificado (FQDN) do dispositivo.
DiskPaths Matriz[cadeia] Prova de disco de que o produto está instalado no dispositivo.
ExploitabilityLevel Cadeia O nível de explorabilidade desta vulnerabilidade (NoExploit, ExploitIsPublic, ExploitIsVerified, ExploitIsInKit)
FirstSeenTimestamp Cadeia Primeira vez que o CVE deste produto foi visto no dispositivo.
ID Cadeia Identificador exclusivo do registo.
LastSeenTimestamp Cadeia A última vez que o CVE foi visto no dispositivo.
OSPlatform Cadeia Plataforma do sistema operativo em execução no dispositivo; sistemas operativos específicos com variações na mesma família, como Windows 10 e Windows 11. Veja Sistemas operativos, plataformas e capacidades suportados para obter detalhes.
RbacGroupName Cadeia O grupo de controlo de acesso baseado em funções (RBAC). Se este dispositivo não estiver 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 O ID de grupo do controlo de acesso baseado em funções (RBAC).
RecommendationReference Cadeia Uma referência ao ID de recomendação relacionado com este software.
RecommendedSecurityUpdate Cadeia Nome ou descrição da atualização de segurança fornecida pelo fornecedor de software para resolver a vulnerabilidade.
RecommendedSecurityUpdateId Cadeia 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 Registo Matriz[cadeia] Prova de registo de que o produto está instalado no dispositivo.
SecurityUpdateAvailable Booleano Indica se está disponível uma atualização de segurança para o software.
SoftwareName Cadeia Nome do produto de software.
SoftwareVendor Cadeia Nome do fornecedor de software.
SoftwareVersion Cadeia Número da versão do produto de software.
VulnerabilitySeverityLevel Cadeia Nível de gravidade atribuído à vulnerabilidade de segurança com base na classificação cvSS.

3.3 Propriedades (através de ficheiros)

Propriedade (ID) Tipo de dados Descrição
Exportar ficheiros matriz[cadeia] Uma lista de URLs de transferência para ficheiros que contêm o instantâneo atual da organização.
GeneratedTime Cadeia A hora 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 Identificador exclusivo atribuído à vulnerabilidade de segurança no sistema CVE (Common Vulnerabilities and Exposures).
CvssScore Cadeia A pontuação CVSS do CVE.
DeviceId Cadeia Identificador exclusivo do dispositivo no serviço.
DeviceName Cadeia Nome de domínio completamente qualificado (FQDN) do dispositivo.
DiskPaths Matriz[cadeia] Prova de disco de que o produto está instalado no dispositivo.
EventTimestamp Cadeia A hora em que o evento delta foi encontrado.
ExploitabilityLevel Cadeia O nível de explorabilidade da vulnerabilidade (NoExploit, ExploitIsPublic, ExploitIsVerified, ExploitIsInKit)
FirstSeenTimestamp Cadeia Primeira vez que o CVE do produto foi visto no dispositivo.
ID Cadeia Identificador exclusivo do registo.
LastSeenTimestamp Cadeia A última vez que o CVE foi visto no dispositivo.
OSPlatform Cadeia Plataforma do sistema operativo em execução no dispositivo; sistemas operativos específicos com variações na mesma família, como Windows 10 e Windows 11. Veja Sistemas operativos, plataformas e capacidades suportados para obter detalhes.
RbacGroupName Cadeia O grupo de controlo de acesso baseado em funções (RBAC). Se este dispositivo não estiver 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 Uma referência ao ID de recomendação relacionado com este software.
RecommendedSecurityUpdate Cadeia Nome ou descrição da atualização de segurança fornecida pelo fornecedor de software para resolver a vulnerabilidade.
RecommendedSecurityUpdateId Cadeia 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] Prova de registo de que o produto está instalado no dispositivo.
SoftwareName Cadeia Nome do produto de software.
SoftwareVendor Cadeia Nome do fornecedor de software.
SoftwareVersion Cadeia Número da versão do produto de software.
Estado Cadeia Novo (para uma nova vulnerabilidade introduzida num dispositivo). Corrigido (para uma vulnerabilidade que já não existe no dispositivo, o que significa que foi remediada). Atualizado (para uma vulnerabilidade num dispositivo que foi alterado. As possíveis alterações são: pontuação CVSS, nível de exploração, nível de gravidade, DiskPaths, RegistryPaths, RecommendedSecurityUpdate).
VulnerabilitySeverityLevel Cadeia Nível de gravidade atribuído à vulnerabilidade de segurança com base na classificação cvSS.

4. Exportar a avaliação do inventário de software de código de produto

Devolve todo o software instalado que não tem uma Enumeração de Plataforma Comum (CPE) e os respetivos detalhes em cada dispositivo.

Métodos 4.1

Método Tipo de dados Descrição
Exportar a avaliação do inventário de software de código de produto (resposta JSON) Inventário de software de código de produto não produto por coleção de dispositivos. Veja: 4.2 Propriedades (resposta JSON) Devolve uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. A API extrai todos os dados na sua organização como respostas JSON. Este método é melhor para pequenas organizações com menos de 100 K dispositivos. A resposta é paginada, pelo que pode utilizar o @odata.nextLink campo da resposta para obter os resultados seguintes.
Exportar a avaliação do inventário de software de código de produto (através de ficheiros) Inventário de software de código de produto por ficheiros de dispositivo. Veja: 4.3 Propriedades (através de ficheiros) Devolve uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. Esta solução de API permite extrair grandes quantidades de dados de forma mais rápida e fiável. Por isso, é recomendado para grandes organizações, com mais de 100 K dispositivos. Esta API extrai todos os dados na sua organização como ficheiros de transferência. A resposta contém URLs para transferir todos os dados do Armazenamento do Azure. Esta API permite-lhe transferir dados do Armazenamento do Azure da seguinte forma:
  1. Chamar a API para obter uma lista de URLs de transferência com os dados da sua organização
  2. Transfira os ficheiros com os URLs de transferência e processe os dados conforme quiser.

4.2 Propriedades (resposta JSON)

Propriedade (ID) Tipo de dados Descrição
DeviceId cadeia Identificador exclusivo do dispositivo no serviço.
DeviceName cadeia Nome de domínio completamente qualificado (FQDN) do dispositivo.
OSPlatform cadeia Plataforma do sistema operativo em execução no dispositivo. Estes são sistemas operativos específicos com variações dentro da mesma família, como Windows 10 e Windows 11. Veja Sistemas operativos, plataformas e capacidades suportados para obter detalhes.
RbacGroupName cadeia O grupo de controlo de acesso baseado em funções (RBAC). Se este dispositivo não estiver 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 O ID de grupo do controlo de acesso baseado em funções (RBAC).
SoftwareLastSeenTimestamp cadeia A última vez que este software foi visto no dispositivo.
SoftwareName cadeia Nome do produto de software.
SoftwareVendor cadeia Nome do fornecedor de software.
SoftwareVersion cadeia Número da versão do produto de software.

4.3 Propriedades (através de ficheiros)

Propriedade (ID) Tipo de dados Descrição
Exportar ficheiros matriz[cadeia] Uma lista de URLs de transferência para ficheiros que contêm o instantâneo atual da organização.
GeneratedTime Cadeia A hora em que a exportação foi gerada.

Consulte também

Outros relacionados

Sugestão

Quer saber mais? Engage com a comunidade de Segurança da Microsoft na nossa Comunidade Tecnológica: Microsoft Defender para Endpoint Tech Community.