Recuperar la llista de normes
Les normes s'agrupen mitjançant un conjunt de normes. Una norma pot estar en cap conjunt de normes o diversos conjunts de normes. Utilitzeu una sol·licitud GET per obtenir una llista de totes les normes disponibles, les normes en un conjunt de normes o els conjunts de normes trucant a l'API [Geographical URI]/api/rule. Hi ha algunes variacions per trucar a l'API, però l'ús més habitual és recuperar la llista de normes d'un determinat conjunt de normes.
Nota
Aquesta API requereix un testimoni d'OAuth.
Capçaleres
| Nom | Type | Valor esperat | És obligatori? |
|---|---|---|---|
| Accept-Language | cadena | El codi de llengua (per exemple, en-US). El valor per defecte és en-US. | no |
Paràmetres
| Nom | Type | Valor esperat | És obligatori? |
|---|---|---|---|
| ruleset | string | El nom o l'identificador del conjunt de regles o una llista d'identificadors de conjunts de regles, o noms separats per una coma o punt i coma (per exemple, "Comprovador de solucions"). | no |
| includeMessageFormats | bool | Si es defineix com a true, la llista de possibles variacions dels missatges s'inclou als resultats de les sol·licituds de llengua, si està disponible. Aquesta llista és útil per a traduccions a diversos idiomes. Si no cal, no proporcioneu aquest paràmetre ni proporcioneu false com a valor, ja que aquest paràmetre augmenta la mida de la resposta i pot augmentar el temps de processament. |
no |
Respostes esperades
| Codi d'estat HTTP | Escenari | Resultat |
|---|---|---|
| 200 | S'han trobat un o més resultats | Vegeu l'exemple més endavant en aquest article. Un o diversos resultats es poden retornar. |
| 204 | No s'han trobat resultats | No hi ha cap resultat al cos de resposta. |
| 401 | Error d'autenticació | No hi ha cap resultat al cos de resposta. |
Cos de resposta esperat
A la taula següent s'exposa l'estructura de la resposta de cada sol·licitud (només per a la resposta HTTP 200).
| Propietat | Type | Valor esperat | És obligatori? |
|---|---|---|---|
| code | string | L'identificador de la norma, de vegades conegut com a identificador de la norma. | Sí |
| Resum | cadena | Un resum de la regla. | Sí |
| descripció | cadena | Descripció més detallada de la norma. | Sí |
| guidanceUrl | URI | L'adreça URL en la qual es pot trobar orientació publicada. Pot haver-hi alguns casos en què no hi hagi un article d'orientació de suport dedicat. | Sí |
| inclou | boolean | Assenyala al servei que s'ha d'incloure la norma a l'anàlisi. Aquest valor és true per a aquesta API. |
No |
| messageTemplates | matriu | Aquest valor de propietat només s'inclou quan includeMessageFormats és true. |
No |
| messageTemplates.ruleId | string | Retorna el mateix valor d'identificador que la propietat code. |
Sí |
| messageTemplates.messageTemplateId | string | Identificador utilitzat a l'informe en format d'intercanvi de resultats d'anàlisi estàtica (SARIF) per indicar la variació d'un missatge d'emissió per a la norma. | Sí |
| messageTemplates.messageTemplate | string | El text de la variació de missatges per a l'escenari de problema que informa la norma. Aquest text és una cadena de format que pot contenir fitxes en què es poden utilitzar arguments proporcionats a l'informe SARIF per construir un missatge detallat. | Sí |
Exemple: recuperar les normes d'un conjunt de normes en una altra llengua
En aquest exemple es mostren les dades de totes les normes del conjunt de normes Comprovador de solucions en francès. Si la llengua desitjada és l'anglès, només heu de suprimir la capçalera Accept-Language.
Sol·licitud
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": ""
}
},
...
]
Exemple: recuperar-ho tot
En aquest exemple es mostren les dades de totes les normes disponibles.
Sol·licitud
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": ""
}
},
...
]
Exemple: recuperar un conjunt de normes amb format de missatge
En aquest exemple es mostren les dades de totes les normes del conjunt de normes Comprovador de solucions en francès. Si la llengua desitjada és l'anglès, només heu de suprimir la capçalera Accept-Language.
Sol·licitud
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."
}
]
},
...
]
Consulteu també
Ús de l'API web del comprovador del Power Apps
Recuperar la llista de conjunts de normes
Carregar un fitxer
Invocar l'anàlisi
Comprovar l'estat de l'anàlisi
Comentaris
Properament: al llarg del 2024 eliminarem gradualment GitHub Issues com a mecanisme de retroalimentació del contingut i el substituirem per un nou sistema de retroalimentació. Per obtenir més informació, consulteu: https://aka.ms/ContentUserFeedback.
Envieu i consulteu els comentaris de