Exportar avaliação de inventário de software por dispositivo

  • Artigo

Aplica-se a:

Deseja experimentar o Microsoft Defender para Ponto de Extremidade? Inscreva-se para uma avaliação gratuita.

Essa API retorna todos os dados do software instalado que tem um CPE (Common Platform Enumeration(CPE), por dispositivo.

Chamadas de API diferentes obtêm tipos diferentes de dados. Como a quantidade de dados pode ser grande, há duas maneiras de serem recuperados:

  • Exportar resposta JSON de avaliação de inventário de software 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.

  • Exportar avaliação de inventário de software 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 a 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.

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).

1. Exportar avaliação de inventário de software (resposta JSON)

1.1 Descrição do método de API

Essa resposta de API contém todos os dados do software instalado que tem um CPE (Common Platform Enumeration(CPE), por dispositivo. Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.

1.1.1 Limitações

  • O tamanho máximo da página é de 200.000.
  • As limitações de taxa para essa API são 30 chamadas por minuto e 1000 chamadas por hora.

1.2 Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, consulte Usar APIs Microsoft Defender para Ponto de Extremidade para obter detalhes.

Tipo de permissão Permissão Nome da exibição de permissão
Application Software.Read.All 'Ler informações de software de Gerenciamento de Ameaças e Vulnerabilidades'
Delegado (conta corporativa ou de estudante) Software.Read 'Ler informações de software de Gerenciamento de Ameaças e Vulnerabilidades'

1.3 URL

GET /api/machines/SoftwareInventoryByMachine

1.4 Parâmetros

  • pageSize (padrão = 50.000): número de resultados em resposta.
  • $top: número de resultados a serem retornados (não retorna @odata.nextLink e, portanto, não puxa todos os dados)

1.5 Propriedades

Observação

  • Cada registro é aproximadamente 0,5KB de dados. Você deve levar isso em conta ao escolher o parâmetro pageSize correto para você.
  • As propriedades definidas na tabela a seguir são listadas em ordem alfabética, por ID da propriedade. Ao executar essa API, a saída resultante não será necessariamente retornada na mesma ordem listada nesta tabela.
  • Algumas colunas adicionais podem ser retornadas na resposta. Essas colunas são temporárias e podem ser removidas, use apenas as colunas documentadas.

Propriedade (ID) Tipo de dados Descrição Exemplo de um valor retornado
DeviceId string Identificador exclusivo para o dispositivo no serviço. 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
DeviceName string FQDN (nome de domínio totalmente qualificado) do dispositivo. johnlaptop.europe.contoso.com
DiskPaths Matriz[cadeia de caracteres] Evidência de disco de que o produto está instalado no dispositivo. ["C:\Arquivos do Programa (x86)\Microsoft\Silverlight\Application\silverlight.exe"]
EndOfSupportDate string A data em que o suporte para esse software tem ou terminará. 2020-12-30
EndOfSupportStatus string 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. Próximo EOS
NumberOfWeaknesses int Número de fraquezas neste software neste dispositivo 3
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 Gerenciamento de Vulnerabilidades do Microsoft Defender sistemas operacionais e plataformas com suporte para obter detalhes. Windows10 e Windows 11
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". Servidores
RegistryPaths Matriz[cadeia de caracteres] Evidência do registro de que o produto está instalado no dispositivo. ["HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Microsoft Silverlight"]
SoftwareFirstSeenTimestamp string A primeira vez que esse software foi visto no dispositivo. 2019-04-07 02:06:47
SoftwareName string Nome do produto de software. Silverlight
SoftwareVendor string Nome do fornecedor de software. microsoft
SoftwareVersion string Número de versão do produto de software. 81.0.4044.138

1.6 Exemplos

1.6.1 Exemplo de solicitação

GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pageSize=5  &sinceTime=2021-05-19T18%3A35%3A49.924Z

1.6.2 Exemplo de resposta

{
    "@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"
}

Observação

As informações retornadas por essa API, juntamente com as informações retornadas pela API de avaliação de inventário de software não de código de produto , para software que não tem um CPE, fornecem visibilidade total sobre o software instalado em toda a sua organização e os dispositivos em que ele está instalado.

2. Exportar avaliação de inventário de software (por meio de arquivos)

Descrição do método de API 2.1

Essa resposta à API contém todos os dados de software instalado por dispositivo. Retorna uma tabela com uma entrada para cada combinação exclusiva de DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.

Limitações 2.1.1

As limitações de taxa para essa API são 5 chamadas por minuto e 20 chamadas por hora.

2.2 Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, consulte Usar APIs Microsoft Defender para Ponto de Extremidade para obter detalhes.

Tipo de permissão Permissão Nome da exibição de permissão
Application Software.Read.All 'Ler informações de software de Gerenciamento de Ameaças e Vulnerabilidades'
Delegado (conta corporativa ou de estudante) Software.Read 'Ler informações de software de Gerenciamento de Ameaças e Vulnerabilidades'

2.3 URL

GET /api/machines/SoftwareInventoryExport

Parâmetros

  • sasValidHours: o número de horas pelas quais as URLs de download serão válidas (máximo de 24 horas)

2.5 Propriedades

Observação

  • Os arquivos são compactados gzip & no formato JSON multiline.
  • As URLs de download são válidas apenas por 3 horas. Caso contrário, você pode usar o parâmetro.
  • Para obter a velocidade máxima de download de seus dados, você pode ter certeza de que está baixando da mesma região do Azure que seus dados residem.

Propriedade (ID) Tipo de dados Descrição Exemplo de um valor retornado
Exportar arquivos array[string] Uma lista de URLs de download para arquivos que contêm o instantâneo atual da organização "[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime cadeia de caracteres O tempo em que a exportação foi gerada. 2021-05-20T08:00:00Z

2.6 Exemplos

2.6.1 Exemplo de solicitação

GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryExport

Exemplo de resposta 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"
}

Confira também

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.