Megosztás a következőn keresztül:

A szabályok listájának beolvasása

  • Cikk

A szabályok szabálykészlettel csoportosíthatók. Egy szabálynak nem kell szabálykészletben lennie, és több szabálykészletben is lehet. A GET kéréssel lekérhetők az összes rendelkezésre álló szabályt tartalmazó listák, a szabálykészletek szabályai, illetve a szabálykészletek, ha meghívja a [Geographical URI]/api/rule API-t. Az API több módon is meghívható. A leggyakoribb felhasználás az, ha egy adott szabálykészletre vonatkozóan beolvassa a szabályok listáját.

Feljegyzés

Ehhez az API-hoz jogkivonatra OAuth van szükség.

Fejlécek

Name Type Várt érték Kötelező?
Nyelv elfogadása sztring A nyelvi kód (például en-US). Az alapértelmezett kód az en-US. no

Paraméterek

Name Type Várt érték Kötelező?
ruleset string A szabálykészlet neve vagy azonosítója, vagy a szabálykészlet-azonosítók listája, illetve vesszővel vagy pontosvesszővel elválasztott nevek (például "Megoldásellenőrző"). no
includeMessageFormats bool A true érték használata esetén az üzenetek lehetséges változatainak listája szerepel a nyelvi kérések eredményei között (ha rendelkezésre áll). Ez a lista több nyelvre történő fordításhoz hasznos. Ha nincs rá szükség, akkor ne adja meg ezt a paramétert, és ne adja meg false értékként, mivel ez a paraméter növeli a válasz méretét, és növelheti a feldolgozási időt. no

Elvárt válaszok

HTTP-állapotkód Forgatókönyv Result
200 Egy vagy több eredmény található Lásd a cikk későbbi részében található példát. Egy vagy több eredmény adható vissza.
204 Nem található eredmény A válasz törzsében nincs eredmény.
401. Sikertelen hitelesítés A válasz törzsében nincs eredmény.

Elvárt válasz szövegtörzse

A következő táblázatban az egyes kérésekre adott válaszok szerkezete látható (csak HTTP 200 válasz).

Tulajdonság Típus szerint Várt érték Kötelező?
code string A szabály azonosítója (más néven szabályazonosító). Igen
összegzés sztring A szabály összefoglalása. Igen
description sztring A szabály részletesebb leírása. Igen
guidanceUrl URI Az URL, ahol a közzétett útmutató található. Előfordulhatnak olyan esetek, amikor nincs külön támogató útmutató. Igen
tartalmazza boolean A szolgáltatásnak küldött jelek arról, hogy a szabály szerepeljen az elemzésben. Ez az érték ehhez az API-hoz tartozik true . No
messageTemplates tömb Ez a tulajdonságérték csak akkor szerepel, ha az includeMessageFormats értéke true. Nem
messageTemplates.ruleId string Ugyanazt az azonosítóértéket adja vissza, mint a code tulajdonság. Igen
messageTemplates.messageTemplateId string A statikus elemzési eredmények adatcsere-formátumának (SARIF) jelentésében használt azonosító, amellyel egy probléma üzenetének valamilyen változata jelezhető a szabályhoz. Igen
messageTemplates.messageTemplate string Az üzenetváltozat szövege a szabály által jelentett problémás helyzetre vonatkozóan. Ez a szöveg egy formázási karakterlánc, amely olyan tokeneket tartalmazhat, amelyekben a SARIF-jelentésben megadott argumentumok felhasználhatók egy részletes üzenet létrehozásához. Igen

Példa: szabályok beolvasása egy szabálykészlethez másik nyelven

Ez a példa a Megoldásellenőrző szabálykészlet összes szabályához francia nyelven adja vissza az adatokat. Ha az angol nyelvet szeretné használni, távolítsa el az Accept-Language fejlécet.

Kérés

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

válasz

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

Példa: az összes beolvasása

Ez a példa az összes rendelkezésre álló szabályhoz visszaadja az adatokat.

Kérés

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

válasz

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

Példa: üzenetformátumokkal rendelkező szabálykészlet beolvasása

Ez a példa a Megoldásellenőrző szabálykészlet összes szabályához francia nyelven adja vissza az adatokat. Ha az angol nyelvet szeretné használni, távolítsa el az Accept-Language fejlécet.

Kérés

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

válasz

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

Kapcsolódó információk

Power Apps Az ellenőrző webes API használata
A szabálykészletek listájának lekérése
Fájl feltöltése
Elemzés meghívása
Ellenőrizze az elemzés állapotát