Service Service Service Class

Definition

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

public ref class Service sealed : Microsoft::SqlServer::Management::Smo::Wmi::WmiSmoObject, Microsoft::SqlServer::Management::Common::IAlterable
public sealed class Service : Microsoft.SqlServer.Management.Smo.Wmi.WmiSmoObject, Microsoft.SqlServer.Management.Common.IAlterable
Public NotInheritable Class Service
Inherits WmiSmoObject
Implements IAlterable
Inheritance
Implements
Microsoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterable

Examples

Managing Services and Network Settings by Using WMI Provider

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.

Properties

AcceptsPause AcceptsPause AcceptsPause

Gets the Boolean property value that specifies whether the SQL Server service can be paused.

AcceptsStop AcceptsStop AcceptsStop

Gets the Boolean property value that specifies whether the SQL Server service can be stopped.

AdvancedProperties AdvancedProperties AdvancedProperties

Represents a collection of Property objects. Each Property object represents an advanced property defined on the SQL Server service.

Dependencies Dependencies Dependencies

Returns a list of services that are dependent on the referenced SQL Server service.

Description Description Description

Gets a textual description of the SQL Server service.

DisplayName DisplayName DisplayName

Gets the display name of the SQL Server service.

ErrorControl ErrorControl ErrorControl

Gets the severity of the error if the SQL Server service fails to start during startup.

ExitCode ExitCode ExitCode

Gets the Win32 error code that defines problems encountered when starting and stopping the SQL Server service.

IsHadrEnabled IsHadrEnabled IsHadrEnabled

Gets whether the High Availability/Disaster Recovery is enabled.

Name Name Name

Gets or sets the name of the referenced Windows Management Instrumentation (WMI) object.

(Inherited from WmiSmoObject)
Parent Parent Parent

Gets the ManagedComputer object that is the parent of the Service object.

PathName PathName PathName

Gets the path and file name of the binary file that implements the SQL Server service.

ProcessId ProcessId ProcessId

Gets the process ID that uniquely identifies the SQL Server service.

Properties Properties 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 ServiceAccount ServiceAccount

Gets the system account under which the SQL Server service is running.

ServiceState ServiceState ServiceState

Gets the state of the SQL Server service, such as running, stopped, or paused.

StartMode StartMode StartMode

Gets or sets the method by which the SQL Server service is started.

StartupParameters StartupParameters StartupParameters

Gets or sets any startup parameters for the SQL Server service.

State State State

Gets the state of the referenced object.

(Inherited from SmoObjectBase)
Type Type Type

Gets the type of service, such as Microsoft Search service, SQL Server Agent service, or SQL Server service.

Urn Urn Urn

Gets the Uniform Resource Name (URN) address that represents the Windows Management Instrumentation (WMI) object.

(Inherited from WmiSmoObject)
UserData UserData UserData

Gets or sets user-defined data associated with the referenced object.

(Inherited from SmoObjectBase)

Methods

Alter() Alter() Alter()

Updates any Service object property changes on an instance of SQL Server.

AlterProtocolProperties(ProtocolPropertyCollection) AlterProtocolProperties(ProtocolPropertyCollection) AlterProtocolProperties(ProtocolPropertyCollection)

Updates any protocol object property changes on the Windows Management Instrumentation (WMI) installation.

(Inherited from WmiSmoObject)
ChangeHadrServiceSetting(Boolean) ChangeHadrServiceSetting(Boolean) ChangeHadrServiceSetting(Boolean)

Changes the HA/DR service settings.

ChangePassword(String, String) ChangePassword(String, String) ChangePassword(String, String)

Changes the password for the system account under which the SQL Server service is running.

CheckObjectState() CheckObjectState() CheckObjectState()

Checks the state of the referenced object.

(Inherited from WmiSmoObject)
CreateProtocolPropertyCollection() CreateProtocolPropertyCollection() CreateProtocolPropertyCollection()

Creates a set of protocol attributes for the referenced object.

(Inherited from WmiSmoObject)
GetPropertyManagementObject(ProtocolProperty) GetPropertyManagementObject(ProtocolProperty) GetPropertyManagementObject(ProtocolProperty)

Gets the management object for the specified protocol property.

(Inherited from WmiSmoObject)
GetPropertyObject(PropertyCollection, DataRow, Object) GetPropertyObject(PropertyCollection, DataRow, Object) GetPropertyObject(PropertyCollection, DataRow, Object)

Gets the property from the specified collection with the specified position and value.

(Inherited from WmiSmoObject)
GetProtocolPropertyCollection() GetProtocolPropertyCollection() GetProtocolPropertyCollection()

Returns the protocol property collection for the referenced object.

(Inherited from WmiSmoObject)
ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[])

Initializes the fields of the WmiSmoObject object.

(Inherited from WmiSmoObject)
Initialize() Initialize() Initialize()

Initializes the referenced object.

(Inherited from WmiSmoObject)
InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, Object[]) InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, Object[]) InvokeMgmtMethod(ManagementObject, ManagementOperationObserver, String, Object[])

Invokes the management method for the referenced object with the specified management object, observer, method name, and parameters.

(Inherited from WmiSmoObject)
InvokeMgmtMethod(ManagementObject, String, Object[]) InvokeMgmtMethod(ManagementObject, String, Object[]) InvokeMgmtMethod(ManagementObject, String, Object[])

Invokes the management method for the referenced object with the specified management object, method name, and parameters.

(Inherited from WmiSmoObject)
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized()

Specifies whether the referenced object is initialized.

(Inherited from WmiSmoObject)
Pause() Pause() Pause()

Pauses the SQL Server service.

Refresh() Refresh() Refresh()

Refreshes the SQL Server service.

Resume() Resume() Resume()

Resumes the SQL Server service.

SetName(String) SetName(String) SetName(String)

Sets the name of the referenced object.

(Inherited from WmiSmoObject)
SetParentImpl(WmiSmoObject) SetParentImpl(WmiSmoObject) SetParentImpl(WmiSmoObject)

Sets the parent of the referenced object.

(Inherited from WmiSmoObject)
SetServiceAccount(String, String) SetServiceAccount(String, String) SetServiceAccount(String, String)

Sets the account under which the SQL Server service runs.

Start() Start() Start()

Starts the SQL Server service.

Stop() Stop() Stop()

Stops the SQL Server service.

UpdateObjectState() UpdateObjectState() UpdateObjectState()

Updates the object state.

(Inherited from WmiSmoObject)
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Validates the state of an object.

(Inherited from SmoObjectBase)

Events

ManagementStateChange ManagementStateChange ManagementStateChange

An event that occurs when the management state changes.

Applies to