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.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.WorkloadGroup

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

Syntax

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

[StateChangeEventAttribute("CREATE_WORKLOAD_GROUP", "WORKLOADGROUP", "WORKLOAD GROUP")]
[StateChangeEventAttribute("ALTER_WORKLOAD_GROUP", "WORKLOADGROUP", "WORKLOAD GROUP")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class WorkloadGroup : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable, IScriptable

[StateChangeEventAttribute(L"CREATE_WORKLOAD_GROUP", L"WORKLOADGROUP", L"WORKLOAD GROUP")]
[StateChangeEventAttribute(L"ALTER_WORKLOAD_GROUP", L"WORKLOADGROUP", L"WORKLOAD GROUP")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class WorkloadGroup sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable, IScriptable

[<SealedAttribute>]
[<StateChangeEventAttribute("CREATE_WORKLOAD_GROUP", "WORKLOADGROUP", "WORKLOAD GROUP")>]
[<StateChangeEventAttribute("ALTER_WORKLOAD_GROUP", "WORKLOADGROUP", "WORKLOAD GROUP")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type WorkloadGroup =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface ICreatable 
        interface IDroppable 
        interface IAlterable 
        interface IScriptable 
    end

public final class WorkloadGroup extends ScriptNameObjectBase implements ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable, IScriptable

The WorkloadGroup type exposes the following members.

Constructors

	Name	Description
	WorkloadGroup()	Initializes a new, default instance of the WorkloadGroup class.
	WorkloadGroup(ResourcePool, String)	Initializes a new instance of the WorkloadGroup class that has the specified name and resource pool.

Top

Properties

	Name	Description
	GroupMaximumRequests	Gets or sets the maximum number of requests that can be stored in the workload group.
	ID	Gets the ID of the workload group.
	Importance	Gets or sets a value that indicates the level of importance that the workload group has.
	IsSystemObject	Gets a Boolean value that indicates whether the workload group is a system object.
	MaximumDegreeOfParallelism	Gets or sets the maximum degree of parallelism for the workload group.
	Name	Gets or sets a String which contains the name of the WorkloadGroup. (Overrides NamedSmoObject.Name.)
	Parent	Gets or sets the ResourcePool object that is the parent of the WorkloadGroup.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	RequestMaximumCpuTimeInSeconds	Gets or sets the request maximum CPU time in seconds
	RequestMaximumMemoryGrantPercentage	Gets or sets the request maximum memory grant percentage in seconds.
	RequestMemoryGrantTimeoutInSeconds	Gets or sets the request memory grant time-out in seconds.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Updates any WorkloadGroup object property changes on the instance of SQL Server.
	Create	Creates a workload group on the instance of SQL Server as defined by the WorkloadGroup object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops the workload group.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	MoveToPool	Moves the workload group to the specified resource pool.
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Script()	Generates a Transact-SQL script that can be used to re-create the workload group.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the workload group as specified by the script options.
	ScriptMoveToPool	Generates a script to move the workload group to the specified resource pool.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.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.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.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.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that specifies whether the WorkloadGroup object supports design mode.

Top

Remarks

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

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 Namespace

Other Resources

Resource Governor Concepts