Exportar avaliação de inventário de software de código de produto por dispositivo

Esta API devolve todos os dados do software instalado que não tem uma Enumeração de Plataforma Comum (CPE) numa base por dispositivo. As informações devolvidas por esta API, juntamente com as informações devolvidas pela API de avaliação de inventário de software exportar, para software que tenha um CPE dão-lhe visibilidade total sobre o software instalado na sua organização e os dispositivos em que está instalado.

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 de código de produto: 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 de código de produto 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 organizações grandes 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 Azure. Esta API permite-lhe transferir todos os seus dados do Armazenamento 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.

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), salvo especificação em contrário.

Os dados recolhidos (utilizando a 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 a avaliação do inventário de software de código de produto (resposta JSON)

1.1 Descrição do método da API

Esta resposta da API contém todos os dados do software instalado que não 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.

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

É necessária uma das seguintes permissões para chamar esta API. Para saber mais, incluindo como escolher permissões, veja Utilizar Microsoft Defender para Endpoint APIs para obter detalhes.

1,3 URL

GET /api/machines/SoftwareInventoryNoProductCodeByMachine

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

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

1.6 Exemplos

1.6.1 Exemplo de pedido

https://api.security.microsoft.com/api/machines/SoftwareInventoryNoProductCodeByMachine?pageSize=3  &sinceTime=2021-05-19

1.6.2 Exemplo de resposta

{
    "@odata.context": "https://api.security.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetNonCpeSoftware)",
    "value": [
        {
           "deviceId": "1234512345123451234512345",
            "rbacGroupId": 11,
            "rbacGroupName": "London",
            "deviceName": "Device1",
            "osPlatform": "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "vs_communitymsi",
            "softwareVersion": "11.11.31111.1",
            "softwareLastSeenTimestamp": "2021-01-30 11:31:12.271"
        },
        {
            "deviceId": "232323232323232322323232323",
            "rbacGroupId": 23,
            "rbacGroupName": "Tokyo",
            "deviceName": "Device23",
            "osPlatform": "Windows10",
            "softwareVendor": "intel",
            "softwareName": "intel®_software_installer",
            "softwareVersion": "22.20.2.2",
            "softwareLastSeenTimestamp": "2022-05-30 15:35:12.271"
        },
        {
            "deviceId": "6565656565",
            "rbacGroupId": 65,
            "rbacGroupName": "Center",
            "deviceName": "Device56",
            "osPlatform": "Windows10",
            "softwareVendor": "Lob Apps",
            "softwareName": "Headtrax",
            "softwareVersion": "60.273.3",
            "softwareLastSeenTimestamp": "2022-05-05 15:35:12.271"
        },
    ],
        "@odata.nextLink": "https://api.security.microsoft.com/api/machines/SoftwareInventoryNoProductCodeByMachine?pagesize=3%20%20&sincetime=2021-05-19&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMi0wNS0zMC8xMTAxLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}

2. Exportar a avaliação do inventário de software de código de produto (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 que não 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.

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

É necessária uma das seguintes permissões para chamar esta API. Para saber mais, incluindo como escolher permissões, veja Utilizar Microsoft Defender para Endpoint APIs para obter detalhes.

2.3 URL

GET /api/machines/SoftwareInventoryNonCpeExport

2.4 Parâmetros

• sasValidHours: o número de horas para as quais os URLs de transferência são válidos. O máximo é de 6 horas.

2.5 Propriedades

• Os ficheiros são comprimidos GZIP & no formato JSON multiline.
• Os URLs de transferência são válidos durante 1 hora, a menos que o sasValidHours parâmetro seja utilizado.
• 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 Azure onde residem os seus dados.

2.6 Exemplos

2.6.1 Exemplo de pedido

GET https://api.security.microsoft.com/api/machines/SoftwareInventoryNonCpeExport

2.6.2 Exemplo de resposta

{
    "@odata.context": "https://api.security.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00337-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=aHnmuOKlIvpR0PsdamYfmCCDZ1nhpuXBzK2%2FkJ9xTpg%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00338-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=0fQg%2Ft469x26KvPLmvctLl0g6DC38CNM3lXYi9dnFfo%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00339-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=P6HGHoLXXipMauBpLueoQVrwHL7qmvLoCjcij6ERx8o%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00340-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=VnpVct%2F8vdiIFTf2xXP9DF7ngWv1Zqew30q2jBPVghg%3D",
        "https://tvmexportexternalprdcanc.blob.core.windows.net/temp-ffd80447-7b3d-4ad2-b366-f0979b129662/2022-05-30/1101/NonCpeSoftwareInventory/json/OrgId=47d41a0c-188d-46d3-bbea-a93dbc0bfcaa/_RbacGroupId=1/part-00341-5e15412b-5c85-4896-ac60-b7b3ab8da096.c000.json.gz?sv=2020-08-04&st=2022-05-30T13%3A41%3A59Z&se=2022-05-30T16%3A41%3A59Z&sr=b&sp=r&sig=GY0zxMfEmr9v9fZBWYyKEtT2k%2F0ELQIlOP0ct%2B6SdGU%3D",
    ],
    "generatedTime": "2022-05-30T11:01:00Z"
}