إضافة تعريف فحص أو تحديثه أو حذفه

ينطبق على:

هل تريد تجربة Defender لنقطة النهاية؟ التسجيل للحصول على إصدار تجريبي مجاني.

هل تريد تجربة إدارة الثغرات الأمنية في Microsoft Defender؟ تعرف على المزيد حول كيفية التسجيل في إدارة الثغرات الأمنية في Microsoft Defender الإصدار التجريبي للمعاينة العامة.

هام

تتعلق بعض المعلومات الواردة في هذه المقالة بالناتج الذي تم إصداره مسبقًا والذي قد يتم تعديله بشكل كبير قبل إصداره تجاريًا. لا تقدم Microsoft أي ضمانات، يتم التعبير عنها أو تضمينها، فيما يتعلق بالمعلومات المقدمة هنا.

ملاحظة

إذا كنت أحد عملاء حكومة الولايات المتحدة، فالرجاء استخدام معرفات URI المدرجة في Microsoft Defender لنقطة النهاية لعملاء حكومة الولايات المتحدة.

تلميح

للحصول على أداء أفضل، يمكنك استخدام الخادم الأقرب إلى موقعك الجغرافي:

  • 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

وصف واجهة برمجة التطبيقات

واجهة برمجة التطبيقات لإضافة فحص مصادق عليه أو تحديثه أو حذفه.

القيود

قيود المعدل لواجهة برمجة التطبيقات هذه هي 100 استدعاء في الدقيقة و1500 مكالمة في الساعة.

يمكنك النشر على الأجهزة التي شوهدت آخر مرة وفقا لفترة الاستبقاء التي تم تكوينها.

الأذونات

أحد الأذونات التالية مطلوب لاستدعاء واجهة برمجة التطبيقات هذه. لمعرفة المزيد، بما في ذلك كيفية اختيار الأذونات، راجع استخدام واجهات برمجة تطبيقات Defender لنقطة النهاية.

نوع الإذن اذن اسم عرض الإذن
Application Machine.ReadWrite.All قراءة وكتابة جميع معلومات الفحص.
مفوض (حساب العمل أو المؤسسة التعليمية) Machine.Read.Write قراءة وكتابة جميع معلومات الفحص.

ملاحظة

عند الحصول على رمز مميز باستخدام بيانات اعتماد المستخدم:

  • لعرض البيانات التي يحتاجها المستخدم للحصول على إذن الدور التالي على الأقل: ViewData أو TvmViewData (راجع الإنشاء الأدوار وإدارتها لمزيد من المعلومات)
  • لتحرير البيانات، يحتاج المستخدم إلى الحصول على إذن الدور التالي على الأقل: ManageSecurity (راجع الإنشاء الأدوار وإدارتها لمزيد من المعلومات)

طلب HTTP

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

عناوين الطلبات

الاسم نوع الوصف
التخويل سلسلة الحامل {token}. مطلوب.
نوع المحتوى سلسله application/json. مطلوب.

نص الطلب

في نص الطلب، قم بتوفير كائن JSON بالمعلمات التالية:

المعلمه نوع الوصف
نوع الفحص التعداد نوع الفحص. القيم المحتملة هي: "Windows"، "الشبكة". مطلوب.
اسم الفحص سلسلة اسم الفحص. مطلوب.
isActive منطقي حالة ما إذا كان الفحص قيد التشغيل بشكل نشط. مطلوب.
الهدف سلسلة قائمة مفصولة بفواصل من الأهداف المراد فحصها، إما عناوين IP أو أسماء المضيفين. مطلوب.
intervalInHours الباحث الفاصل الزمني الذي يتم فيه تشغيل الفحص. مطلوب.
targetType سلسلة نوع الهدف في الحقل الهدف. الأنواع المحتملة هي "عنوان IP" أو "اسم المضيف". القيمة الافتراضية هي عنوان 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
    }
 }

مثال على الاستجابة

فيما يلي مثال على الاستجابة.

{
    "@odata.context": "https://localhost:1059/api/$metadata#DeviceAuthenticatedScanDefinitions/$entity",
    "id": "289224fb-1686-472c-9751-5555960854ca",
    "scanType": "Windows",
    "scanName": "Test Update Windows scan",
    "isActive": false,
    "target": "127.0.0.2,127.0.0.3",
    "orgId": "0335a792-18d2-424b-aeed-559567054570",
    "intervalInHours": 1,
    "createdBy": "userName@microsoft.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
    }
}

مثال على طلب حذف عمليات الفحص

فيما يلي مثال على طلب يحذف عمليات الفحص.

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/BatchDelete
{
  "ScanDefinitionIds": ["td32f17af-5cc2-4e4e-964a-4c4ef7d216e2", "ab32g20af-5dd2-4a5e-954a-4c4ef7d216e2"],
}

تلميح

هل تريد معرفة المزيد؟ Engage مع مجتمع أمان Microsoft في مجتمعنا التقني: Microsoft Defender لنقطة النهاية Tech Community.