Hente listen over regler
Regler grupperes ud fra et regelsæt. En regel kan være i intet eller flere regelsæt. Brug en GET-anmodning til at hente en liste over alle tilgængelige regler, regler i et regelsæt eller regelsæt ved at kalde API'en [Geographical URI]/api/rule. Der er nogle få variationer af kald for denne API, men det mest almindelige er at hente listen over regler for et bestemt regelsæt.
Bemærk
Denne API kræver et OAuth-token.
Overskrifter
| Name | Type | Forventet værdi | Påkrævet? |
|---|---|---|---|
| Acceptér sprog | string | Sprogkoden (f.eks. en-US). Standardkoden er en-US. | nej |
Parametre
| Navn | Type | Forventet værdi | Påkrævet? |
|---|---|---|---|
| ruleset | string | Navnet eller id'et for regelsættet eller en liste over regelsæt-id'er eller navne, der er adskilt af et komma eller semikolon (f.eks. "Løsningskontrol"). | nej |
| includeMessageFormats | bool | Når indstillingen er angivet til true, inkluderes der en liste over mulige meddelelsesvariationer i resultaterne af de tilgængelige sproganmodninger. Denne liste er nyttig i forbindelse med oversættelser til flere sprog. Hvis den ikke er nødvendig, skal du ikke angive denne parameter eller angive false som værdien, da denne parameter øger størrelsen på svaret og kan øge behandlingstiden. |
nej |
Forventede svar
| HTTP-statuskode | Scenarie | Resultatat |
|---|---|---|
| 200 | Der blev fundet et eller flere resultater | Se eksemplet senere i denne artikel. Der kan blive returneret et eller flere resultater. |
| 204 | Der blev ikke fundet nogen resultater | Ingen resultater i svarets brødtekst. |
| 401 | Godkendelse mislykkedes | Ingen resultater i svarets brødtekst. |
Forventet brødtekst i svar
I følgende tabel skitseres strukturen i svaret for hver anmodning (kun HTTP 200-svar).
| Egenskab | Skriv | Forventet værdi | Påkrævet? |
|---|---|---|---|
| kode | string | Id'et for reglen, som også kaldes regel-id'et. | Ja |
| summary | string | En oversigt over reglen. | Ja |
| Beskrivelse | string | Mere detaljeret beskrivelse af reglen. | Ja |
| guidanceUrl | URI | Den URL-adresse, hvor du kan finde publicerede vejledninger. Der kan være tilfælde, hvor der ikke findes en vejledningsartikel med specifik hjælp. | Ja |
| include | boolean | Signalerer til den tjeneste, som reglen skal inkluderes i analysen. Denne værdi er true til denne API. |
Nej |
| messageTemplates | matrix | Denne egenskabsværdi medtages kun, når includeMessageFormats er true. |
Nej |
| messageTemplates.ruleId | string | Returnerer samme id-værdi som egenskaben code. |
Ja |
| messageTemplates.messageTemplateId | string | Et id, der bruges i SARIF-rapporten (Static Analysis Results Interchange Format) til at signalere en variation af problemmeddelelsen for reglen. | Ja |
| messageTemplates.messageTemplate | string | Teksten i meddelelsesvariationen for det problemscenarie, som reglen rapporterer. Denne tekst er en formatstreng, der kan indeholde tokens, hvor de argumenter, der er angivet i SARIF-rapporten, kan bruges til at oprette en detaljeret meddelelse. | Ja |
Eksempel: hente regler for et regelsæt på et andet sprog
I dette eksempel returneres data til alle reglerne i regelsættet Løsningskontrol på det franske sprog. Hvis det ønskede sprog er engelsk, skal du blot fjerne overskriften for Acceptér-sprog.
Anmodning
GET [Geographical URI]/api/rule?ruleset=083A2EF5-7E0E-4754-9D88-9455142DC08B&api-version=2.0
x-ms-correlation-id: 9E378E56-6F35-41E9-BF8B-C0CC88E2B832
Accept: application/json
Content-Type: application/json; charset=utf-8
Accept-Language: fr
Response
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: hente alle
I dette eksempel returneres data til alle de regler, der er tilgængelige.
Anmodning
GET [Geographical URI]/api/rule?api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8
Response
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 et regelsæt med meddelelsesformater
I dette eksempel returneres data til alle reglerne i regelsættet Løsningskontrol på det franske sprog. Hvis det ønskede sprog er engelsk, skal du blot fjerne overskriften for Acceptér-sprog.
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
Response
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å
Bruge web-API'en for Power Apps-kontrol
Hente listen over regelsæt
Overføre en fil
Aktivere analyser
Kontrollere analysestatus
Feedback
Kommer snart: I hele 2024 udfaser vi GitHub-problemer som feedbackmekanisme for indhold og erstatter det med et nyt feedbacksystem. Du kan få flere oplysninger under: https://aka.ms/ContentUserFeedback.
Indsend og få vist feedback om