הוספה, עדכון או מחיקה של הגדרת סריקה

מאמר
08/14/2024

חל על:

רוצה להתנסות ב- Microsoft Defender עבור נקודת קצה? הירשם לקבלת גירסת ניסיון ללא תשלום.

רוצה להיתקל בניהול פגיעויות של Microsoft Defender? קבל מידע נוסף על האופן שבו תוכל להירשם לניסיון הציבורי של ניהול פגיעויות של Microsoft Defender Public Preview.

חשוב

חלק מהמידע במאמר זה מתייחס למוצר שהופץ מראש, אשר עשוי להיות שונה באופן משמעותי לפני ההפצה המסחרית שלו. Microsoft אינה מעניקה כל אחריות, מפורשת או משתמעת, ביחס למידע המסופק כאן.

הערה

אם אתה לקוח של ממשלת ארה"ב, השתמש בURI המפורטים ב - Microsoft Defender for Endpoint עבור לקוחות של ממשלת ארה"ב.

עצה

לקבלת ביצועים טובים יותר, באפשרותך להשתמש בשרת קרוב יותר למיקום הגיאוגרפי שלך:

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

API להוספה, עדכון או מחיקה של סריקה מאומתת.

מגבלות

דרג מגבלות עבור API זה הן 100 שיחות בדקה ו- 1,500 שיחות בשעה.

באפשרותך לפרסם במחשבים שנראה לאחרונה בהתאם לת תקופת השמירה שתצורתה נקבעה.

הרשאות

אחת מההרשאות הבאות נדרשת כדי לקרוא ל- API זה. לקבלת מידע נוסף, כולל כיצד לבחור הרשאות, ראה שימוש ב - Defender for Endpoint API.

סוג הרשאה	הרשאה	שם תצוגה של הרשאה
יישום	Machine.ReadWrite.All	קרא וכתוב את כל מידע הסריקה.
מוסמך (חשבון בעבודה או בבית ספר)	Machine.Read.Write	קרא וכתוב את כל מידע הסריקה.

הערה

בעת השגת אסימון באמצעות אישורי משתמש:

כדי להציג נתונים דרושה למשתמש לפחות הרשאת התפקיד הבאה: ViewDataTvmViewData או (ראה יצירה וניהול של תפקידים לקבלת מידע נוסף)
כדי לערוך נתונים דרושה למשתמש לפחות הרשאת התפקיד הבאה: ManageSecurity (ראה יצירה וניהול של תפקידים לקבלת מידע נוסף)

בקשת HTTP

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

כותרות בקשות

Name	סוג	תיאור
ההרשאות	מחרוזת	נושא {token}. נדרש .
סוג תוכן	מחרוזת	application/json. נדרש .

גוף הבקשה

בגוף הבקשה, ספק אובייקט JSON עם הפרמטרים הבאים:

פרמטר	סוג	תיאור
סוג סריקה	ערך ספירה	סוג הסריקה. הערכים האפשריים הם: "Windows", "רשת". נדרש .
שם סריקה	מחרוזת	שם הסריקה. נדרש .
isActive	בוליאני	מצב ההפעלה הפעילה של הסריקה. נדרש .
יעד	מחרוזת	רשימת יעדים המופרדים באמצעות פסיק לסריקה, כתובות IP או שמות מארחים. נדרש .
intervalInHours	Int	מרווח הזמן שבו מופעלת הסריקה. נדרש .
סוג יעד	מחרוזת	סוג היעד בשדה היעד. הסוגים האפשריים הם "כתובת IP" או "Hostname". ערך ברירת המחדל הוא כתובת IP. נדרש .
סורק - מדפסת	חפץ	מזהה מחשב. נדרש.
scanAuthenticationParams	חפץ	אובייקט המייצג את הפרמטרים של האימות, ראה מאפייני אובייקט של פרמטרים של אימות עבור השדות הצפויים. מאפיין זה הכרחי בעת יצירת סריקה חדשה והוא אופציונלי בעת עדכון סריקה.

תגובה

אם שיטה זו הצליחה, היא מחזירה 200 - קוד תגובה של אישור ואת הגדרת הסריקה החדשה או המעודכנת בגוף התגובה.

בקשה לדוגמה להוספת סריקה חדשה

להלן דוגמה לבקשה שתוסיף סריקה חדשה.

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
    }
}

תגובה לדוגמה

להלן דוגמה לתגובה.

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

}

בקשה לדוגמה לעדכון סריקה

להלן דוגמה לבקשה המעדמנת סריקה.

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
    }
 }

דוגמה לתגובה