Exportar relatório de estado de funcionamento do antivírus do dispositivo

Aplica-se a:

• API do Microsoft Defender para Endpoint 1
• Microsoft Defender para Endpoint Plano 2
• Microsoft Defender XDR

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

Esta API tem dois métodos para obter os detalhes do estado de funcionamento do antivírus do antivírus do Microsoft Defender:

• Método1:1 Exportar relatórios de estado de funcionamento (resposta JSON) O método 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.

• Método 2:2 Exportar relatórios de estado de funcionamento (através de ficheiros) Este método 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. Veja Exportar os métodos e propriedades da API de detalhes do estado de funcionamento do dispositivo.

1 Exportar relatórios de estado de funcionamento (resposta JSON)

1.1 Descrição do método da API

Esta API obtém uma lista de detalhes do estado de funcionamento do antivírus do dispositivo antivírus do Microsoft Defender. Devolve uma tabela com uma entrada para cada combinação exclusiva de:

• DeviceId
• Nome do dispositivo
• Modo AV
• Estado atualizado
• Resultados da análise

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.

Operadores suportados pelo OData

• $filterem: machineId, , osKindcomputerDnsName, osPlatform, osVersion, avMode, avSignatureVersion, avEngineVersion, avPlatformVersion, , quickScanResult, quickScanError, fullScanResult, , fullScanError, avIsSignatureUpToDate, avIsEngineUpToDate, , , avIsPlatformUpToDaterbacGroupId
• $top com o valor máximo de 10 000.
• $skip

1.2 Permissões

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

1.3 URL (pedido HTTP)

URL: GET: /api/deviceavinfo

1.3.1 Cabeçalhos de pedido

1.3.2 Corpo do pedido

Vazio

Resposta 1.3.3

Se for bem-sucedido, este método devolve 200 OK com uma lista de detalhes do estado de funcionamento do dispositivo.

1.4 Parâmetros

• O tamanho da página predefinido é 20
• Veja exemplos em Consultas OData com o Microsoft Defender para Endpoint.

1.5 Propriedades

Veja: 1.3 Exportar as propriedades da API de detalhes do estado de funcionamento do antivírus do dispositivo (resposta JSON)

Suporta consultas OData V4.

1.6 Exemplo

Exemplo de pedido

Eis um pedido de exemplo:

GET https://api.securitycenter.microsoft.com/api/deviceavinfo

Exemplo de resposta

Eis uma resposta de exemplo:

{

    @odata.context: "https://api.securitycenter.microsoft.com/api/$metadata#DeviceAvInfo",

"value": [{

            "id": "Sample Guid",

            "machineId": "Sample Machine Guid",

            "computerDnsName": "appblockstg1",

            "osKind": "windows",

            "osPlatform": "Windows10",

            "osVersion": "10.0.19044.1865",

            "avMode": "0",

            "avSignatureVersion": "1.371.1279.0",

            "avEngineVersion": "1.1.19428.0",

            "avPlatformVersion": "4.18.2206.108",

            "lastSeenTime": "2022-08-02T19:40:45Z",

            "quickScanResult": "Completed",

            "quickScanError": "",

            "quickScanTime": "2022-08-02T18:40:15.882Z",

            "fullScanResult": "",

            "fullScanError": "",

            "fullScanTime": null,

            "dataRefreshTimestamp": "2022-08-02T21:16:23Z",

            "avEngineUpdateTime": "2022-08-02T00:03:39Z",

            "avSignatureUpdateTime": "2022-08-02T00:03:39Z",

            "avPlatformUpdateTime": "2022-06-20T16:59:35Z",

            "avIsSignatureUpToDate": "True",

            "avIsEngineUpToDate": "True",

            "avIsPlatformUpToDate": "True",

            "avSignaturePublishTime": "2022-08-02T00:03:39Z",

            "rbacGroupName": "TVM1",

            "rbacGroupId": 4415

        },

        ...

     ]

}

2 Exportar relatórios de estado de funcionamento (através de ficheiros)

Descrição do método da API 2.1

Esta resposta da API contém todos os dados do estado de funcionamento e estado do Antivírus por dispositivo. Devolve uma tabela com uma entrada para cada combinação exclusiva de:

• DeviceId
• nome do dispositivo
• Modo AV
• Estado atualizado
• Resultados da análise

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

2.2 Permissões

É necessária uma das seguintes permissões para chamar esta API.

Para saber mais, incluindo como escolher permissões, consulte Utilizar as APIs do Microsoft Defender para Endpoint para obter detalhes.

2.3 URL

GET /api/machines/InfoGatheringExport

2.4 Parâmetros

• sasValidHours: o número de horas durante as quais os URLs de transferência serão válidos (Máximo de 24 horas).

2.5 Propriedades

Veja: 1.4 Exportar propriedades da API de detalhes do estado de funcionamento do antivírus do dispositivo (através de ficheiros).

2.6 Exemplos

2.6.1 Exemplo de pedido

Eis um pedido de exemplo:

GET https://api-us.securitycenter.contoso.com/api/machines/InfoGatheringExport

2.6.2 Exemplo de resposta

Eis uma resposta de exemplo:

{

   "@odata.context": "https://api-us.securitycenter.windows.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",

   "exportFiles": [

       "https://tvmexportexternalprdeus.blob.core.windows.net/temp-../2022-08-02/2201/InfoGatheringExport/json/OrgId=../_RbacGroupId=../part-00055-12fc2fcd-8f56-4e09-934f-e8efe7ce74a0.c000.json.gz?sv=2020-08-04&st=2022-08-02T22%3A47%3A11Z&se=2022-08-03T01%3A47%3A11Z&sr=b&sp=r&sig=..",

       "https://tvmexportexternalprdeus.blob.core.windows.net/temp-../2022-08-02/2201/InfoGatheringExport/json/OrgId=../_RbacGroupId=../part-00055-12fc2fcd-8f56-4e09-934f-e8efe7ce74a0.c000.json.gz?sv=2020-08-04&st=2022-08-02T22%3A47%3A11Z&se=2022-08-03T01%3A47%3A11Z&sr=b&sp=r&sig=.."

   ],


   "generatedTime": "2022-08-02T22:01:00Z"


}

Consulte também

Exportar métodos e propriedades do estado de funcionamento do dispositivo

Relatórios de estado de funcionamento e conformidade do dispositivo