Bendrinti naudojant

Taisyklių sąrašo nuskaitymas

  • Straipsnis

Taisyklės grupuojamos naudojant taisyklių rinkinį. Taisyklė gali nepriklausyti jokiam arba priklausyti keliems taisyklių rinkiniams. Naudodami GET užklausą, pateikę API kvietimą [Geographical URI]/api/rule galite gauti visų galimų taisyklių, taisyklių rinkinyje esančių taisyklių arba taisyklių rinkinių sąrašą. Šis API gali būti kviečiamas keliais būdas, tačiau dažniausiai kvietimas vykdomas norint gauti tam tikro taisyklių rinkinio taisyklių sąrašą.

Pastaba.

Šiai API reikia prieigos rakto OAuth .

Antraštės

Pavadinimą Tipas Laukiama reikšmė Būtina?
Priimti-Kalbą string Kalbos kodas (pvz., en-US). Numatytoji reikšmė yra en-US. ne

Parametrai

Pavadinimą Tipas Laukiama reikšmė Būtina?
ruleset eilutė Taisyklių rinkinio pavadinimas arba ID arba taisyklių rinkinio ID sąrašas, arba kableliu ar kabliataškiu atskirti vardai (pvz., "Sprendimų tikrintuvas"). ne
includeMessageFormats Bulio Kai nustatyta reikšmė yra true, jei įmanoma, į kalbos (-ų) užklausų rezultatus įtraukiamas galimų pranešimų variantų sąrašas. Šis sąrašas naudingas verčiant į kelias kalbas. Jei nereikia, nepateikite šio parametro arba pateikite false kaip reikšmę, nes šis parametras padidina atsakymas dydį ir gali pailginti apdorojimo laiką. ne

Laukiami atsakymai

HTTP būsenos kodas Scenarijus Rezultatas
Virš 200 Rastas vienas ar daugiau rezultatų Žiūrėkite pavyzdį toliau šiame straipsnyje. Gali būti grąžintas vienas ar daugiau rezultatų.
204 Rezultatų nerasta Atsakymo tekste nėra rezultatų.
401 Autentifikuoti nepavyko Atsakymo tekste nėra rezultatų.

Laukiamas atsakymo tekstas

Toliau esančioje lentelėje pateikta atsakymo į kiekvieną užklausą (tik HTTP 200 atsakymas) struktūra.

Ypatybė Tipas Laukiama reikšmė Būtina?
kodas eilutė Taisyklės identifikatorius, kartais vadinamas taisyklės ID. Taip
Suvestinė string Taisyklės santrauka. Taip
aprašas string Išsamesnis taisyklės aprašymas. Taip
guidanceUrl URI URL, kuriame galima rasti publikuotas rekomendacijas. Gali būti atvejų, kai nėra specialaus pagalbinio gairių straipsnio. Taip
įtraukti bulio logikos Signalas paslaugai, kad į analizę turi būti įtraukta taisyklė. Ši reikšmė skirta true šiai API. No
messageTemplates masyvas Ši ypatybės reikšmė įtraukiama tik tada, kai includeMessageFormats reikšmė yra true. Ne
messageTemplates.ruleId eilutė Grąžina tą pačią ID reikšmę kaip ir code ypatybė. Taip
messageTemplates.messageTemplateId eilutė Statinės analizės mainų formato (SARIF) ataskaitoje naudojamas identifikatorius, informuojantis apie taisyklės problemą. Taip
messageTemplates.messageTemplate eilutė Problemos scenarijaus pranešimo tekstas, kurį pateikia taisyklė. Šis tekstas yra formato eilutė, kurioje gali būti žetonų, kuriuose SARIF ataskaitoje pateikti argumentai gali būti naudojami išsamiam pranešimui sukurti. Taip

Pavyzdys: taisyklių rinkinio taisyklių gavimas kita kalba

Šiame pavyzdyje pateikiami visų Sprendimų tikrintuvo taisyklių rinkinio taisyklių duomenys prancūzų kalba. Jei pageidaujama kalba yra anglų, tada tiesiog pašalinkite Accept-Language antraštę.

Prašymą

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

atsakymas

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": ""
        }
    },
...
]

Pavyzdys: gauti visus

Šiame pavyzdyje pateikiami visų galimų taisyklių duomenys.

Prašymą

GET [Geographical URI]/api/rule?api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8

atsakymas

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": ""
        }
    },
...
]

Pavyzdys: taisyklių rinkinio duomenų gavimas su pranešimo formatais

Šiame pavyzdyje pateikiami visų Sprendimų tikrintuvo taisyklių rinkinio taisyklių duomenys prancūzų kalba. Jei pageidaujama kalba yra anglų, tada tiesiog pašalinkite Accept-Language antraštę.

Prašymą

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

atsakymas

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."
            }
        ]
    },
...
]

Taip pat žr.

Tikrintuvo Power Apps žiniatinklio API naudojimas
Taisyklių rinkinių sąrašo gavimas
Failo nusiuntimas
Iškviesti analizę
Patikrinkite analizės būseną