Nota
Capaian ke halaman ini memerlukan kebenaran. Anda boleh cuba mendaftar masuk atau menukar direktori.
Capaian ke halaman ini memerlukan kebenaran. Anda boleh cuba menukar direktori.
Peraturan dihimpunkan bersama menggunakan ruleset. Peraturan tidak boleh dalam ruleset, atau pelbagai ruleset. Gunakan permintaan GET untuk mendapatkan senarai semua peraturan yang tersedia, peraturan dalam ruleset dengan memanggil API [Geographical URI]/api/rule. Terdapat beberapa variasi untuk memanggil API ini, bagaimanapun, penggunaan yang paling biasa adalah untuk mendapatkan senarai peraturan bagi ruleset tertentu.
Nota
API ini memerlukan OAuth token.
Pengepala
| Nama | Jenis | Nilai yang dijangka | Diperlukan? |
|---|---|---|---|
| Menerima Bahasa | rentetan | Kod bahasa (contohnya, en-US). Bahasa lalai ialah en-US. | tidak |
Parameter
| Nama | Jenis | Nilai yang dijangka | Diperlukan? |
|---|---|---|---|
| ruleset | rentetan | Nama atau ID set peraturan atau senarai ID set peraturan atau nama yang dipisahkan dengan koma atau titik koma (contohnya, "Penyemak Penyelesaian"). | tidak |
| includeMessageFormats | bool | Apabila ditetapkan kepada true, senarai variasi mesej yang mungkin disertakan dalam hasil permintaan bahasa, jika tersedia. Senarai ini berguna untuk terjemahan ke dalam pelbagai bahasa. Jika tidak diperlukan, maka jangan berikan parameter ini atau berikan false sebagai nilai kerana parameter ini meningkatkan saiz respons dan boleh meningkatkan masa pemprosesan. |
tidak |
Respons dijangka
| Kod status HTTP | Senario | Keputusan |
|---|---|---|
| 200 | Satu atau lebih keputusan ditemui | Lihat contoh kemudian dalam artikel ini. Satu atau lebih hasil mungkin dikembalikan. |
| 204 | Tiada hasil ditemui | Tiada hasil dalam isi respons. |
| 401 | Pengesahan Gagal | Tiada hasil dalam isi respons. |
Badan respons yang dijangka
Jadual berikut menggariskan struktur respons untuk setiap permintaan (respons HTTP 200 sahaja).
| Sifat | Jenis | Nilai yang dijangka | Diperlukan? |
|---|---|---|---|
| kod | rentetan | Pengecam peraturan, kadangkala dirujuk sebagai ID Peraturan. | Ya |
| ringkasan | rentetan | Ringkasan peraturan. | Ya |
| perihalan | rentetan | Penerangan peraturan yang lebih terperinci. | Ya |
| guidanceUrl | URI | URL untuk mencari panduan yang diterbitkan. Mungkin terdapat beberapa kes di mana tidak ada rencana panduan sokongan khusus. | Ya |
| sertakan | boolean | Memberi isyarat kepada perkhidmatan bahawa peraturan tersebut perlu disertakan dalam analisis. Nilai ini adalah true untuk API ini. |
No |
| messageTemplates | tatasusunan | Nilai sifat ini hanya disertakan apabila includeMessageFormats adalah true. |
No |
| messageTemplates.ruleId | rentetan | Kembalikan nilai ID yang sama dengan sifat code tersebut. |
Ya |
| messageTemplates.messageTemplateId | rentetan | Pengecam yang digunakan dalam laporan Format Pertukaran Hasil Analisis Statik (SARIF) untuk menandakan variasi mesej isu untuk peraturan tersebut. | Ya |
| messageTemplates.messageTemplate | rentetan | Teks variasi mesej untuk senario isu yang dilaporkan oleh peraturan. Teks ini ialah rentetan format yang mungkin mengandungi token di mana argumen yang disediakan dalam laporan SARIF boleh digunakan untuk membina mesej terperinci. | Ya |
Contoh: mendapatkan peraturan untuk ruleset dalam bahasa lain
Contoh ini mengembalikan data untuk semua peraturan dalam ruleset Penyemak Penyelesaian dalam Bahasa Perancis. Jika bahasa yang diingini ialah Bahasa Inggeris, maka hanya alih keluar pengepala menerima Bahasa Diterima.
Permintaan
GET [Geographical URI]/api/rule?ruleset=083A2EF5-7E0E-4754-9D88-9455142DC08B&api-version=2.0
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
Accept: application/json
Content-Type: application/json; charset=utf-8
Accept-Language: fr
Respons
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"description": "Ne pas implémenter d’activités de workflow Microsoft Dynamics CRM 4.0",
"guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-avoid-crm4-wf&client=PAChecker",
"include": true,
"code": "il-avoid-crm4-wf",
"summary": "Ne pas implémenter d’activités de workflow Microsoft Dynamics CRM 4.0",
"howToFix": {
"summary": ""
}
},
{
"description": "Utiliser InvalidPluginExecutionException dans des plug-ins et activités de workflow",
"guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-use-standard-exception&client=PAChecker",
"include": true,
"code": "il-use-standard-exception",
"summary": "Utiliser InvalidPluginExecutionException dans des plug-ins et activités de workflow",
"howToFix": {
"summary": ""
}
},
...
]
Contoh: dapatkan semula semua
Contoh ini mengembalikan data untuk semua peraturan yang tersedia.
Permintaan
GET [Geographical URI]/api/rule?api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8
Respons
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"description": "Retrieve specific columns for an entity via query APIs",
"guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-specify-column&client=PAChecker",
"include": true,
"code": "il-specify-column",
"summary": "Retrieve specific columns for an entity via query APIs",
"howToFix": {
"summary": ""
}
},
{
"description": "Do not duplicate plug-in step registration",
"guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=meta-remove-dup-reg&client=PAChecker",
"include": true,
"code": "meta-remove-dup-reg",
"summary": "Do not duplicate plug-in step registration",
"howToFix": {
"summary": ""
}
},
...
]
Contoh: dapatkan semula dengan format mesej
Contoh ini mengembalikan data untuk semua peraturan dalam ruleset Penyemak Penyelesaian dalam Bahasa Perancis. Jika bahasa yang diingini ialah Bahasa Inggeris, maka hanya alih keluar pengepala menerima Bahasa Diterima.
Permintaan
GET [Geographical URI]/api/rule?ruleset=083A2EF5-7E0E-4754-9D88-9455142DC08B&includeMessageFormats=true&api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8
Respons
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"description": "Do not implement Microsoft Dynamics CRM 4.0 workflow activities",
"guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-avoid-crm4-wf&client=PAChecker",
"include": true,
"code": "il-avoid-crm4-wf",
"summary": "Do not implement Microsoft Dynamics CRM 4.0 workflow activities",
"howToFix": {
"summary": ""
},
"messageTemplates": [
{
"ruleId": "il-avoid-crm4-wf",
"messageTemplateId": "message1",
"messageTemplate": "Update the {0} class to derive from System.Workflow.Activities.CodeActivity, refactor Execute method implementation, and remove Microsoft.Crm.Workflow.CrmWorkflowActivityAttribute from type"
},
{
"ruleId": "il-avoid-crm4-wf",
"messageTemplateId": "message2",
"messageTemplate": "Change the {0} property's type from {1} to {2} Argument <T> type"
},
{
"ruleId": "il-avoid-crm4-wf",
"messageTemplateId": "message3",
"messageTemplate": "Replace the Microsoft.Crm.Workflow.Crm{0}Attribute with Microsoft.Xrm.Sdk.Workflow.{0}Attribute"
},
{
"ruleId": "il-avoid-crm4-wf",
"messageTemplateId": "message4",
"messageTemplate": "Remove the {0} System.Workflow.ComponentModel.DependencyProperty type field"
}
]
},
{
"description": "Use InvalidPluginExecutionException in plug-ins and workflow activities",
"guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-use-standard-exception&client=PAChecker",
"include": true,
"code": "il-use-standard-exception",
"summary": "Use InvalidPluginExecutionException in plug-ins and workflow activities",
"howToFix": {
"summary": ""
},
"messageTemplates": [
{
"ruleId": "il-use-standard-exception",
"messageTemplateId": "message1",
"messageTemplate": "An unguarded throw of type {0} was detected. Refactor this code to either throw an exception of type InvalidPluginExecutionException or guard against thrown exceptions of other types."
},
{
"ruleId": "il-use-standard-exception",
"messageTemplateId": "message2",
"messageTemplate": "An unguarded rethrow of type {0} was detected. Refactor this code to either throw an exception of type InvalidPluginExecutionException or guard against thrown exceptions of other types."
}
]
},
...
]
Lihat juga
Gunakan Power Apps API web penyemak
Dapatkan semula senarai set peraturan
Muat naik fail
Invoke analisis
Semak status analisis