واجهة برمجة تطبيقات REST Defender for Cloud Apps
توضح هذه المقالة كيفية التفاعل مع Defender for Cloud Apps عبر HTTPS.
توفر واجهة برمجة تطبيقات Microsoft Defender for Cloud Apps وصولا برمجيا إلى Defender for Cloud Apps من خلال نقاط نهاية REST API. يمكن للتطبيقات استخدام واجهة برمجة التطبيقات لتنفيذ عمليات القراءة والتحديث على البيانات والكائنات Defender for Cloud Apps. على سبيل المثال، تدعم واجهة برمجة تطبيقات Defender for Cloud Apps العمليات الشائعة التالية لكائن مستخدم:
- تحميل ملفات السجل لاكتشاف السحابة
- إنشاء برامج نصية للكتلة
- سرد الأنشطة والتنبيهات
- تجاهل التنبيهات أو حلها
بنية عنوان URL لواجهة برمجة التطبيقات
لاستخدام واجهة برمجة تطبيقات Defender for Cloud Apps، يجب أولا الحصول على عنوان URL لواجهة برمجة التطبيقات من المستأجر الخاص بك. يستخدم عنوان URL لواجهة برمجة التطبيقات التنسيق التالي: https://<portal_url>/api/<endpoint>
.
للحصول على عنوان URL لواجهة برمجة التطبيقات Defender for Cloud Apps للمستأجر الخاص بك، قم بالخطوات التالية:
في مدخل Microsoft Defender، حدد الإعدادات. ثم اختر تطبيقات السحابة. ضمن النظام، حدد حول.
في Defender for Cloud Apps حول الشاشة، يمكنك مشاهدة عنوان URL لواجهة برمجة التطبيقات.
بمجرد أن يكون لديك عنوان URL لواجهة برمجة التطبيقات، أضف اللاحقة /api
إليه للحصول على عنوان URL لواجهة برمجة التطبيقات. على سبيل المثال، إذا كان عنوان URL الخاص بمدخلك هو https://mytenant.us2.contoso.com
، فإن عنوان URL لواجهة برمجة التطبيقات هو https://mytenant.us2.portal.cloudappsecurity.com/api
.
الرموز المميزة لواجهة برمجة التطبيقات
يتطلب Defender for Cloud Apps رمزا مميزا لواجهة برمجة التطبيقات في رأس جميع طلبات واجهة برمجة التطبيقات إلى الخادم، مثل ما يلي:
Authorization: Token <your_token_key>
أين <your_token_key>
هو الرمز المميز الشخصي لواجهة برمجة التطبيقات.
لمزيد من المعلومات حول رموز واجهة برمجة التطبيقات المميزة، راجع إدارة الرموز المميزة لواجهة برمجة التطبيقات.
الرموز المميزة لواجهة برمجة التطبيقات - مثال
curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint"
ما الإجراءات المدعومة؟
يصف الجدول التالي الإجراءات المدعومة:
مورد | أفعال HTTP | مسارات URI |
---|---|---|
الانشطه | GET أو POST | /api/v1/activities/ |
التنبيهات | GET أو POST | /api/v1/alerts/ |
إثراء البيانات | GET أو POST أو DELETE | /api/subnet/ |
الكيانات | GET أو POST | /api/v1/entities/ |
الملفات | GET أو POST | /api/v1/files/ |
حيث يمثل المورد مجموعة من الكيانات ذات الصلة.
ما أنواع الحقول المعتمدة؟
يصف الجدول التالي أنواع الحقول المدعومة:
ميدان | الوصف |
---|---|
خيط | سلسلة نصية |
منطقيه | قيمة منطقية تمثل true/false |
العدد الصحيح | عدد صحيح موقع 32 بت |
الطابع الزمني | مللي ثانية منذ الحقبة |
الطوابع الزمنية
تشير إشارات الطوابع الزمنية في واجهة برمجة تطبيقات Defender for Cloud Apps إلى الطابع الزمني Unix بالمللي ثانية. يتم تحديد هذا الطابع الزمني من خلال عدد المللي ثانية منذ 1970-01-01 0:00:00. يمكنك استخدام cmdlet PowerShell get-date لتحويل التواريخ إلى طوابع زمنية.
حدود
يمكنك اختيار الحد من طلباتك عن طريق توفير معلمة حد في الطلب.
يتم دعم الأساليب التالية لتوفير معلمة الحد:
- ترميز عنوان URL (مع
Content-Type: application/x-www-form-urlencoded
عنوان) - بيانات النموذج
- نص JSON (مع
Content-Type: multipart/form-data
ورأس حد مناسب)
ملاحظة
- إذا لم يتم توفير حد، تعيين افتراضي قدره 100.
- تقتصر الاستجابات لجميع الطلبات التي تم إجراؤها باستخدام الرمز المميز لواجهة برمجة التطبيقات على 100 عنصر كحد أقصى.
- حد التقييد لجميع طلبات واجهة برمجة التطبيقات هو 30 طلبا في الدقيقة لكل مستأجر.
مرشحات
عندما يكون لديك عدد كبير من النتائج، ستجد أنه من المفيد ضبط الطلبات باستخدام عوامل التصفية. يصف هذا القسم بنية عوامل التصفية التي يمكن استخدامها مع عوامل التصفية و.
هيكل
تدعم بعض نقاط نهاية واجهة برمجة التطبيقات عوامل التصفية عند تنفيذ الاستعلامات. في الأقسام ذات الصلة، ستجد مرجعا يسرد جميع الحقول القابلة للتصفية المتوفرة وعوامل التشغيل المدعومة لهذا المورد.
تدعم معظم عوامل التصفية قيما متعددة لتزويدك بالاستعلامات القوية. عند الجمع بين عوامل التصفية وعوامل التشغيل، نستخدم AND كعامل تشغيل منطقي بين عوامل التصفية.
عوامل التصفية - مثال
curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint" -d '{
"filters": {
"some.field": {
"eq": ["value1", "value2"],
"isset": true
},
"some.field2": {
"gte": 5
}
},
"skip": 5,
"limit": 10
}'
المشغلون
ملاحظة
لا تتوافق جميع عوامل التشغيل مع جميع عوامل التصفية.
يصف الجدول التالي عوامل التشغيل المدعومة:
المشغل | نوع الاستجابة | الوصف |
---|---|---|
يحتوي | قائمة السلاسل | إرجاع كافة السجلات ذات الصلة التي تحتوي على إحدى السلاسل المتوفرة |
deq | قائمة القيم | إرجاع كافة السجلات التي تحتوي على قيمة واحدة لا تساوي إحدى القيم المتوفرة |
توابع | قائمة القيم | إرجاع جميع السجلات ذات الصلة التي تطابق القيم أو التوابع منها |
لا يبدء مع | قائمة السلاسل | إرجاع كافة السجلات ذات الصلة التي لا تبدأ بكل سلسلة من السلاسل المتوفرة |
ينتهي ب | قائمة السلاسل | إرجاع جميع السجلات ذات الصلة التي تنتهي بإحدى السلاسل المتوفرة |
مكافئ | قائمة القيم | إرجاع جميع السجلات ذات الصلة التي تحتوي على إحدى القيم المتوفرة |
جي تي | قيمة مفردة | إرجاع كافة السجلات التي تكون قيمتها أكبر من القيمة المتوفرة |
gte | قيمة مفردة | إرجاع كافة السجلات التي تكون قيمتها أكبر من القيمة المقدمة أو مساوية لها |
gte_ndays | رقم | إرجاع كافة السجلات بتاريخ أحدث من N أيام مضت |
isnotset | منطقيه | عند التعيين إلى "صحيح"، ترجع كافة السجلات ذات الصلة التي لا تحتوي على قيمة في الحقل المحدد |
مجموعة | منطقيه | عند التعيين إلى "صحيح"، ترجع كافة السجلات ذات الصلة التي تحتوي على قيمة في الحقل المحدد |
lt | قيمة مفردة | إرجاع كافة السجلات التي تكون قيمتها أقل من القيمة المتوفرة |
lte | قيمة مفردة | إرجاع كافة السجلات التي تكون قيمتها أقل من القيمة المقدمة أو مساوية لها |
lte_ndays | رقم | إرجاع كافة السجلات بتاريخ أقدم من N days |
ncontains | قائمة السلاسل | إرجاع كافة السجلات ذات الصلة التي لا تحتوي على إحدى السلاسل المتوفرة |
ndescendantof | قائمة القيم | إرجاع كافة السجلات ذات الصلة غير المطابقة للقيم أو التوابع منها |
neq | قائمة القيم | إرجاع كافة السجلات ذات الصلة التي لا تحتوي على جميع القيم المتوفرة |
نطاق | قائمة الكائنات التي تحتوي على حقلي "البدء" و"النهاية" | إرجاع كافة السجلات ضمن أحد النطاقات المتوفرة |
يبدأ بالبدء | قائمة السلاسل | إرجاع جميع السجلات ذات الصلة بدءا من إحدى السلاسل المتوفرة |
بدء التشغيل | خيط | إرجاع جميع السجلات ذات الصلة بدءا من السلسلة المتوفرة |
نص | خيط | إجراء بحث نصي كامل عن جميع السجلات |
الخطوات التالية
إذا واجهت أي مشاكل، فنحن هنا للمساعدة. للحصول على المساعدة أو الدعم لقضية المنتج، يرجى فتح تذكرة دعم.