Класс SPHealthRulesList

Статья
05/13/2015

Представляет список Анализатор работоспособности SharePoint определения правил, зарегистрированных в ферме.

Иерархия наследования

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

Пространство имен: Microsoft.SharePoint.Administration.Health
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public NotInheritable Class SPHealthRulesList _
    Inherits SPList _
    Implements IDisposable
'Применение
Dim instance As SPHealthRulesList

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

Замечания

Этот класс представляет список Правил работоспособности в разделе мониторинг центра администрирования. Администратор фермы можно использовать список Правил работоспособности для изменения параметров для правила работоспособности, изменение которых или при выполнении правила или даже полностью отключить правило.

Для получения экземпляра класса SPHealthRulesList , доступ к свойству статических Local . После получения объекта SPHealthRulesList можно запросить список как и любой объект SPList .

Важно!

SPHealthRulesList объект, возвращенный свойством Local использует неуправляемые ресурсы. Вы несете ответственность за освобождение этих ресурсов. Это можно сделать, — это вызвать метод Dispose() , когда объект больше не требуется.

Примеры

Следующий пример является консольное приложение, печатает название и расписания для каждого правила в списке Правил работоспособности для фермы. Обратите внимание на то, чтобы получить доступ к списку Правил работоспособности , локальный сервер должен быть присоединен к ферме.

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

Потокобезопасность

Любые общедоступные элементы static (Shared в Visual Basic) этого типа являются потокобезопасными. Не гарантируется, что любые элементы экземпляров потокобезопасны.