Service Class

The Service class represents an instance of the SQL Server service.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.Wmi.WmiSmoObject
      Microsoft.SqlServer.Management.Smo.Wmi.Service

Namespace:  Microsoft.SqlServer.Management.Smo.Wmi
Assembly:  Microsoft.SqlServer.SqlWmiManagement (in Microsoft.SqlServer.SqlWmiManagement.dll)

Syntax

'Declaration
Public NotInheritable Class Service _
    Inherits WmiSmoObject _
    Implements IAlterable
'Usage
Dim instance As Service

public sealed class Service : WmiSmoObject, 
    IAlterable

public ref class Service sealed : public WmiSmoObject, 
    IAlterable

[<SealedAttribute>]
type Service =  
    class 
        inherit WmiSmoObject 
        interface IAlterable 
    end

public final class Service extends WmiSmoObject implements IAlterable

The Service type exposes the following members.

Properties

	Name	Description
	AcceptsPause	Gets the Boolean property value that specifies whether the SQL Server service can be paused.
	AcceptsStop	Gets the Boolean property value that specifies whether the SQL Server service can be stopped.
	AdvancedProperties	Represents a collection of Property objects. Each Property object represents an advanced property defined on the SQL Server service.
	Dependencies	Returns a list of services that are dependent on the referenced SQL Server service.
	Description	Gets a textual description of the SQL Server service.
	DisplayName	Gets the display name of the SQL Server service.
	ErrorControl	Gets the severity of the error if the SQL Server service fails to start during startup.
	ExitCode	Gets the Win32 error code that defines problems encountered when starting and stopping the SQL Server service.
	IsHadrEnabled	Gets whether the High Availability/Disaster Recovery is enabled.
	Name	Gets or sets the name of the referenced Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
	Parent	Gets the ManagedComputer object that is the parent of the Service object.
	PathName	Gets the path and file name of the binary file that implements the SQL Server service.
	ProcessId	Gets the process ID that uniquely identifies the SQL Server service.
	Properties	Represents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
	ServiceAccount	Gets the system account under which the SQL Server service is running.
	ServiceState	Gets the state of the SQL Server service, such as running, stopped, or paused.
	StartMode	Gets or sets the method by which the SQL Server service is started.
	StartupParameters	Gets or sets any startup parameters for the SQL Server service.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Type	Gets the type of service, such as Microsoft Search service, SQL Server Agent service, or SQL Server service.
	Urn	Gets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object. (Inherited from WmiSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Updates any Service object property changes on an instance of SQL Server.
	ChangeHadrServiceSetting	Changes the HA/DR service settings.
	ChangePassword	Changes the password for the system account under which the SQL Server service is running.
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Initialize	Initializes the referenced object. (Inherited from WmiSmoObject.)
	IsObjectInitialized	Specifies whether the referenced object is initialized. (Inherited from WmiSmoObject.)
	Pause	Pauses the SQL Server service.
	Refresh	Refreshes the SQL Server service. (Overrides WmiSmoObject.Refresh().)
	Resume	Resumes the SQL Server service.
	SetName	Sets the name of the referenced object. (Inherited from WmiSmoObject.)
	SetParentImpl	Sets the parent of the referenced object. (Inherited from WmiSmoObject.)
	SetServiceAccount	Sets the account under which the SQL Server service runs.
	Start	Starts the SQL Server service.
	Stop	Stops the SQL Server service.
	ToString	(Inherited from Object.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	ManagementStateChange	An event that occurs when the management state changes.

Top

Remarks

The Service object is used to programmatically manage the SQL Server service. With the Service object you can:

• Connect to the service.

• Modify the account and password used to connect to the service.

• Start, stop, pause, and resume the service.

• Check the properties of the service.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Managing Services and Network Settings by Using WMI Provider

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo.Wmi Namespace

Other Resources

WMI and SQL Server