Truy xuất danh sách các quy tắc

Bài viết
05/01/2024

Các quy tắc được nhóm lại với nhau bằng cách sử dụng một bộ quy tắc. Một quy tắc có thể không nằm trong bộ quy tắc hoặc nằm trong nhiều bộ quy tắc. Sử dụng một yêu cầu GET để lấy danh sách tất cả các quy tắc có sẵn, quy tắc trong bộ quy tắc hoặc bộ quy tắc bằng cách gọi API [Geographical URI]/api/rule. Có một vài biến thể để gọi API này, tuy nhiên, cách sử dụng phổ biến nhất là truy xuất danh sách các quy tắc cho một bộ quy tắc cụ thể.

Lưu ý

API này yêu cầu mã thông báo OAuth.

Tiêu đề

Tên	Loại	Giá trị mong đợi	Bắt buộc?
Ngôn ngữ chấp nhận	string	Mã ngôn ngữ (ví dụ: en-US). Mã mặc định là en-US.	không

Tham số

Tên	Loại	Giá trị mong đợi	Bắt buộc?
ruleset	string	Tên hoặc ID của bộ quy tắc hoặc danh sách ID bộ quy tắc hoặc các tên được phân tách bằng dấu phẩy hoặc dấu chấm phẩy (ví dụ: "Trình kiểm tra giải pháp").	không
includeMessageFormats	bool	Khi được đặt thành `true`, danh sách các biến thể tin nhắn có thể có trong kết quả của các yêu cầu ngôn ngữ, nếu có. Danh sách này hữu ích cho việc dịch sang nhiều ngôn ngữ. Nếu không cần thiết, bạn không cần cung cấp tham số này hoặc cung cấp `false` làm giá trị vì tham số này sẽ tăng kích thước của phản hồi và có thể tăng thời gian xử lý.	không

Phản hồi mong đợi

Mã trạng thái HTTP	Kịch bản	Kết quả
200	Đã tìm thấy một hoặc nhiều kết quả	Xem ví dụ sau trong bài viết này. Có thể trả lại một hoặc nhiều kết quả.
204	Không tìm thấy kết quả	Không có kết quả trong nội dung phản hồi.
401	Không xác thực được	Không có kết quả trong nội dung phản hồi.

Nội dung phản hồi mong đợi

Bảng sau đây phác thảo cấu trúc của phản hồi cho từng yêu cầu (chỉ với phản hồi HTTP 200).

Thuộc tính	Loại	Giá trị mong đợi	Bắt buộc?
code	string	Mã định danh của quy tắc, đôi khi được gọi là ID quy tắc.	Có
tóm tắt	string	Tóm tắt về quy tắc.	Có
mô tả	string	Mô tả chi tiết hơn về quy tắc.	Có
guidanceUrl	URI	Các URL để tìm hướng dẫn được công bố. Có thể có một số trường hợp không có bài viết hướng dẫn hỗ trợ riêng.	Có
bao gồm	boolean	Tín hiệu cho dịch vụ mà quy tắc sẽ được đưa vào phân tích. Giá trị này `true` dành cho API này.	No
messageTemplates	mảng	Giá trị thuộc tính này chỉ được bao gồm khi `includeMessageFormats` là `true`.	Không
messageTemplates.ruleId	string	Trả về cùng giá trị ID như thuộc tính `code`.	Có
messageTemplates.messageTemplateId	string	Một mã định danh được sử dụng trong báo cáo Định dạng trao đổi kết quả phân tích tĩnh (SARIF) để báo hiệu một biến thể thông báo vấn đề cho quy tắc.	Có
messageTemplates.messageTemplate	string	Văn bản của biến thể thông báo cho kịch bản vấn đề mà quy tắc báo cáo. Văn bản này là một chuỗi định dạng có thể chứa các mã thông báo trong đó các đối số được cung cấp trong báo cáo SARIF có thể được sử dụng để xây dựng một thông báo chi tiết.	Có

Ví dụ: truy xuất quy tắc cho bộ quy tắc bằng ngôn ngữ khác

Ví dụ này trả về dữ liệu cho tất cả các quy tắc trong bộ quy tắc Kiểm tra giải pháp trong ngôn ngữ tiếng Pháp. Nếu ngôn ngữ mong muốn là tiếng Anh, thì chỉ cần xóa tiêu đề Ngôn ngữ chấp nhận.

Yêu cầu

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

Câu trả lời

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

Ví dụ: truy xuất tất cả

Ví dụ này trả về dữ liệu cho tất cả các quy tắc có sẵn.

Yêu cầu

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

Câu trả lời

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

Ví dụ: truy xuất bộ quy tắc với định dạng thông báo

Yêu cầu

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

Câu trả lời

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 &lt;T&gt; 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."
            }
        ]
    },
...
]

Xem thêm

Sử dụng API web trình kiểm tra Power Apps
Truy xuất danh sách các bộ quy tắc
Tải tệp lên
Gọi phân tích
Kiểm tra trạng thái phân tích

Chia sẻ qua

Truy xuất danh sách các quy tắc

Tiêu đề

Tham số

Phản hồi mong đợi

Nội dung phản hồi mong đợi

Ví dụ: truy xuất quy tắc cho bộ quy tắc bằng ngôn ngữ khác

Ví dụ: truy xuất tất cả

Ví dụ: truy xuất bộ quy tắc với định dạng thông báo

Xem thêm

Phản hồi

Phản hồi

Tài nguyên bổ sung