WorkloadGroup Class

 

The WorkloadGroup class is represents a SQL Server workgroup, which contains a group of session requests. Workload groups allow aggregate monitoring of resource consumption and application of uniform policies to all requests in the group.

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


<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)>
<PhysicalFacetAttribute>
<StateChangeEventAttribute("CREATE_WORKLOAD_GROUP", "WORKLOADGROUP",
	"WORKLOAD GROUP")>
<StateChangeEventAttribute("ALTER_WORKLOAD_GROUP", "WORKLOADGROUP",
	"WORKLOAD GROUP")>
Public NotInheritable Class WorkloadGroup
	Inherits ScriptNameObjectBase
	Implements ISfcSupportsDesignMode, ICreatable, IDroppable, IDropIfExists,
	IAlterable, IScriptable

NameDescription
System_CAPS_pubmethodWorkloadGroup()

Initializes a new, default instance of the WorkloadGroup class.

System_CAPS_pubmethodWorkloadGroup(ResourcePool, String)

Initializes a new instance of the WorkloadGroup class that has the specified name and resource pool.

NameDescription
System_CAPS_pubpropertyExecutionManager

Gets the object to execute to the manager.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyGroupMaximumRequests

Gets or sets the maximum number of requests that can be stored in the workload group.

System_CAPS_pubpropertyID

Gets the ID of the workload group.

System_CAPS_pubpropertyImportance

Gets or sets a value that indicates the level of importance that the workload group has.

System_CAPS_pubpropertyIsSystemObject

Gets a Boolean value that indicates whether the workload group is a system object.

System_CAPS_pubpropertyMaximumDegreeOfParallelism

Gets or sets the maximum degree of parallelism for the workload group.

System_CAPS_pubpropertyName

Gets or sets a String which contains the name of the WorkloadGroup.(Overrides NamedSmoObject.Name.)

System_CAPS_pubpropertyParent

Gets or sets the ResourcePool object that is the parent of the WorkloadGroup.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyRequestMaximumCpuTimeInSeconds

Gets or sets the request maximum CPU time in seconds

System_CAPS_pubpropertyRequestMaximumMemoryGrantPercentage

Gets or sets the request maximum memory grant percentage in seconds.

System_CAPS_pubpropertyRequestMemoryGrantTimeoutInSeconds

Gets or sets the request memory grant time-out in seconds.

System_CAPS_pubpropertyState

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

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

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

NameDescription
System_CAPS_pubmethodAlter()

Updates any WorkloadGroup object property changes on the instance of SQL Server. 

System_CAPS_pubmethodCreate()

Creates a workload group on the instance of SQL Server as defined by the WorkloadGroup object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Drops the workload group.

System_CAPS_pubmethodDropIfExists()

Drops the workload group if exist.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

Determines whether the specified property is supported in the target .NET Framework.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodMoveToPool(String)

Moves the workload group to the specified resource pool.

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the workload group.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the workload group as specified by the script options.

System_CAPS_pubmethodScriptMoveToPool(String)

Generates a script to move the workload group to the specified resource pool.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object())

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

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetUrn()

Gets the Unified Resource Name (URN) of the object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode.IsDesignMode

Gets a value that indicates whether the work load group object supports design mode.

For more information on workload groups, see Resource Governor Concepts.

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: