SPHealthRulesList - Classe

Article
10/14/2015

Représente une liste de définitions de règle Analyseur d’intégrité SharePoint inscrit avec la batterie de serveurs.

Hiérarchie d’héritage

System.Object
  Microsoft.SharePoint.SPSecurableObject
    Microsoft.SharePoint.SPList
      Microsoft.SharePoint.Administration.Health.SPHealthRulesList

Espace de noms : Microsoft.SharePoint.Administration.Health
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public NotInheritable Class SPHealthRulesList _
    Inherits SPList _
    Implements IDisposable
'Utilisation
Dim instance As SPHealthRulesList

[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public sealed class SPHealthRulesList : SPList, 
    IDisposable

Remarques

Cette classe représente la liste des Règles de police sanitaire dans la section de surveillance de l'Administration centrale. Un administrateur de batterie peut utiliser la liste des Règles de police sanitaire pour modifier les paramètres d'une règle d'intégrité, modification d'où et quand la règle s'exécute ou même désactiver complètement la règle.

Pour obtenir une instance de la classe SPHealthRulesList , accéder à la propriété statique Local . Une fois que vous avez SPHealthRulesList objet, vous pouvez interroger la liste comme vous le feriez pour n'importe quel objet SPList .

Important

L'objet SPHealthRulesList retourné par la propriété Local utilise des ressources non managées. Vous êtes chargé de libérer ces ressources. Une façon de le faire consiste à appeler la méthode Dispose() lorsque vous n'avez plus l'objet.

Exemples

L'exemple suivant est une application de console qui imprime le titre et la planification pour chaque règle dans la liste des Règles sanitaires pour la batterie de serveurs. Notez que pour accéder à la liste des Règles de police sanitaire , le serveur local doit être joint à la batterie de serveurs.

using System;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Administration;
using Microsoft.SharePoint.Administration.Health;

namespace Test
{
    class Program
    {
        static void Main(string[] args)
        {
            if (SPFarm.Joined)
            {
                using (SPHealthRulesList list = SPHealthRulesList.Local)
                {
                    // Get a collection of rule definitions in alphabetical order.
                    SPQuery query = new SPQuery();
                    query.Query = "<OrderBy><FieldRef Name=\"LinkTitleNoMenu\" /></OrderBy>";
                    SPListItemCollection rules = list.GetItems(query);

                    // Print the title and schedule for each item.
                    foreach (SPListItem rule in rules)
                    {
                        Console.WriteLine("\n{0} Runs: {1}",
                            rule[SPBuiltInFieldId.LinkTitleNoMenu].ToString(),
                            rule[SPBuiltInFieldId.HealthRuleSchedule].ToString());
                    }
                }
            }
            Console.Write("\nPress ENTER to continue...");
            Console.Read();
        }
    }
}

Imports System
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Administration
Imports Microsoft.SharePoint.Administration.Health

Module Test

    Sub Main()

        If SPFarm.Joined Then

            Using list As SPHealthRulesList = SPHealthRulesList.Local

                ' Get a collection of rule definitions in alphabetical order.
                Dim query As SPQuery = New SPQuery()
                query.Query = "<OrderBy><FieldRef Name='LinkTitleNoMenu' /></OrderBy>"
                Dim rules As SPListItemCollection = list.GetItems(query)

                ' Print the title, date, and status for each item.
                Dim rule As SPListItem
                For Each rule In rules
                    Console.WriteLine(vbCrLf + "{0} Runs: {1}", _
                            rule(SPBuiltInFieldId.LinkTitleNoMenu).ToString(), _
                            rule(SPBuiltInFieldId.HealthRuleSchedule).ToString())
                Next

            End Using
        End If
        Console.Write(vbCrLf + "Press ENTER to continue...")
        Console.Read()
    End Sub

End Module