विश्लेषण इनवोक करें

analyze रूट में POST अनुरोध सबमिट करके विश्लेषण कार्य प्रारंभ किया जा सकता है. विश्लेषण एक लंबी चलने वाली प्रक्रिया हो सकती है जो आमतौर पर एक मिनट से अधिक समय तक रहती है. API पहले कुछ बुनियादी सत्यापन करता है, कार्य सबमिट करके बैकएंड में अनुरोध शुरू करता है, और फिर 202 और फिर 202 स्थिति कोड और Location हेडर या उपयुक्त त्रुटि विवरण के साथ प्रतिक्रिया देता है. Location हेडर मान एक URL होता है जिसका उपयोग अनुरोध की स्थिति की जांच करने और परिणाम(परिणामों) का(के) URL प्राप्त करने के लिए किया जा सकता है. आपके मापदंड के आधार पर POST कार्यवाई के माध्यम से कार्य को अनुकूलित करने के लिए बहुत से विकल्प हैं, जैसे कि नियम या नियमसेट की सूची, विश्लेषण से हटाने के लिए फ़ाइलें इत्यादि. आप निम्नलिखित का उपयोग करके विश्लेषण आरंभ कर सकते हैं [Geographical URL]/api/analyze?api-version=1.0.

नोट

स्थिति की जाँच के बीच 15 से 60 सेकंड तक प्रतीक्षा करने का सुझाव दिया जाता है. विश्लेषण चलाने में आमतौर पर 1 से 5 मिनट लगते हैं.
इस API को OAuth टोकन की आवश्यकता होती है।

शीर्ष लेख

नाम	Type	अपेक्षित मान	आवश्यक?
प्रमाणन	string	OAuth आईडी एप्लीकेशन आईडी दावे के साथ Microsoft Entra 1 धारक टोकन.	हाँ
x-ms-tenant-id	मार्गदर्शक	एप्लिकेशन के लिए टैनेंट का ID.	हाँ
x-ms-correlation-id	GUID	विश्लेषण रन के लिए पहचानकर्ता. संपूर्ण निष्पादन (अपलोड, विश्लेषण, स्थिति) के लिए आपको एक ही ID प्रदान करना चाहिए.	हाँ
स्वीकार करें	ऑब्जेक्ट	application/json, application/x-ms-sarif-v2	हाँ
भाषा-स्वीकार करें	string	भाषा कोड या कोड (जैसे,. en-US). डिफ़ॉल्ट en-US है. यदि कई भाषाएं प्रदान की जाती हैं, तो पहली भाषा प्राथमिक होगी. हालाँकि, सभी अनुवाद (यदि भाषा समर्थित है) शामिल होंगे.	नहीं

बॉडी

आमतौर पर इस्तेमाल किए जाने वाले विकल्प:

गुण	प्रकार	अपेक्षित मान	आवश्यक?
sasUriList	स्ट्रिंग्स की सरणी	URI की एक सूची जो एकल समाधान, कई समाधान फाइलों वाली एक ज़िप फ़ाइल या पैकेज डाउनलोड करने के लिए सेवा पहुँच प्रदान करती है.	हां
ruleSets	कस्टम की सरणी	0 या अधिक	नहीं
ruleSets.id	guid	नियमसेट का ID, जिसे नियमसेट API को क्वेरी करके पाया जा सकता है.	नहीं, लेकिन आमतौर पर यह वह होता है जो आप उपयोग करना चाहते हैं. आपको यह या नियमकोड का उपयोग करना चाहिए.
ruleCodes.code	string	इच्छित नियम का ID, जिसे नियमसेट और नियम API को क्वेरी करके पाया जा सकता है.	नहीं, आपको यह या नियमसेट का उपयोग करना चाहिए.
fileExclusions	स्ट्रिंग्स की सरणी	निकाले जाने के लिए फ़ाइल नाम या फ़ाइल नाम के पैटर्न की एक सूची. फ़ाइल के नाम की शुरुआत और/या अंत में वाइल्डकार्ड के रूप में "*" का उपयोग करने के लिए समर्थन मौजूद है (जैसे, *jquery.dll और *jquery*).	No

अपेक्षित प्रत्युत्तर

HTTP स्थिति कोड	परिदृश्य	परिणाम
202	विश्लेषण के लिए अनुरोध स्वीकार किया गया और स्थिति जाँच URI को Location हैडर में लौटाया गया	कोई परिणाम भाग नहीं
400	एक गैर-ज़िप फ़ाइल भेजी गई थी, गलत पैरामीटर, या एक वाइरस वाली फ़ाइल शामिल थी	कोई परिणाम भाग नहीं
409	एक डुप्लिकेट x-ms-correlation-id हेडर मान वाला अनुरोध भेजा गया	कोई परिणाम भाग नहीं

अपेक्षित प्रतिक्रिया हेडर

नाम	प्रकार	अपेक्षित मान	आवश्यक?
स्थान	Uri	वर्तमान स्थिति की क्वेरी करने और परिणाम प्राप्त करने के लिए उपयोग किया जाने वाला URL	हाँ

उदाहरण: एक विश्लेषण प्रारंभ करें

यह AppSource प्रमाणीकरण नियमसेट, एक फ़ाइल वाले और 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*"]
}

प्रत्युत्तर

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

इसे भी देखें

Power Apps चेकर वेब API का उपयोग करें
नियम-सेट की सूची प्राप्त करें
नियमों की सूची पुनः प्राप्त करें
एक फ़ाइल अपलोड करें
विश्लेषण स्थिति की जाँच करें