SPHealthAnalysisRule - Classe

Article
10/14/2015

Une classe de base abstraite qui fournit une définition pour une règle Analyseur d’intégrité SharePoint .

Hiérarchie d’héritage

System.Object
Microsoft.SharePoint.Administration.Health.SPHealthAnalysisRule
Microsoft.SharePoint.Administration.Health.SPRepairableHealthAnalysisRule

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

Syntaxe

'Déclaration
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public MustInherit Class SPHealthAnalysisRule
'Utilisation
Dim instance As SPHealthAnalysisRule

[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public abstract class SPHealthAnalysisRule

Remarques

Une règle de Analyseur d’intégrité SharePoint est une sous-classe concrète qui hérite de l'une des deux classes abstraites : SPHealthAnalysisRule ou SPRepairableHealthAnalysisRule. La seule différence entre ces deux classes est que les deux ont une méthode Check() pour détecter un problème, la classe SPRepairableHealthAnalysisRule a également une méthode Repair() pour corriger le problème trouvé par la méthode Check .

Lorsque vous créez une sous-classe de la classe SPHealthAnalysisRule , vous devez substituer et implémenter la Summary, Explanation, Remedy, Categoryet les propriétés ErrorLevel ainsi que la méthode Check() . Si vous souhaitez que la règle s'exécute automatiquement dans un travail de minuteur, vous devez substituer et implémenter ainsi que la propriété AutomaticExecutionParameters . Mise en oeuvre des autres membres de la classe est facultative.

Exemples

L'exemple suivant crée une règle qui vérifie si le serveur local est joint à la batterie de serveurs.

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

namespace Sample.HealthRules
{
    public sealed class LocalJoinedToFarm : SPHealthAnalysisRule
    {
        
        public override string Summary
        {
            get { return "The local server is not joined to a SharePoint server farm."; }
        }

        public override string Explanation
        {
            get { return "SharePoint is installed on this server, but the installation will not function until the server has been joined to a SharePoint server farm."; }
        }

        public override string Remedy
        {
            get { return "Run the SharePoint Products and Technologies Configuration Wizard and follow the prompts to create a new farm or to join this server to an existing farm."; }
        }

        public override SPHealthCategory Category
        {
            get { return SPHealthCategory.Configuration; }
        }

        public override SPHealthCheckErrorLevel ErrorLevel
        {
            get { return SPHealthCheckErrorLevel.Error; }
        }

        public override SPHealthAnalysisRuleAutomaticExecutionParameters AutomaticExecutionParameters
        {
            get
            {
                SPHealthAnalysisRuleAutomaticExecutionParameters retval = new SPHealthAnalysisRuleAutomaticExecutionParameters();
                retval.Schedule = SPHealthCheckSchedule.Hourly;
                retval.Scope = SPHealthCheckScope.All;
                retval.ServiceType = typeof(SPTimerService);
                retval.RepairAutomatically = false;
                return retval;
            }
        }        
        
        public override SPHealthCheckStatus Check()
        {
            return SPFarm.Joined ? SPHealthCheckStatus.Passed : SPHealthCheckStatus.Failed;
        }
    }

}

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

Namespace Sample.HealthRules
    Public NotInheritable Class LocalJoinedToFarm
        Inherits SPHealthAnalysisRule

        Public Overrides ReadOnly Property Summary() As String
            Get
                Return "The local server is not joined to a SharePoint server farm."
            End Get
        End Property

        Public Overrides ReadOnly Property Explanation() As String
            Get
                Return "SharePoint is installed on this server, but the installation will not function until the server has been joined to a SharePoint server farm."
            End Get
        End Property

        Public Overrides ReadOnly Property Remedy() As String
            Get
                Return "Run the SharePoint Products and Technologies Configuration Wizard and follow the prompts to create a new farm or to join this server to an existing farm."
            End Get
        End Property

        Public Overrides ReadOnly Property Category() As SPHealthCategory
            Get
                Return SPHealthCategory.Configuration
            End Get
        End Property

        Public Overrides ReadOnly Property ErrorLevel() As SPHealthCheckErrorLevel
            Get
                Return SPHealthCheckErrorLevel.Error
            End Get
        End Property

        Public Overrides ReadOnly Property AutomaticExecutionParameters() As SPHealthAnalysisRuleAutomaticExecutionParameters
            Get
                Dim retval As New SPHealthAnalysisRuleAutomaticExecutionParameters()
                retval.Schedule = SPHealthCheckSchedule.Hourly
                retval.Scope = SPHealthCheckScope.All
                retval.ServiceType = GetType(SPTimerService)
                retval.RepairAutomatically = False
                Return retval
            End Get
        End Property

        Public Overrides Function Check() As SPHealthCheckStatus
            Return If(SPFarm.Joined, SPHealthCheckStatus.Passed, SPHealthCheckStatus.Failed)
        End Function
    End Class

End Namespace