Partajați prin

Regăsirea listei de reguli

  • Articol

Regulile sunt grupate folosind un set de reguli. O regulă nu poate fi în niciun set de reguli sau în mai multe reguli. Utilizați o solicitare GET pentru a obține o listă a tuturor regulilor disponibile, regulile dintr-un set de reguli, sau seturile de reguli apelând API [Geographical URI]/api/rule. Există câteva variante de apelare ale acestui API, cu toate acestea, cea mai frecventă utilizare este de a prelua lista de reguli pentru un set de reguli specifice.

Notă

Acest API necesită un OAuth token.

Anteturi

Nume Tipul Valoare așteptată Obligatoriu?
Accept-Language string Codul limbii (de exemplu, en-US). Implicit este en-SUA. nu

Parametri

Nume Tipul Valoare așteptată Obligatoriu?
set de reguli string Numele sau ID-ul setului de reguli sau o listă de ID-uri setului de reguli sau nume separate prin virgulă sau punct și virgulă (de exemplu, „Verificator soluție”). nu
includeMessageFormats boolean Când este setat la true, lista posibilelor variații de mesaje sunt incluse în rezultatele solicitărilor de limbi, dacă sunt disponibile. Această listă este utilă pentru traduceri în mai multe limbi. Dacă nu este necesar, nu furnizați acest parametru și nu furnizați false ca valoare, deoarece acest parametru mărește dimensiunea răspuns și poate crește timpul de procesare. nu

Răspunsuri așteptate

Cod de stare HTTP Scenariu Rezultat
200 Au fost găsite unul sau mai multe rezultate Vedeți exemplul mai târziu în acest articol. Unul sau mai multe rezultate pot fi returnate.
204 Nu a fost găsit niciun rezultat Nu există rezultate în corpul de răspuns.
401 Autentificare nereușită Nu există rezultate în corpul de răspuns.

Corp de răspuns așteptat

Următorul tabel prezintă structura răspunsului pentru fiecare cerere (doar răspuns HTTP 200).

Proprietate Tip Valoare așteptată Obligatoriu?
cod string Identificatorul regulii, denumit uneori ID-ul regulii. Da
Rezumat string Un rezumat al regulii. Da
descriere string Descriere mai detaliată a regulii. Da
guidanceUrl URI URL-ul în care să găsiți îndrumări publicate. Pot exista unele cazuri în care nu există un articol de orientare dedicat. Da
include boolean Semnalează către serviciul conform căruia regula trebuie inclusă în analiză. Această valoare este true pentru acest API. No
messageTemplates vector Această valoare a proprietății este inclusă numai atunci când includeMessageFormats este true. Nu
messageTemplates.ruleId string Returnează aceeași valoare de identificare ca și proprietatea code. Da
messageTemplates.messageTemplateId string Un identificator utilizat în Raportul formatului de schimb de rezultate al analizei statice (SARIF) pentru a semnala o variație a mesajului de emisiune pentru regulă. Da
messageTemplates.messageTemplate string Textul variației mesajului pentru scenariul problemei pe care îl raportează regula. Acest text este un șir de format care poate conține token-uri în care argumentele furnizate în raportul SARIF pot fi folosite pentru a construi un mesaj detaliat. Da

Exemplu: regăsiți regulile pentru un set de reguli într-o altă limbă

Acest exemplu returnează date pentru toate regulile din setul de reguli Verificator de soluții în limba franceză. Dacă limba dorită este engleza, atunci eliminați doar antetul Accept-Language.

Cerere

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

răspuns

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

Exemplu: regăsiți toate

Acest exemplu returnează datele pentru toate regulile disponibile.

Cerere

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

răspuns

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

Exemplu: regăsiți un set de reguli cu formate de mesaje

Acest exemplu returnează date pentru toate regulile din setul de reguli Verificator de soluții în limba franceză. Dacă limba dorită este engleza, atunci eliminați doar antetul Accept-Language.

Cerere

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

răspuns

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

Consultați și

Utilizați Power Apps API-ul web Checker
Preluați lista de seturi de reguli
Încărcați un fișier
Invocă analiza
Verificați starea analizei