Clase SPHealthRulesList

Artículo
05/13/2015

Representa una lista de definiciones de la regla de Analizador de mantenimiento de SharePoint registrado con la granja de servidores.

Jerarquía de la herencia

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

Espacio de nombres: Microsoft.SharePoint.Administration.Health
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public NotInheritable Class SPHealthRulesList _
    Inherits SPList _
    Implements IDisposable
'Uso
Dim instance As SPHealthRulesList

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

Comentarios

Esta clase representa la lista de Reglas de mantenimiento en la sección de supervisión de la Administración Central. Un administrador de granja de servidores puede usar la lista de Reglas de mantenimiento para editar la configuración de una regla de mantenimiento, cambiar dónde y cuándo se ejecuta la regla o incluso si se deshabilita la regla por completo.

Para obtener una instancia de la clase SPHealthRulesList , tener acceso a la propiedad estática Local . Una vez que el objeto SPHealthRulesList , puede consultar la lista como lo haría con cualquier objeto SPList .

Importante

El objeto SPHealthRulesList devuelto por la propiedad Local utiliza recursos no administrados. Usted es responsable de liberar esos recursos. Una forma de hacerlo es que se llama al método Dispose() cuando ya no necesita el objeto.

Ejemplos

En el siguiente ejemplo es una aplicación de consola que imprime el título y la programación para cada regla de la lista de Reglas de mantenimiento para la granja de servidores. Tenga en cuenta que para obtener acceso a la lista de Reglas de mantenimiento , el servidor local debe estar unido a la granja de servidores.

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

Seguridad para subprocesos

Los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para subprocesos. No se garantiza que los miembros de instancias sean seguros para los subprocesos.