Eksporter lagerbeholdning for maskinvare- og fastvarevurdering per enhet

Artikkel
04/28/2024

Gjelder for:

Vil du oppleve Microsoft Defender Vulnerability Management? Mer informasjon om hvordan du kan registrere deg for prøveversjonen av Microsoft Defender Vulnerability Management offentlig forhåndsvisning.

Det finnes ulike API-kall for å hente ulike typer data. Generelt inneholder hvert API-kall nødvendige data for enheter i organisasjonen.

JSON-svar API-en henter alle data i organisasjonen som JSON-svar. Denne metoden er best for små organisasjoner med mindre enn 100 K-enheter. Svaret er paginert, slik at du kan bruke @odata.nextLink-feltet fra svaret til å hente de neste resultatene.
via filer Denne API-løsningen gjør det mulig å hente større datamengder raskere og mer pålitelig. Det anbefales derfor for store organisasjoner, med mer enn 100 K-enheter. Denne API-en henter alle data i organisasjonen som nedlastingsfiler. Svaret inneholder nettadresser for å laste ned alle dataene fra Azure Storage. Du kan laste ned data fra Azure Storage på følgende måte:
- Kall API-en for å få en liste over nedlasting av nettadresser med alle organisasjonsdataene.
- Last ned alle filene ved hjelp av url-adressene for nedlasting, og behandle dataene slik du vil.

Data som samles inn ved hjelp av JSON-svar eller via filer, er det gjeldende øyeblikksbildet av gjeldende tilstand. Den inneholder ikke historiske data. For å samle inn historiske data må kundene lagre dataene i sine egne datalagringer.

Obs!

Med mindre annet er angitt, er alle oppførte eksportmetoder for maskinvare- og fastvarevurdering full eksport og etter enhet (også referert til som per enhet)

1. Eksporter maskinvare- og fastvarevurdering (JSON-svar)

Beskrivelse av API-metode 1.1

Returnerer alle maskinvare- og fastvarevurderinger for alle enheter per enhet. Den returnerer en tabell med en separat oppføring for hver unike kombinasjon av deviceId og componentType.

1.1.1 Begrensninger

Maksimal sidestørrelse er 200 000.
Satsbegrensninger for denne API-en er 30 oppkall per minutt og 1000 anrop per time.

1.2 Tillatelser

Én av følgende tillatelser er nødvendig for å kalle opp denne API-en. Hvis du vil ha mer informasjon, inkludert hvordan du velger tillatelser, kan du se Bruke Microsoft Defender for endepunkt API-er for mer informasjon.

Tillatelsestype	Tillatelse	Visningsnavn for tillatelse
Program	Software.Read.All	Les informasjon om programvare for trussel- og sårbarhetsbehandling
Delegert (jobb- eller skolekonto)	Software.Read	Les informasjon om programvare for trussel- og sårbarhetsbehandling

1.3 URL-adresse

GET api/machines/HardwareFirmwareInventoryByMachine

1.4 Parametere

pageSize (standard = 50 000): Antall resultater som svar.
$top: Antall resultater som skal returneres (returnerer @odata.nextLink ikke, og henter derfor ikke alle dataene).

1.5 Egenskaper (JSON-svar)

Obs!

Hver post er omtrent 1 kB med data. Du bør ta hensyn til dette når du velger riktig pageSize-parameter.

Noen ekstra kolonner kan returneres i svaret. Disse kolonnene er midlertidige og kan bli fjernet. Bruk bare de dokumenterte kolonnene.

Egenskapene som er definert i tabellen nedenfor, er oppført alfabetisk etter egenskaps-ID. Når du kjører denne API-en, returneres ikke nødvendigvis resultatet i den samme rekkefølgen som er oppført i denne tabellen.

Egenskap (ID)	Datatype	Beskrivelse
Deviceid	Streng	Unik identifikator for enheten i tjenesten.
rbacGroupId	Int	Gruppe-ID for rollebasert tilgangskontroll (RBAC). Hvis enheten ikke er tilordnet til en RBAC-gruppe, blir verdien «Ikke tilordnet». Hvis organisasjonen ikke inneholder rbac-grupper, blir verdien «Ingen».
rbacGroupName	Streng	Rollebasert tilgangskontrollgruppe (RBAC). Hvis enheten ikke er tilordnet til en RBAC-gruppe, blir verdien «Ikke tilordnet». Hvis organisasjonen ikke inneholder rbac-grupper, blir verdien «Ingen».
deviceName	Streng	Fullstendig domenenavn (FQDN) for enheten.
componentType	Streng	Type maskinvare- eller fastvarekomponent.
Produsenten	Streng	Produsent av en bestemt maskinvare- eller fastvarekomponent.
componentName	Streng	Navnet på en bestemt maskinvare- eller fastvarekomponent.
componentVersion	Streng	Versjon av en bestemt maskinvare- eller fastvarekomponent.
additionalFields	Streng	Tilleggsinformasjon om komponentene i JSON-matriseformat.

1.6 Eksempel

1.6.1 Eksempel på forespørsel

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

