Nota
O acceso a esta páxina require autorización. Pode tentar iniciar sesión ou modificar os directorios.
O acceso a esta páxina require autorización. Pode tentar modificar os directorios.
As regras agrúpanse mediante un conxunto de regras. Unha regra pode estar en varios conxuntos de regras ou en ningún. Use a solicitude GET para obter unha lista de todas as regras dispoñibles, as regras dun conxunto de regras ou os conxuntos de regras chamando á API [Geographical URI]/api/rule. Hai algunhas variacións para chamar a esta API. Non obstante, o uso máis común é recuperar a lista de regras dun conxunto de regras específico.
Nota
Esta API require un OAuth token.
Cabeceiras
| Nome | Tipo | Valor esperado | Requirido? |
|---|---|---|---|
| Accept-Language | cadea | O código do idioma (por exemplo, en-US). O valor predefinido é en-US. | non |
Parámetros
| Nome | Tipo | Valor esperado | Requirido? |
|---|---|---|---|
| ruleset | cadea | O nome ou o ID do conxunto de regras ou unha lista de ID de conxuntos de regras ou nomes separados por unha coma ou un punto e coma (por exemplo, "Verificador de solucións"). | non |
| includeMessageFormats | booleano | Cando está configurado en true, a lista de posibles variacións de mensaxes inclúese nos resultados das solicitudes de idiomas, se está dispoñible. Esta lista é útil para traducións a varias linguas. Se non é necesario, non proporcione este parámetro nin proporcione false como valor, xa que este parámetro aumenta o tamaño da resposta e pode aumentar o tempo de procesamento. |
non |
Respostas esperadas
| Código de estado HTTP | Escenario | Resultado |
|---|---|---|
| 200 | Atopáronse un ou máis resultados | Vexa o exemplo máis adiante neste artigo. Poden devolverse un ou máis resultados. |
| 204 | Non se atoparon resultados | Non hai resultados no corpo de resposta. |
| 401 | Erro de autenticación | Non hai resultados no corpo de resposta. |
Corpo da resposta esperado
A seguinte táboa describe a estrutura da resposta para cada solicitude (só resposta HTTP 200).
| Propiedade | Tipo | Valor esperado | Requirido? |
|---|---|---|---|
| code | cadea | Identificador da regra, ás veces denominado ID da regra. | Si |
| resumo | cadea | Un resumo da regra. | Si |
| descrición | cadea | Descrición máis detallada da regra. | Si |
| guidanceUrl | URI | URL no que atopar orientacións publicadas. Pode haber algúns casos nos que non haxa un artigo de orientación de apoio específico. | Si |
| include | boolean | Sinais ao servizo de que a regra debe incluírse na análise. Este valor é true para esta API. |
No |
| messageTemplates | matriz | Este valor da propiedade está incluído só cando includeMessageFormats é true. |
No |
| messageTemplates.ruleId | cadea | Devolve o mesmo valor de ID que a propiedade code. |
Si |
| messageTemplates.messageTemplateId | cadea | Identificador empregado no Formato de intercambio de resultados de análise estática (SARIF) para sinalar unha variación da mensaxe de emisión da regra. | Si |
| messageTemplates.messageTemplate | cadea | Texto da variación da mensaxe para o escenario de emisión que informa a regra. Este texto é unha cadea de formato que pode conter tokens nos que se poden usar os argumentos proporcionados no informe SARIF para construír unha mensaxe detallada. | Si |
Exemplo: recuperar regras para un conxunto de regras noutro idioma
Este exemplo devolve os datos de todas as regras do conxunto de regras Verificador de solucións en lingua francesa. Se o idioma desexado é o inglés, elimine a cabeceira Accept-Language.
Solicitude
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
Resposta
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": ""
}
},
...
]
Exemplo: recuperar todo
Este exemplo devolve os datos de todas as regras dispoñibles.
Solicitude
GET [Geographical URI]/api/rule?api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8
Resposta
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": ""
}
},
...
]
Exemplo: recuperar un conxunto de regras con formatos de mensaxes
Este exemplo devolve os datos de todas as regras do conxunto de regras Verificador de solucións en lingua francesa. Se o idioma desexado é o inglés, elimine a cabeceira Accept-Language.
Solicitude
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
Resposta
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."
}
]
},
...
]
Consulte tamén
Usa a API web de verificación Power Apps
Recuperar a lista de conxuntos de regras
Cargar un ficheiro
Invocar análise
Comprobar o estado da análise