Exportera enhetens antivirushälsorapport

Gäller för:

• Microsoft Defender för Endpoint Abonnemang 1
• Microsoft Defender för Endpoint Abonnemang 2
• Microsoft Defender XDR

Vill du uppleva Microsoft Defender för Endpoint? Registrera dig för en kostnadsfri utvärderingsversion.

Det här API:et har två metoder för att hämta microsoft Defender Antivirus-enhetens antivirushälsoinformation:

• Metod ett:1 Exportera hälsorapportering (JSON-svar) Metoden hämtar alla data i din organisation som JSON-svar. Den här metoden passar bäst för små organisationer med mindre än 100 K-enheter. Svaret är sidnumrerat, så du kan använda fältet @odata.nextLink från svaret för att hämta nästa resultat.

• Metod två:2 Exportera hälsorapportering (via filer) Med den här metoden kan du hämta större mängder data snabbare och mer tillförlitligt. Därför rekommenderas det för stora organisationer med fler än 100 K-enheter. Det här API:et hämtar alla data i din organisation som nedladdningsfiler. Svaret innehåller URL:er för att ladda ned alla data från Azure Storage. Med det här API:et kan du ladda ned alla dina data från Azure Storage på följande sätt:

  • Anropa API:et för att hämta en lista över nedladdnings-URL:er med alla organisationsdata.
  • Ladda ned alla filer med hjälp av nedladdnings-URL:er och bearbeta data som du vill.

Data som samlas in med antingen "JSON-svar eller via filer" är den aktuella ögonblicksbilden av det aktuella tillståndet. Den innehåller inte historiska data. För att samla in historiska data måste kunderna spara data i sina egna datalagringar. Se Exportera API-metoder och egenskaper för information om enhetshälsa.

1 Exportera hälsorapportering (JSON-svar)

Beskrivning av 1.1 API-metod

Det här API:et hämtar en lista över microsoft Defender Antivirus-enhetens antivirushälsoinformation. Returnerar en tabell med en post för varje unik kombination av:

• DeviceId
• Enhetsnamn
• AV-läge
• Aktuell status
• Genomsökningsresultat

1.1.1 Begränsningar

• maximal sidstorlek är 200 000
• Frekvensbegränsningar för det här API:et är 30 anrop per minut och 1 000 anrop per timme.

Operatorer som stöds av OData

• $filterpå: machineId, computerDnsName, osKind, osPlatform, osVersion, avMode, avSignatureVersion, avEngineVersion, avPlatformVersion, quickScanResult, quickScanError, fullScanResult, fullScanError, avIsSignatureUpToDate, avIsEngineUpToDate, , avIsPlatformUpToDaterbacGroupId
• $top med maxvärdet 10 000.
• $skip

1.2 Behörigheter

En av följande behörigheter krävs för att anropa det här API:et. Mer information, inklusive hur du väljer behörigheter, finns i Använda Api:er för Microsoft Defender för Endpoint för mer information.

1.3 URL (HTTP-begäran)

URL: GET: /api/deviceavinfo

1.3.1 Begärandehuvuden

1.3.2 Begärandetext

Tom

1.3.3 Svar

Om det lyckas returnerar den här metoden 200 OK med en lista över information om enhetens hälsotillstånd.

1.4 Parametrar

• Standardstorleken för sidan är 20
• Se exempel på OData-frågor med Microsoft Defender för Endpoint.

1.5 Egenskaper

Se: 1.3 Exportera egenskaper för API:et för antivirusskyddsinformation (JSON-svar)

Stöder OData V4-frågor.

1.6 Exempel

Exempel på begäran

Här är en exempelbegäran:

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

Svarsexempel

Här är ett exempel på ett svar:

{

    @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 Exportera hälsorapportering (via filer)

Beskrivning av 2.1 API-metod

Det här API-svaret innehåller alla data om antivirushälsa och status per enhet. Returnerar en tabell med en post för varje unik kombination av:

• DeviceId
• enhetsnamn
• AV-läge
• Aktuell status
• Genomsökningsresultat

2.1.2 Begränsningar

• Maximal sidstorlek är 200 000.
• Frekvensbegränsningar för det här API:et är 30 anrop per minut och 1 000 anrop per timme.

2.2 Behörigheter

En av följande behörigheter krävs för att anropa det här API:et.

Mer information, inklusive hur du väljer behörigheter, finns i Använda Api:er för Microsoft Defender för Endpoint för mer information.

2.3 URL

GET /api/machines/InfoGatheringExport

2.4 Parametrar

• sasValidHours: Antalet timmar som nedladdnings-URL:erna är giltiga i (högst 24 timmar).

2.5 Egenskaper

Se: 1.4 Exportera api-egenskaper för antivirusskyddsinformation (via filer).

2.6 Exempel

2.6.1 Exempel på begäran

Här är en exempelbegäran:

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

2.6.2 Svarsexempel

Här är ett exempel på ett svar:

{

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


}

Se även

Exportera enhetens hälsometoder och egenskaper

Rapportering om enhetens hälsa och efterlevnad