1.6.2 Svareksempel

      {
        "@odata.context": "https://api-df.securitycenter.microsoft.com/api/$metadata#Collection(microsoft.windowsDefenderATP.api.AssetHardwareFirmware)",
        "value":[
        {
            "deviceId": "49126b9e4a5473b5229c73799e9e55c48668101b",
            "rbacGroupId": 39,
            "rbacGroupName": "testO6343398Gq31",
            "deviceName": "testmachine5",
            "componentType": "Hardware",
            "manufacturer": "razer",
            "componentName": "blade_15_advanced_model_(mid_2021)_-_rz09-0409",
            "componentVersion": "7.04",
            "additionalFields": "{\"SystemSKU\":\"RZ09-0409CE53\",\"BaseBoardManufacturer\":\"Razer\",\"BaseBoardProduct\":\"CH570\",\"BaseBoardVersion\":\"4\",\"DeviceFamily\":\"Workstation\"}"
          }  
        ]  
      },

2. Eksportere maskinvare- og fastvarevurdering (via filer)

Beskrivelse av API-metode 2.1

Returnerer alle maskinvare- og fastvarevurderinger for alle enheter per enhet. Den returnerer en tabell med en separat oppføring for hver unike kombinasjon av DeviceId, ComponentType og ComponentName.

2.1.1 Begrensninger

Satsbegrensninger for denne API-en er fem kall per minutt og 20 oppkall per time.

2.2 Tillatelser

Tillatelsestype	Tillatelse	Visningsnavn for tillatelse
Program	Software.Read.All	Les informasjon om programvare for trussel- og sårbarhetsbehandling
Delegert (jobb- eller skolekonto)	Software.Read	Les informasjon om programvare for trussel- og sårbarhetsbehandling

2.3 URL-adresse

GET /api/machines/HardwareFirmwareInventoryExport

2.4 Parametere

sasValidHours: Antall timer nedlastings-URL-adressene skal være gyldige for (maksimalt 24 timer).

2.5 Egenskaper (JSON-svar)

Obs!

Filene er gzip komprimert & i flerlinjet Json-format.

URL-adressene for nedlasting er bare gyldige i 3 timer. Ellers kan du bruke parameteren.

Hvis du vil maksimere nedlastingshastigheten, må du kontrollere at du laster ned dataene fra det samme Azure-området der dataene befinner seg.

Hver post er omtrent 1 KB med data. Du bør ta hensyn til dette når du velger pageSize-parameteren som fungerer for deg.

Noen ekstra kolonner kan returneres i svaret. Disse kolonnene er midlertidige og kan bli fjernet. Bruk bare de dokumenterte kolonnene.

Egenskap (ID)	Datatype	Beskrivelse
Eksportere filer	Streng[matrise]	En liste over nedlastings-URL-adresser for filer som holder det gjeldende øyeblikksbildet av organisasjonen.
GeneratedTime	Datetime	Tidspunktet da eksporten ble generert.

2.6 Eksempel

2.6.1 Eksempel på forespørsel

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

2.6.2 Svareksempel

    {
        "@odata.context":"https://api-df.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_RbacGroupId=39/part-00999-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=muN8Sq6rVN6bFMtR0u3S5Wzh3D9qNPgN5vpU7lWvULg%3D",
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_RbacGroupId=9/part-00968-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=%2BA0%2B4qOOBCS5E4UenJPbMdLM%2FkbXHnz%2F1pvfSOCq%2F2s%3D",
        "https://tvmexportstrprdcane.blob.core.windows.net/tvm-firmware-export/2022-07-11/1101/FirmwareHardwareExport/json/OrgId=3837d1f5-0d51-40cb-a99d-69ebedc9dcc8/_RbacGroupId=9/part-00969-71eea973-1bb1-4d0a-829d-80cb07aff5d8.c000.json.gz?sv=2020-08-04&st=2022-07-11T13%3A10%3A06Z&se=2022-07-11T16%3A10%3A06Z&sr=b&sp=r&sig=sZUgYMwSr5zk6BZvS%2BoYIWlHJWk2oJ7YjiC8R26S1X4%3D"
    ],
    "generatedTime": "2022-07-11T11:01:00Z"

   }

Del via

Eksporter lagerbeholdning for maskinvare- og fastvarevurdering per enhet

1. Eksporter maskinvare- og fastvarevurdering (JSON-svar)

Beskrivelse av API-metode 1.1

1.1.1 Begrensninger

1.2 Tillatelser

1.3 URL-adresse

1.4 Parametere

1.5 Egenskaper (JSON-svar)

1.6 Eksempel

1.6.1 Eksempel på forespørsel

1.6.2 Svareksempel

2. Eksportere maskinvare- og fastvarevurdering (via filer)

Beskrivelse av API-metode 2.1

2.1.1 Begrensninger

2.2 Tillatelser

2.3 URL-adresse

2.4 Parametere

2.5 Egenskaper (JSON-svar)

2.6 Eksempel

2.6.1 Eksempel på forespørsel

2.6.2 Svareksempel

Tilbakemeldinger

Flere ressurser