Legge til, oppdatere eller slette en skannedefinisjon

Artikkel
08/14/2024

Gjelder for:

Vil du oppleve Microsoft Defender for endepunkt? Registrer deg for en gratis prøveperiode.

Vil du oppleve Microsoft Defender Vulnerability Management? Finn ut mer om hvordan du kan registrere deg for prøveversjonen av Microsoft Defender Vulnerability Management public preview.

Viktig

Noe informasjon i denne artikkelen er knyttet til et forhåndsutgitt produkt, som kan endres vesentlig før det utgis kommersielt. Microsoft gir ingen garantier, uttrykt eller underforstått, med hensyn til informasjonen som er oppgitt her.

Obs!

Hvis du er us Government-kunde, kan du bruke URI-ene som er oppført i Microsoft Defender for Endpoint for US Government-kunder.

Tips

Hvis du vil ha bedre ytelse, kan du bruke serveren nærmere geografisk plassering:

us.api.security.microsoft.com
eu.api.security.microsoft.com
uk.api.security.microsoft.com
au.api.security.microsoft.com
swa.api.security.microsoft.com
ina.api.security.microsoft.com

API-beskrivelse

API for å legge til, oppdatere eller slette en godkjent skanning.

Begrensninger

Satsbegrensninger for denne API-en er 100 oppkall per minutt og 1500 anrop per time.

Du kan legge ut på maskiner som sist ble sett i henhold til konfigurert oppbevaringsperiode.

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 Defender for endepunkt-API-er.

Tillatelsestype	Tillatelse	Visningsnavn for tillatelse
Program	Machine.ReadWrite.All	Les og skriv all skanneinformasjon.
Delegert (jobb- eller skolekonto)	Machine.Read.Write	Les og skriv all skanneinformasjon.

Obs!

Når du skaffer et token ved hjelp av brukerlegitimasjon:

Hvis du vil vise data, må brukeren minst ha følgende rolletillatelse: ViewData eller TvmViewData (Se Opprette og behandle roller for mer informasjon)
Hvis du vil redigere data, må brukeren minst ha følgende rolletillatelse: ManageSecurity (Se Opprette og behandle roller for mer informasjon)

HTTP-forespørsel

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions

Forespørselshoder

Navn	Type:	Beskrivelse
Autorisasjon	Streng	Bærer {token}. Obligatorisk.
Innholdstype	streng	program/json. Obligatorisk.

Forespørselstekst

Angi et JSON-objekt med følgende parametere i forespørselsteksten:

Parameter	Type:	Beskrivelse
scanType	Opplisting	Typen skanning. Mulige verdier er: «Windows», «Nettverk». Obligatorisk.
scanName	Streng	Navnet på skanningen. Obligatorisk.
isActive	Boolsk	Status for om skanningen kjører aktivt. Obligatorisk.
mål	Streng	En kommadelt liste over mål som skal skannes, enten IP-adresser eller vertsnavn. Obligatorisk.
intervalInHours	Int	Intervallet der skanningen kjøres. Obligatorisk.
targetType	Streng	Måltypen i målfeltet. Mulige typer er IP-adresse eller vertsnavn. Standardverdien er IP-adresse. Obligatorisk.
scannerAgent	Objekt	maskin-ID. Obligatorisk.
scanAuthenticationParams	Objekt	Et objekt som representerer godkjenningsparameterne, se objektegenskaper for godkjenningsparametere for forventede felt. Denne egenskapen er obligatorisk når du oppretter en ny skanning og er valgfri når du oppdaterer en skanning.

Svar

Hvis dette lykkes, returnerer denne metoden 200 – OK-svarkode og den nye eller oppdaterte skannedefinisjonen i svarteksten.

Eksempelforespørsel om å legge til en ny skanning

Her er et eksempel på en forespørsel som legger til en ny skanning.

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions

 {
"scanType": "Windows", 
"scanName": "Test Windows scan", 
"isActive": true, 
"target": "127.0.0.1", 
"intervalInHours": 1, 
"targetType": "Ip",
"scannerAgent": {
    "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77",
},
"scanAuthenticationParams": { 
    "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams", 
    "type": "Kerberos", 
    "username": "username", 
    "domain": "password",
    "isGmsaUser": true
    }
}

Eksempelsvar

Her er et eksempel på svaret.

 {
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#DeviceAuthenticatedScanDefinitions/$entity",
    "id": "289224fb-1686-472c-9751-5555960854ca",
    "scanType": "Windows",
    "scanName": "Test Windows scan",
    "isActive": true,
    "target": "127.0.0.1",
    "orgId": "0335a792-18d2-424b-aeed-559567054570",
    "intervalInHours": 1,
    "createdBy": "username@test.com",
    "targetType": "Ip",
    "scanAuthenticationParams": null,
    "scannerAgent": {
        "id": "0335a792-18d2-424b-aeed-559567054570_ eb663a27ae9d032f61bc268a79eedf14c4b90f77",
        "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77",
        "machineName": "DESKTOP-TEST",
        "lastSeen": "2023-01-04T09:40:03.2787058Z",
        "assignedApplicationId": "ae4a5cde-b4a1-4b76-8635-458b2cf15752",
        "scannerSoftwareVersion": "7.6.0.0",
        "lastCommandExecutionTimestamp": "2023-01-04T09:33:16Z",
        "mdeClientVersion": "10.8295.22621.1010"
    },
    "latestScan": {
        "status": null,
        "failureReason": null,
        "executionDateTime": null
    }

}

Eksempelforespørsel om å oppdatere en skanning

Her er et eksempel på en forespørsel som oppdaterer en skanning.

PATCH  https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/289224fb-1686-472c-9751-5555960854ca

{
"scanName": "Test Update Windows scan", 
"isActive": false, 
"target": "127.0.0.2,127.0.0.3", 
"intervalInHours": 1, 
"targetType": "Ip",
"scanAuthenticationParams": { 
    "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams", 
    "type": "Kerberos", 
    "username": "username", 
    "domain": "password",
    "isGmsaUser": true
    }
 }

Eksempel på svar