Compartilhar via

Exportar a avaliação do 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.

Esta API devolve todos os dados do software instalado que tem uma Enumeração de Plataforma Comum (CPE) numa base por dispositivo.

Diferentes chamadas à API obtêm diferentes tipos de dados. Uma vez que a quantidade de dados pode ser grande, existem duas formas de os obter:

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

  • Exportar a avaliação do inventário de software através de ficheiros Esta solução de API permite extrair grandes quantidades de dados de forma mais rápida e fiável, e é recomendada 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 (utilizando a resposta Json ou através de ficheiros) são a snapshot 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.

Observação

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

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

1.1 Descrição do método da API

Esta resposta da API contém todos os dados do software instalado que tem uma Enumeração de Plataforma Comum (CPE), por dispositivo. Devolve 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 é 200 000.
  • As limitações de taxa para esta 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, veja Utilizar Microsoft Defender para Ponto de Extremidade APIs para obter detalhes.

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

1,3 URL

GET /api/machines/SoftwareInventoryByMachine

1.4 Parâmetros

  • pageSize (predefinição = 50 000): número de resultados em resposta.
  • $top: Número de resultados a devolver (não devolve @odata.nextLink e, por conseguinte, não extrai todos os dados)

1.5 Propriedades

Observação

  • Cada registo é de 0,5 KB de dados. Deve ter este tamanho em consideração ao escolher o parâmetro pageSize correto automaticamente.
  • As propriedades definidas na tabela seguinte são listadas alfabeticamente, por ID de propriedade. Ao executar esta API, o resultado resultante não é necessariamente devolvido pela mesma ordem listada nesta tabela.
  • Algumas outras colunas podem ser devolvidas na resposta. Estas colunas são temporárias e podem ser removidas, pelo que utilize apenas as colunas documentadas.

Propriedade (ID) Tipo de dados Descrição Exemplo de um valor devolvido
DeviceId string Identificador exclusivo do dispositivo no serviço. 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
DeviceName string Nome de domínio completamente qualificado (FQDN) do dispositivo. johnlaptop.europe.contoso.com
DiskPaths Matriz[cadeia] Prova de disco de que o produto está instalado no dispositivo. ["C:\Programas (x86)\Microsoft\Silverlight\Application\silverlight.exe"]
EndOfSupportDate string A data em que o suporte para este software tem ou quando o suporte termina. 2020-12-30
EndOfSupportStatus string Fim do suporte status. Pode conter estes valores possíveis: None, EOS Version, Upcoming EOS Version, EOS Software, Upcoming EOS Software. EOS futuro
NumberOfWeaknesses int Número de pontos fracos neste software neste dispositivo 3
OSPlatform string 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 Gerenciamento de Vulnerabilidades do Microsoft Defender sistemas operativos e plataformas suportados para obter detalhes. Windows10 e Windows 11
RbacGroupName string 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". Servidores
RegistryPaths Matriz[cadeia] Prova de registo 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 este 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 da versão do produto de software. 81.0.4044.138

1.6 Exemplos

1.6.1 Exemplo de pedido

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 devolvidas por esta API, juntamente com as informações devolvidas pela API de avaliação de inventário de software de código de produto não produto para software que não tem um CPE, dão-lhe visibilidade total sobre o software instalado na sua organização e os dispositivos em que está instalado.

2. Exportar a avaliação do inventário de software (através de ficheiros)

Descrição do método da API 2.1

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

2.1.1 Limitações

As limitações de taxa para esta 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, veja Utilizar Microsoft Defender para Ponto de Extremidade APIs para obter detalhes.

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

2.3 URL

GET /api/machines/SoftwareInventoryExport

2.4 Propriedades

Observação

  • Os ficheiros são comprimidos gzip & no formato JSON multiline.
  • Os URLs de transferência só são válidos durante 1 hora.
  • Para obter a velocidade máxima de transferência dos seus dados, pode certificar-se de que está a transferir a partir da mesma região do Azure em que os seus dados residem.

Propriedade (ID) Tipo de dados Descrição Exemplo de um valor devolvido
Exportar ficheiros matriz[cadeia] Uma lista de URLs de transferência para ficheiros que contêm o snapshot atual da organização "[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime string A hora em que a exportação foi gerada. 2021-05-20T08:00:00Z

2.5 Exemplos

2.5.1 Exemplo de pedido

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

2.5.2 Exemplo de resposta

{
    "@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 na nossa Comunidade Tecnológica: Microsoft Defender para Ponto de Extremidade Tech Community.