เรียกใช้การวิเคราะห์

การเริ่มต้นงานวิเคราะห์จะกระทำโดยการส่งคำขอ POST ไปที่เส้นทาง analyze การวิเคราะห์อาจเป็นกระบวนการที่ใช้เวลานาน ซึ่งมักใช้เวลานานกว่าหนึ่งนาที API จะทำการตรวจสอบความถูกต้องเบื้องต้นก่อน เริ่มคำขอในแบ็คเอนด์โดยการส่งงาน แล้วตอบกลับด้วยรหัสสถานะที่ 202 และส่วนหัว Location หรือมีรายละเอียดข้อผิดพลาดที่เหมาะสม ค่าส่วนหัว Location คือ URL ที่สามารถใช้เพื่อตรวจสอบสถานะของคำขอและเพื่อรับ URL ของผลลัพธ์ มีตัวเลือกต่างๆ ผ่านทางการดำเนินการ POST เพื่อปรับแต่งงานตามเกณฑ์ของคุณ เช่น รายการของกฎหรือชุดกฎ ไฟล์ที่จะแยกออกจากการวิเคราะห์ และอื่นๆ คุณสามารถเริ่มต้นการวิเคราะห์โดยใช้ [Geographical URL]/api/analyze?api-version=1.0 ต่อไปนี้

หมายเหตุ

ขอแนะนำให้รอระหว่าง 15 ถึง 60 วินาทีระหว่างการตรวจสอบสถานะ การวิเคราะห์มักใช้เวลาประมาณ 1 ถึง 5 นาทีในการเรียกใช้
API นี้ต้องการโทเค็น OAuth

ส่วนหัว

ชื่อ	ชนิด	ค่าที่คาดหวัง	จำเป็นหรือไม่
การอนุญาต	string	โทเค็นแบบแบเรอร์ OAuth 1 ที่มีการอ้างสิทธิ์ ID โปรแกรมประยุกต์ Microsoft Entra ID	yes
รหัสผู้เช่า x-ms	GUID	รหัสของผู้เช่าสำหรับโปรแกรมประยุกต์	ใช่
รหัสความสัมพันธ์ x-ms	GUID	ตัวบ่งชี้สำหรับการดำเนินการวิเคราะห์ คุณควรระบุรหัสเดียวกันสำหรับการดำเนินการทั้งหมด (อัปโหลด วิเคราะห์ สถานะ)	ใช่
ยอมรับ	ออบเจ็กต์	application/json, application/x-ms-sarif-v2	ใช่
ยอมรับ-ภาษา	string	รหัสภาษาหรือรหัสอื่น ๆ (เช่น en-US) ค่าเริ่มต้น คือ en-US หากมีหลายภาษา ภาษาแรกจะเป็นภาษาหลัก อย่างไรก็ตาม การแปลทั้งหมด (หากรองรับภาษานั้น) จะรวมอยู่ด้วย	ไม่ใช่

เนื้อความ

ตัวเลือกที่ใช้กันทั่วไป:

คุณสมบัติ	ชนิด	ค่าที่คาดหวัง	จำเป็นหรือไม่
sasUriList	อาร์เรย์ของสตริง	รายการของ URI ที่ให้บริการการเข้าถึงเพื่อดาวน์โหลดโซลูชันเดี่ยว ไฟล์ zip ที่มีไฟล์โซลูชันหลายไฟล์ หรือแพ็คเกจ	ได้
rulesets	อาร์เรย์ที่กำหนดเอง	0 หรือมากกว่า	ไม่ใช่
ruleSets.id	guid	รหัสของชุดกฎ ซึ่งสามารถพบได้โดยการสืบค้น API ของชุดกฎ	ไม่ปกติ แต่นี่คือสิ่งที่คุณอาจต้องการใช้ คุณต้องใช้สิ่งนี้หรือรหัสกฎ
ruleCodes.code	string	รหัสของกฎที่ต้องการ ซึ่งสามารถพบได้โดยการสืบค้น API ของชุดกฎและกฎ	ไม่ได้ คุณต้องใช้สิ่งนี้หรือชุดกฎ
fileExclusions	อาร์เรย์ของสตริง	รายการชื่อไฟล์หรือรูปแบบชื่อไฟล์ที่ต้องการยกเว้น มีการสนับสนุนสำหรับการใช้ "*" เป็นอักขระตัวแทนในการเริ่มต้นและ / หรือสิ้นสุดชื่อไฟล์ (เช่น *jquery.dll และ *jquery*)	ไม่ใช่

คำตอบที่คาดหวัง

รหัสสถานะ HTTP	สถานการณ์สมมติ	Result
202	คำขอสำหรับการวิเคราะห์ได้รับการยอมรับ และส่งกลับ URI การตรวจสอบสถานะในส่วนหัว Location	ไม่มีเนื้อหาส่วนผลลัพธ์
400	มีการส่งไฟล์ที่ไม่ใช่ zip พารามิเตอร์ที่ไม่ถูกต้อง หรือไฟล์มาพร้อมกับไวรัส	ไม่มีเนื้อหาส่วนผลลัพธ์
409	คำขอที่มีส่วนหัว x-ms-correlation-id ซ้ำถูกส่งแล้ว	ไม่มีเนื้อหาส่วนผลลัพธ์

ส่วนหัวการตอบสนองที่คาดหวัง

ชื่อ	ชนิด	ค่าที่คาดหวัง	จำเป็นหรือไม่
สถานที่ตั้ง	Uri	URL ที่จะใช้ในการสอบถามสถานะปัจจุบัน และเพื่อให้ได้ผลลัพธ์	ใช่

ตัวอย่าง: เริ่มการวิเคราะห์

นี่คือตัวอย่างของการเริ่มต้นงานการวิเคราะห์ด้วยชุดกฎ AppSource Certification ไฟล์เดี่ยว และไม่รวมไฟล์ที่มีข้อความ 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: 9E378E56-6F35-41E9-BF8B-C0CC88E2B832
x-ms-tenant-id: F2E60E49-CB87-4C24-8D4F-908813B22506

{
    "ruleSets": [{
        "id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
    }],
    "sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
    "fileExclusions": ["*jquery*", "*json*"]
}

Response

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/9E378E56-6F35-41E9-BF8B-C0CC88E2B832&api-version=1.0

ดูเพิ่มเติม

ใช้ API เว็บของตัวตรวจสอบ Power Apps
เรียกใช้ชุดรายการของข้อกำหนด
เรียกใช้รายการของข้อกำหนด
อัปโหลดแฟ้ม
ตรวจสอบสถานะการวิเคราะห์