Share via


SPDiagnosticsServiceBase members

Provides a diagnostic logging category manager for Microsoft SharePoint Foundation.

The SPDiagnosticsServiceBase type exposes the following members.

Constructors

  Name Description
Protected method SPDiagnosticsServiceBase() Initializes a new instance of the SPDiagnosticsServiceBase class.
Protected method SPDiagnosticsServiceBase(String, SPFarm) Initializes a new instance of the SPDiagnosticsServiceBase class by using the specified parameters.

Top

Properties

  Name Description
Public property Applications Gets the collection of service applications associated with the service. (Inherited from SPService.)
Public property Areas Gets a collection of all areas in this SPDiagnosticsService object.
Public property AutoProvision Available in SharePoint 2016 and later. Gets (and in some scenarios sets) a Boolean value that indicates whether the service is enabled on the farm. (Inherited from SPService.)
Public property CanBackupRestoreAsConfiguration Gets a value that indicates whether the service object can be selected for inclusion in a configuration-only backup or restore operation.
Public property CanRenameOnRestore Gets a Boolean value that indicates whether the service object can be renamed when it is restored.
Public property CanSelectForBackup Gets or sets a Boolean value that indicates whether the SPDiagnosticsServiceBase object can be selected for a backup operation in the Central Administration user interface (UI).
Public property CanSelectForRestore Gets or sets a Boolean value that indicates whether the SPDiagnosticsServiceBase object can be selected for a restore operation in the Central Administration user interface (UI).
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property CompliantWithMinRole (Inherited from SPService.)
Public property CorrelationVisibleID Gets the logging correlation identifier in the current thread.
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property Description (Inherited from SPService.)
Public property DiskSizeRequired Gets the disk space that is required for a backup.
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Hidden (Inherited from SPService.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property Instances Gets a collection of all instances of the service in the server farm. (Inherited from SPService.)
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property JobDefinitions Gets a collection of job definitions for this service. (Inherited from SPService.)
Public property JobHistoryEntries Gets an enumeration of the job history entries for this service. (Inherited from SPService.)
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property NeedsUpgrade Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property NeedsUpgradeIncludeChildren Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property Required Gets a Boolean value that indicates whether an instance of the service must be running on at least one computer in the server farm. (Inherited from SPService.)
Protected property ResourceDll Returns the name of a resource that contains localized strings for category names.
Public property RunningJobs Gets a collection of running jobs for this service. (Inherited from SPService.)
Public property ShouldDeferUpgradeActions (Inherited from SPPersistedUpgradableObject.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property SystemService (Inherited from SPService.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UpgradeContext Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

  Name Description
Public method AddBackupObjects Adds the SPDiagnosticesServiceBase object to the backup/restore operation.
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method Delete Removes the service and associated resources. (Inherited from SPService.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetCreateApplicationLink Gets the administration user interface link that is used to create a new service application. (Inherited from SPService.)
Public method GetCreateApplicationOptions Gets the options for creating a new service application. (Inherited from SPService.)
Protected method GetFirstPreconfiguredDatabase (Inherited from SPService.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Protected methodStatic member GetLocal<T> Returns an instance of the class derived from SPDiagnosticsServiceBase described by the T parameter.
Protected methodStatic member GetLocalToFarm<T> Returns an instance of the class derived from SPDiagnosticsServiceBase described by the T parameter.
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Protected method GetPreconfiguredDatabaseInfo (Inherited from SPService.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public method IsUserLicensedForEntity Checks if the current user has the proper license to access the specified entity. (Inherited from SPService.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAbort Raises the Abort event.
Public method OnBackup Raises the Backup event.
Public method OnBackupComplete Raises the BackupComplete event.
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Public method OnPostRestore Raises the PostRestore event.
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method OnPrepareBackup Raises the PrepareBackup event.
Public method OnPreRestore Raises the PreRestore event.
Public method OnRestore Raises the Restore event.
Protected method ProvideAreas Returns a collection of the event and trace logging categories used with this service.
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method ResetAll Resets reporting thresholds for all categories to their diagnostic logging thresholds.
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method SetAll(EventSeverity) Sets the threshold at which events associated with all categories are written to the event log.
Public method SetAll(TraceSeverity) Sets the threshold at which traces associated with all categories are written to the trace log.
Public method SetAll(TraceSeverity, EventSeverity) Sets the threshold at which traces and Windows events associated with all categories are written to trace logs and the Windows event log.
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes the SPDiagnosticsServiceBase object to save its state and propagate changes to all servers in the farm. (Overrides SPPersistedObject.Update().)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
Public method ValidateBackwardsCompatibility Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)
Public method WriteEvent Writes an event to the Windows application event log, if the event severity is above the configured threshold for the SPDiagnosticsCategory.
Public method WriteTrace Writes a trace to the Microsoft SharePoint Foundation trace log.

Top

Explicit interface implementations

  Name Description
Explicit interface implemetationPrivate property IBackupRestore.Name Gets or sets the name for the SPDiagnosticsServiceBase object.

Top

See also

Reference

SPDiagnosticsServiceBase class

Microsoft.SharePoint.Administration namespace