Service Class

 

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

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


public sealed class Service : WmiSmoObject, IAlterable

NameDescription
System_CAPS_pubpropertyAcceptsPause

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

System_CAPS_pubpropertyAcceptsStop

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

System_CAPS_pubpropertyAdvancedProperties

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

System_CAPS_pubpropertyDependencies

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

System_CAPS_pubpropertyDescription

Gets a textual description of the SQL Server service.

System_CAPS_pubpropertyDisplayName

Gets the display name of the SQL Server service.

System_CAPS_pubpropertyErrorControl

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

System_CAPS_pubpropertyExitCode

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

System_CAPS_pubpropertyIsHadrEnabled

Gets whether the High Availability/Disaster Recovery is enabled.

System_CAPS_pubpropertyName

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

System_CAPS_pubpropertyParent

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

System_CAPS_pubpropertyPathName

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

System_CAPS_pubpropertyProcessId

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

System_CAPS_pubpropertyProperties

Represents a collection of Property objects. Each Property object represents a property defined on the Windows Management Instrumentation (WMI) object.(Inherited from WmiSmoObject.)

System_CAPS_pubpropertyServiceAccount

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

System_CAPS_pubpropertyServiceState

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

System_CAPS_pubpropertyStartMode

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

System_CAPS_pubpropertyStartupParameters

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

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyType

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

System_CAPS_pubpropertyUrn

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

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

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

System_CAPS_pubmethodChangeHadrServiceSetting(Boolean)

Changes the HA/DR service settings.

System_CAPS_pubmethodChangePassword(String, String)

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

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the referenced object.(Inherited from WmiSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Specifies whether the referenced object is initialized.(Inherited from WmiSmoObject.)

System_CAPS_pubmethodPause()

Pauses the SQL Server service.

System_CAPS_pubmethodRefresh()

Refreshes the SQL Server service.(Overrides WmiSmoObject.Refresh().)

System_CAPS_pubmethodResume()

Resumes the SQL Server service.

System_CAPS_protmethodSetName(String)

Sets the name of the referenced object.(Inherited from WmiSmoObject.)

System_CAPS_protmethodSetParentImpl(WmiSmoObject)

Sets the parent of the referenced object.(Inherited from WmiSmoObject.)

System_CAPS_pubmethodSetServiceAccount(String, String)

Sets the account under which the SQL Server service runs.

System_CAPS_pubmethodStart()

Starts the SQL Server service.

System_CAPS_pubmethodStop()

Stops the SQL Server service.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventManagementStateChange

An event that occurs when the management state changes.

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.

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.

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

Return to top
Show: