Hente regellisten
Regler grupperes sammen ved hjelp av et regelsett. En regel kan være i ingen eller flere regelsett. Bruk en GET
-forespørsel om å hente en liste over alle reglene som er tilgjengelige, regler i et regelsett, eller regelsett ved å kalle APIen [Geographical URI]/api/rule
. Det er imidlertid noen variasjoner ved kalling av denne API-en, og den vanligste bruken er imidlertid å hente listen over regler for et bestemt regelsett.
Merk
Denne API-en krever et OAuth token.
Topptekster
Name | Type | Forventet verdi | Obligatorisk? |
---|---|---|---|
Accept-Language | string | Språkkoden (for eksempel en-US). Standard er en-US. | Nei |
Parametere
Navn | Type | Forventet verdi | Obligatorisk? |
---|---|---|---|
regelsett | string | Navnet på eller IDen til regelsettet eller en liste over regelsett-IDer, eller navn atskilt med komma eller semikolon (for eksempel Løsningskontroll). | Nei |
includeMessageFormats | boolsk | Når satt til true , inkluderes listen over mulige meldingsvariasjoner i resultatet av språkforespørslene, hvis de er tilgjengelige. Denne listen er nyttig for oversettelser til flere språk. Hvis ikke nødvendig, angir du ikke denne parameteren eller angir false som verdi siden denne parameteren øker størrelsen på svaret og kan øke behandlingstiden. |
Nei |
Forventede svar
HTTP-statuskode | Scenario | Result |
---|---|---|
200 | Ett eller flere resultater ble funnet | Se eksempelet senere i denne artikkelen. Det kan hende at ett eller flere resultater returneres. |
204 | Fant ingen resultater | Ingen resultater i svarteksten. |
401 | Godkjenning mislyktes | Ingen resultater i svarteksten. |
Forventet svartekst
Tabellen nedenfor oppsummerer strukturen for svaret for hver forespørsel (bare HTTP 200-svar).
Egenskap | Type | Forventet verdi | Obligatorisk? |
---|---|---|---|
kode | string | IDen til regelen, som også kalles regel-ID-en. | Ja |
Sammendrag | string | Et sammendrag av regelen. | Ja |
Beskrivelse | string | Mer detaljert beskrivelse av regelen. | Ja |
guidanceUrl | URI | URL-adressen for å finne publisert veiledning. Det kan finnes noen tilfeller der det ikke finnes en reservert støtteveiledningsartikkel. | Ja |
include | boolean | Signaliserer til tjenesten at regelen skal tas med i analysen. Denne verdien er true for denne API-en. |
Nei |
messageTemplates | matrise | Denne egenskapsverdien er bare inkludert når includeMessageFormats er true . |
Nei |
messageTemplates.ruleId | string | Returnerer samme ID-verdi som code -egenskapen. |
Ja |
messageTemplates.messageTemplateId | string | En identifikator som brukes i SARIF-rapporten (Static Analysis Results Interchange Format) til å signalisere en problemmeldingsvariasjon for regelen. | Ja |
messageTemplates.messageTemplate | string | Teksten i meldingsvariasjonen for problemscenarioet som regelen rapporterer. Denne teksten er en formatstreng som kan inneholde tokener der argumentene som er angitt i SARIF-rapporten, kan brukes til å opprette en detaljert melding. | Ja |
Eksempel: hente regler for et regelsett på et annet språk
Dette eksemplet returnerer data for alle reglene i Løsningskontroll-regelsettet på fransk språk. Hvis det ønskede språket er engelsk, fjerner du bare godta-språk-hodet.
Anmodning
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
svar
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": ""
}
},
...
]
Eksempel: hent alle
Dette eksemplet returnerer data for alle tilgjengelige regler.
Anmodning
GET [Geographical URI]/api/rule?api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8
svar
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": ""
}
},
...
]
Eksempel: hente for et regelsett med meldingsformater
Dette eksemplet returnerer data for alle reglene i Løsningskontroll-regelsettet på fransk språk. Hvis det ønskede språket er engelsk, fjerner du bare godta-språk-hodet.
Anmodning
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
svar
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."
}
]
},
...
]
Se også
Bruk web-API-en for kontrolløren Power Apps
Hente listen over regelsett
Last opp en fil
Påkall analyse
Se etter analysestatus