Kurallar listesini alma

Makale
10/16/2024

Kurallar, bir kural kümesi kullanılarak birlikte gruplandırılır. Bir kural, hiçbir kural kümesinde olmayabilir veya birden çok kural kümesinde olabilir. API'yi çağırarak kullanılabilir tüm kuralların, kural kümesindeki kuralların veya kural kümelerinin bir listesini almak için bir GET 'isteği kullanın [Geographical URI]/api/rule. Bu API'yi çağırmanın birkaç yöntemi vardır ancak en yaygın kullanım belirli bir kural kümesine ait kurallar listesini almaktır.

Not

Bu API bir OAuth belirteç gerektirir.

Üst Bilgiler

Adı	Türü	Beklenen değer	Gerekli mi?
Accept-Language	Diize	Dil konu (örneğin, en-US). Varsayılan en-US değeridir.	hayır

Parametreler

Adı	Türü	Beklenen değer	Gerekli mi?
kural kümesi	string	Kural kümesinin adı veya kimliği ya da kural kümesi kimlikleri listesi ya da virgülle ya da noktalı virgülle ayrılmış adlar (örneğin, "Çözüm Denetleyicisi").	hayır
includeMessageFormats	ikili	`true` olarak ayarlandığında olası ileti çeşitlerinin listesi, varsa dil isteklerinin sonuçlarına dahil edilir. Bu liste, birden çok dile çevrilmesi için yararlıdır. Gerekli değilse, bu parametreyi sağlamayın veya bu parametre değeri olarak `false` sağlayın, çünkü bu yanıt boyutunu artırdıkça yanıt boyutunu artırır ve işleme süresini artırabilir.	hayır

Beklenen yanıtlar

HTTP durum kodu	Senaryo	Result
200	Bir veya daha fazla sonuç bulundu	Bu makalenin ilerleyen kısımlarındaki örneğe bakın. Bir veya daha fazla sonuç döndürülebilir.
204	Sonuç bulunamadı	Yanıt gövdesinde sonuç yok.
Kategori 401	Kimlik Doğrulama Başarısız	Yanıt gövdesinde sonuç yok.

Beklenen yanıt gövdesi

Aşağıdaki tabloda, her isteğin yanıt yapısı açıklanmaktadır (yalnızca HTTP 200 yanıtı).

Özellik	Tür	Beklenen değer	Gerekli mi?
kod	string	Kuralın tanımlayıcısı, Kural Kimliği olarak da adlandırılır.	Evet
Özet	Diize	Kuralın özeti.	Evet
Açıklama	Diize	Kuralın daha ayrıntılı açıklaması.	Evet
guidanceUrl	URI	Yayımlanmış rehberliğin bulunacağı URL. Özel bir destek kılavuz makalesi olmayan bazı durumlar olabilir.	Evet
ekle	boolean	Hizmette kuralın analize dahil edileceğini belirten sinyaller. Bu değer, bu API için `true`'dır.	Hayır
messageTemplates	dizi	Bu özellik değeri yalnızca `includeMessageFormats` `true` olduğunda eklenir.	Hayır
messageTemplates.ruleId	string	`code` özelliğiyle aynı kimlik değerini döndürür.	Evet
messageTemplates.messageTemplateId	string	Statik Analiz Sonuçları Değişim Biçimi (SARIF) raporunda, kurala ilişkin bir sorun iletisi çeşidini bildiren sinyal için kullanılan bir tanımlayıcı.	Evet
messageTemplates.messageTemplate	string	Kuralın bildirdiği sorun senaryosunun ileti çeşidinin metni. Bu metin, SARIF raporunda sunulan bağımsız değişkenlerin ayrıntılı bir ileti oluşturmak için kullanabildiği belirteçler içerebilen bir biçim dizesidir.	Evet

Örnek: başka bir dildeki bir kural kümesine ait kuralları al

Bu örnek, Fransızca dilinde Çözüm Denetleyicisi kural kümesindeki tüm kuralların verilerini döndürür. İstediğiniz dil İngilizce ise Accept-Language üst bilgisini kaldırın.

İstek

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

yanıt

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

Örnek: tümünü al

Bu örnek, kullanılabilir tüm kuralların verilerini döndürür.

İstek

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

yanıt

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

Örnek: ileti biçimlerinin bulunduğu bir kural kümesi için al

Bu örnek, Fransızca dilinde Çözüm Denetleyicisi kural kümesindeki tüm kuralların verilerini döndürür. İstediğiniz dil İngilizce ise Accept-Language üst bilgisini kaldırın.

İstek

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

yanıt

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

Ayrıca bkz.

Denetleyici web API'sini Power Apps kullanma
Kural kümelerinin listesini alma
Bir dosya yükleyin
Analizi çağır
Analiz durumunu kontrol edin

Aracılığıyla paylaş

Kurallar listesini alma

Üst Bilgiler

Parametreler

Beklenen yanıtlar

Beklenen yanıt gövdesi

Örnek: başka bir dildeki bir kural kümesine ait kuralları al

Örnek: tümünü al

Örnek: ileti biçimlerinin bulunduğu bir kural kümesi için al

Ayrıca bkz.

Geri Bildirim

Ek kaynaklar