SPServiceInstance members
Represents a single instance of a service that runs on a server.
The SPServiceInstance type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SPServiceInstance() | Reserved for internal use. |
.gif "Protected method") |
SPServiceInstance(String, SPServer, SPService) | Initializes a new instance of the SPServiceInstance class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CanUpgrade | Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.) |
|
DeploymentLocked | (Inherited from SPPersistedObject.) |
|
Description | Gets the description of the service that is used in the Administration user interface. |
|
DisplayName | Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.) |
|
Farm | Gets the server farm where the object resides. (Inherited from SPPersistedObject.) |
|
Hidden | Gets a Boolean value that indicates whether the service instance is displayed in the user interface. |
|
Id | Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.) |
|
Instance | Gets the name of this instance. |
|
IsBackwardsCompatible | Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.) |
|
ManageLink | Gets a link object that represents the action that manages the service on the Services on Server page in SharePoint Central Administration. |
|
Name | Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.) |
|
NeedsUpgrade | Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.) |
|
NeedsUpgradeIncludeChildren | Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.) |
|
Parent | Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.) |
|
Properties | Gets metadata for the persisted object. (Inherited from SPPersistedObject.) |
|
ProvisionLink | Gets a link object that represents the action that starts the service on the Services on Server page in SharePoint Central Administration. |
.gif "Protected property") |
ProvisionUpdateStatus | Gets a Boolean value that indicates whether the object status is set to Online when the Provision method is called. |
|
ReprovisionLink | |
|
Roles | Obsolete. Gets a list of the roles to which the service instance belongs, for classification on the Services on Server page in SharePoint Central Administration. |
|
Server | Gets the server on which the service instance is installed. |
|
Service | Gets the service that owns this service instance. |
|
ShouldDeferUpgradeActions | (Inherited from SPPersistedUpgradableObject.) |
|
Status | Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.) |
|
SystemService | Gets a Boolean value that indicates whether the service is a system service. |
|
TypeName | Gets the display name that describes the service instance in the Administration user interface. (Overrides SPPersistedObject.TypeName.) |
|
UnprovisionLink | Gets a link object that represents the action that stops the service on the Services on Server page in SharePoint Central Administration. |
|
UpgradeContext | Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.) |
|
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) |
|
Version | Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.) |
|
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 | |
|---|---|---|
|
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.) |
|
Delete | Deletes the object. (Inherited from SPPersistedObject.) |
|
Equals | Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.) |
|
Finalize | (Inherited from Object.) |
|
GetChild<T>() | Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.) |
|
GetChild<T>(String) | Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.) |
|
GetHashCode | Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.) |
|
GetObjectData | Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.) |
|
GetType | (Inherited from Object.) |
|
HasAdditionalUpdateAccess | Override this method to allow more users to update the object. (Inherited from SPPersistedObject.) |
|
Invalidate | Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.) |
|
LegacyUpdate | (Inherited from SPPersistedObject.) |
|
MemberwiseClone | (Inherited from Object.) |
|
OnDeserialization | Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.) |
|
OnPostCreate | (Inherited from SPPersistedObject.) |
|
OnPreCreate | (Inherited from SPPersistedObject.) |
|
Provision | Starts the service instance on the server. (Overrides SPPersistedObject.Provision().) |
|
RunWithConcurrencyRetries | (Inherited from SPPersistedObject.) |
|
ShouldProvision | Available in SharePoint 2016 and later. When overridden in a derived class, returns a value that indicates whether an instance of the service should be automatically provisioned on servers with the specified role. |
|
ToString | Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.) |
|
Uncache | Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.) |
|
Unprovision | Stops the service instance on the server. (Overrides SPPersistedObject.Unprovision().) |
|
Update() | Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.) |
|
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.) |
|
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) |
|
UpdateWithNoObjectCallbackCheck | (Inherited from SPPersistedObject.) |
|
Upgrade() | Upgrades the object. (Inherited from SPPersistedUpgradableObject.) |
|
Upgrade(Boolean) | Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.) |
|
Validate | Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.) |
|
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.) |
Top