Share via


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
Public method WorkloadGroup() Initializes a new, default instance of the WorkloadGroup class.
Public method WorkloadGroup(ResourcePool, String) Initializes a new instance of the WorkloadGroup class that has the specified name and resource pool.

Top

Properties

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

Top

Methods

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

Top

Events

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

Top

Explicit Interface Implementations

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