יישומי ענן של Defender REST API של יישומי ענן של Defender

מאמר זה מתאר כיצד לקיים אינטראקציה עם יישומי ענן של Defender באמצעות HTTPS.

ה- API יישומי ענן של Microsoft Defender מספק גישה תוכניתית ל- יישומי ענן של Defender באמצעות נקודות קצה של API של REST. יישומים יכולים להשתמש ב- API כדי לבצע פעולות קריאה ועדכון יישומי ענן של Defender נתונים באובייקטים. לדוגמה, ה- API יישומי ענן של Defender תומך בפעולות הנפוצות הבאות עבור אובייקט משתמש:

• העלאת קבצי יומן רישום לגילוי ענן
• צור קבצי Script של בלוקים
• רשימת פעילויות והתראות
• ביטול או פתרון של התראות

מבנה כתובת URL של API

כדי להשתמש ב- API יישומי ענן של Defender, עליך להשיג תחילה את כתובת ה- URL של ה- API מה דייר שלך. כתובת ה- URL של ה- API משתמשת בתבנית הבאה: https://<portal_url>/api/<endpoint>.

כדי להשיג את יישומי ענן של Defender ה- API של הדייר שלך, בצע את השלבים הבאים:

1. בתיבה פורטל Microsoft Defender, בחר הגדרות. לאחר מכן בחר אפליקציות ענן. תחת מערכת, בחר אודות.

2. במסך יישומי ענן של Defender אודות, באפשרותך לראות את כתובת ה- URL של ה- API.

   

לאחר קבלת כתובת ה- URL של ה- API, הוסף /api אליה את הסיומת כדי להשיג את כתובת ה- URL של ה- API. לדוגמה, אם כתובת ה- URL של הפורטל שלך היא , כתובת ה https://mytenant.us2.contoso.com- URL של ה- API שלך היא https://mytenant.us2.portal.cloudappsecurity.com/api.

אסימוני API

יישומי ענן של Defender דורש אסימון API בכותרת של כל בקשות ה- API לשרת, כגון:

Authorization: Token <your_token_key>

היכן <your_token_key> נמצא אסימון ה- API האישי שלך.

לקבלת מידע נוסף אודות אסימוני API, ראה ניהול אסימוני API.

אסימוני API - דוגמה

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint"

אילו פעולות נתמכות?

הטבלה הבאה מתארת את הפעולות הנתמכות:

משאב	פעלי HTTP	נתיבי URI
פעילויות	קבל או פרסם	/api/v1/activities/
התראות	קבל או פרסם	/api/v1/alerts/
העשרת נתונים	קבל, פרסם או מחק	/api/subnet/
ישויות	קבל או פרסם	/api/v1/entities/
קבצים	קבל או פרסם	/api/v1/files/

Where Resource מייצג קבוצה של ישויות קשורות.

אילו סוגי שדות נתמכים?

הטבלה הבאה מתארת את סוגי השדות הנתמכים:

שדה	תיאור
מחרוזת	מחרוזת טקסטואלית
בוליאני	ערך בוליאני המייצג ערך True/False
מספר שלם	מספר שלם חתום של 32 סיביות
חותמת זמן	אלפיות שניה מאז epoch

חותמות זמן

אזכורים של חותמות זמן ב- יישומי ענן של DEFENDER API מתייחסות לחותמת הזמן של Unix באלפיות השניה. חותמת זמן זו נקבעת לפי מספר אלפיות השניה מאז 1970-01-01 0:00:00. באפשרותך להשתמש ב- cmdlet של PowerShell המעודכן כדי להמיר תאריכים לחותמות זמן.

מגבלות

באפשרותך לבחור להגביל את הבקשות שלך על-ידי מתן פרמטר מגבלה בבקשה.

השיטות הבאות נתמכות לאספקת פרמטר המגבלה:

• מקודד באמצעות כתובת URL (עם Content-Type: application/x-www-form-urlencoded כותרת עליונה)
• נתוני טופס
• גוף JSON (עם Content-Type: multipart/form-data וכותרת גבול מתאימה)

הערה

• אם לא סופק כל מגבלה, תוגדר ברירת מחדל של 100.
• תגובות עבור כל הבקשות שבוצעו באמצעות אסימון ה- API מוגבלות ל- 100 פריטים לכל היותר.
• מגבלת הוויסות עבור כל בקשות ה- API היא 30 בקשות לדקה לכל דייר.

מסננים

כאשר יש לך מספר רב של תוצאות, כדאי לכוונן בקשות באמצעות מסננים. סעיף זה מתאר את המבנה של האופרטורים שניתן להשתמש בהם עם מסננים.

מבנה

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

רוב המסננים תומכים בערכים מרובים כדי לספק לך שאילתות רבות-עוצמה. בעת שילוב מסננים אופרטורים, אנו משתמשים בפונקציה 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	רשימת ערכים	החזרת כל הרשומות המכילות ערך אחד שאינו שווה לאחד מהערכים שסופקו
צאצא של	רשימת ערכים	החזרת כל הרשומות הרלוונטיות התואמות לערכים או לצאצאים שלהן
לאתחל עם	רשימת מחרוזות	החזרת כל הרשומות הרלוונטיות שלא מתחילות עם כל אחת מהמחרוזת שסופקה
מסתיים ב	רשימת מחרוזות	החזרת כל הרשומות הרלוונטיות המסתיימים באחת המחרוזות שסופקו
eq	רשימת ערכים	החזרת כל הרשומות הרלוונטיות המכילות אחד מהערכים שסופקו
1000	ערך בודד	החזרת כל הרשומות שערכם גדול מהערך שסופק
gte (gte)	ערך בודד	החזרת כל הרשומות שערכם גדול מהערך שסופק או שווה לו
gte_ndays	מספר	החזרת כל הרשומות עם תאריך מאוחר יותר מאשר לפני N ימים
ערכת ביאורים	בוליאני	כאשר היא מוגדרת כ- "true", החזרת כל הרשומות הרלוונטיות שאין אינן כוללות ערך בשדה שצוין
קבוצת ערכות	בוליאני	כאשר היא מוגדרת כ- "true", החזרת כל הרשומות הרלוונטיות הכוללות ערך בשדה שצוין
lt	ערך בודד	החזרת כל הרשומות שערכם קטן מהערך שסופק
תם תם	ערך בודד	החזרת כל הרשומות שערכם קטן מהערך שסופק או שווה לו
lte_ndays	מספר	החזרת כל הרשומות עם תאריך מוקדם יותר מאשר לפני N ימים
נתונים לא מזוהים	רשימת מחרוזות	החזרת כל הרשומות הרלוונטיות שלא מכילות אחת מהמחרוזת שסופקה
ndescendantof	רשימת ערכים	החזרת כל הרשומות הרלוונטיות שלא תואמות לערכים או לצאצאים שלהן
neq	רשימת ערכים	החזרת כל הרשומות הרלוונטיות שלא מכילות את כל הערכים שסופקו
טווח	רשימת אובייקטים המכילים שדות "התחלה" ו"סיום"	החזרת כל הרשומות בתוך אחד מהטווחים שסופקו
מתחיל ב	רשימת מחרוזות	החזרת כל הרשומות הרלוונטיות החל מ אחת מהמחרוזת שסופקה
מתחיל עם עבודה	מחרוזת	החזרת כל הרשומות הרלוונטיות החל מהמחרוזת שסופקה
טקסט	מחרוזת	ביצוע חיפוש טקסט מלא של כל הרשומות

השלבים הבאים

אימות API

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