הערה
הגישה לדף זה מחייבת הרשאה. באפשרותך לנסות להיכנס או לשנות מדריכי כתובות.
הגישה לדף זה מחייבת הרשאה. באפשרותך לנסות לשנות מדריכי כתובות.
הפעלת משימת ניתוח מתבצעת על-ידי שליחת בקשת POST לנתיב analyze. הפעלת תהליך ניתוח עשויה בדרך כלל להימשך יותר מדקה. ה- API מבצע תחילה אימות בסיסי, מפעיל את הבקשה בקצה העורפי על-ידי שליחת משימה ולאחר מכן מגיב עם קוד מצב של 202 וכותרת עליונה של Location או עם פרטי השגיאה המתאימים. ערך הכותרת העליונה של Location הוא כתובת URL שבה ניתן להשתמש כדי לבדוק את מצב הבקשה ולהשיג את כתובות ה- URL של התוצאות. באמצעות הפעולה POST קיימות אפשרויות שונות להתאמת המשימה על בסיס הקריטריונים שלך, כגון רשימת כללים או ערכות כללים, קבצים שלא צריכים להיכלל בניתוח ועוד. ניתן להפעיל את הניתוח באמצעות הפקודה הבאה: [Geographical URL]/api/analyze?api-version=1.0.
הערה
מומלץ להמתין בין 15 ל- 60 שניות בין בדיקות מצב. הפעלת הניתוח נמשכת בדרך כלל בין דקה אחת ל- 5 דקות.
ממשק API זה דורש אסימון OAuth.
כותרות
| שם | סוג | ערך צפוי | נדרש? |
|---|---|---|---|
| ההרשאות | מחרוזת | אסימון נושא OAuth 1 עם דרישת מזהה של אפליקציית Microsoft Entra ID. | כן |
| x-ms-tenant-id | GUID | מזהה הדייר עבור הבקשה. | כן |
| x-ms-correlation-id | GUID | המזהה עבור הפעלת הניתוח. עליך לספק את אותו מזהה עבור כל הביצוע (העלאה, ניתוח, מצב). | כן |
| אישור | אובייקט | application/json, application/x-ms-sarif-v2 |
כן |
| אקספט-לנגוויץ | מחרוזת | קודי השפות (למשל, en-US). ברירת המחדל היא en-US. אם סופקו כמה שפות, השפה הראשונה תהיה הראשית. עם זאת, ייכללו כל התרגומים (אם השפה נתמכת). | לא |
גוף
אפשרויות נפוצות:
| מאפיין | סוג | ערך צפוי | נדרש? |
|---|---|---|---|
| sasUriList | מערך של מחרוזות | רשימת מזהי URI שמספקת לשירות גישה להורדת פתרון אחד, קובץ zip שמכיל קבצי פתרונות מרובים, או חבילה. | כן |
| ruleSets | מערך מותאם אישית | 0 או יותר | לא |
| ruleSets.id | GUID | המזהה של ערכת הכללים, שניתן למצוא על ידי ביצוע שאילתה ב- API של ערכת הכללים. | לא, אך מומלץ בדרך כלל להשתמש בו. עליך להשתמש במאפיין זה או ב- ruleCodes. |
| ruleCodes.code | מחרוזת | המזהה של הכלל הרצוי, שניתן למצוא על ידי ביצוע שאילתה ב- API של הכלל וערכת הכללים. | לא. עליך להשתמש במאפיין זה או ב- ruleSets. |
| fileExclusions | מערך של מחרוזות | רשימה של שמות קבצים או דפוסי שמות קבצים שלא צריכים להיכלל. קיימת תמיכה בשימוש ב- "*" כתו כללי בהתחלה ו/או בשם קובץ (לדוגמה, ,*jquery.dll ו- *jquery*). | לא |
תגובות צפויות
| קוד מצב HTTP | תרחיש | תוצאה |
|---|---|---|
| 202 | בקשת הניתוח התקבלה, וה- URI של בדיקת המצב הוחזר לכותרת העליונה של Location |
אין תוכן לתוצאה |
| 400 | נשלח קובץ שאינו zip, נשלחו פרמטרים שגויים או נכלל קובץ עם וירוס | אין תוכן לתוצאה |
| 409 | נשלחה בקשה עם ערך כותרת כפול של x-ms-correlation-id |
אין תוכן לתוצאה |
כותרות תגובה צפויות
| שם | סוג | ערך צפוי | נדרש? |
|---|---|---|---|
| מיקום | Uri | ה- URL שבו יש להשתמש בשאילתות עבור המצב הנוכחי ולהשגת התוצאות | כן |
דוגמה: הפעלת ניתוח
זוהי דוגמה ליזום משימת ניתוח עם ערכת הכללים של אישור Marketplace , קובץ יחיד, ולא כולל קבצים המכילים את הטקסט jquery ו- json בשם.
בקשה
POST [Geographical URI]/api/analyze?api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
x-ms-tenant-id: aaaabbbb-0000-cccc-1111-dddd2222eeee
{
"ruleSets": [{
"id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
}],
"sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
"fileExclusions": ["*jquery*", "*json*"]
}
תגובה
HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&api-version=1.0
למידע נוסף
שימוש ב-API האינטרנט של הבודק Power Apps
אחזור רשימת ערכות הכללים
אחזור רשימת הכללים
העלאת קובץ
בדיקת מצב הניתוח