ServerRole Class

The ServerRole object represents a Microsoft SQL Server security role.

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.ServerRole

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

Syntax

'Declaration
<PhysicalFacetAttribute> _
<StateChangeEventAttribute("CREATE_SERVER_ROLE", "SERVER ROLE")> _
<StateChangeEventAttribute("ALTER_AUTHORIZATION_SERVER", "SERVER ROLE")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<StateChangeEventAttribute("ALTER_SERVER_ROLE", "SERVER ROLE")> _
<SfcElementTypeAttribute("Role")> _
Public NotInheritable Class ServerRole _
    Inherits ScriptNameObjectBase _
    Implements IObjectPermission, ICreatable, IDroppable, IAlterable,  _
    IRenamable, IScriptable
'Usage
Dim instance As ServerRole

[PhysicalFacetAttribute]
[StateChangeEventAttribute("CREATE_SERVER_ROLE", "SERVER ROLE")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_SERVER", "SERVER ROLE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[StateChangeEventAttribute("ALTER_SERVER_ROLE", "SERVER ROLE")]
[SfcElementTypeAttribute("Role")]
public sealed class ServerRole : ScriptNameObjectBase, 
    IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, 
    IScriptable

[PhysicalFacetAttribute]
[StateChangeEventAttribute(L"CREATE_SERVER_ROLE", L"SERVER ROLE")]
[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_SERVER", L"SERVER ROLE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[StateChangeEventAttribute(L"ALTER_SERVER_ROLE", L"SERVER ROLE")]
[SfcElementTypeAttribute(L"Role")]
public ref class ServerRole sealed : public ScriptNameObjectBase, 
    IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, 
    IScriptable

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<StateChangeEventAttribute("CREATE_SERVER_ROLE", "SERVER ROLE")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_SERVER", "SERVER ROLE")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<StateChangeEventAttribute("ALTER_SERVER_ROLE", "SERVER ROLE")>]
[<SfcElementTypeAttribute("Role")>]
type ServerRole =  
    class 
        inherit ScriptNameObjectBase 
        interface IObjectPermission 
        interface ICreatable 
        interface IDroppable 
        interface IAlterable 
        interface IRenamable 
        interface IScriptable 
    end

public final class ServerRole extends ScriptNameObjectBase implements IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, IScriptable

The ServerRole type exposes the following members.

Constructors

	Name	Description
	ServerRole()	Initializes a new instance of the ServerRole class.
	ServerRole(Server, String)	Initializes a new instance of the ServerRole class.

Top

Properties

	Name	Description
	DateCreated	Gets a DateTime representing the date and time when the Server Role was created.
	DateModified	Gets a DateTime representing the date and time when the Server Role was modified.
	Events	Gets the ServerRoleEvents object associated with this Server Role.
	ID	Gets the ID value that uniquely identifies the server role.
	IsFixedRole	Gets a Boolean which indicates whether the server role is fixed.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Owner	Gets the name of the owner of the ServerRole object.
	Parent	Gets the Server object that is the parent of the ServerRole object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	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
	AddMember	Adds a login to the fixed server role membership.
	AddMembershipToRole	Adds a role to the server role membership.
	Alter	Updates any ServerRole object property changes on the instance of Microsoft SQL Server.
	Create	Creates a Server Role on the instance of SQL Server as defined by the ServerRole object.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee(s) on the Server Role.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the Server Role.
	Deny(ObjectPermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the Server Role.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users that the grantees granted the specified set of permissions on the Server Role.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the Server Role from the instance of SQL Server.
	DropMember	Removes a login from the fixed server role membership.
	DropMembershipFromRole	Removes a role from the fixed server role membership.
	EnumAgentProxyAccounts	Enumerates a list of the SQL Server Agent proxy account to which the server role belongs.
	EnumContainingRoleNames	Gets a StringCollection which contains the names of all the ServerRole to which this ServerRole belongs.
	EnumMemberNames	Gets a StringCollection which contains the names of all the logins which belong to this role.
	EnumObjectPermissions()	Enumerates a list of object permissions for the Server Role.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the Server Role.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the Server Role.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the Server Role.
	EnumServerRoleMembers	Obsolete. Enumerates a list of members of the fixed server role. This method is deprecated. Use EnumMemberNames() instead.
	EnumServerRolePermissions	Obsolete. Returns a list of server permissions assigned to the referenced server role.
	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.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the Server Role.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the Server Role.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission and the ability to grant access to other uses for the specified grantee on the Server Role.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission to the grantees and the ability to grant access to other users on the Server Role.
	Grant(ObjectPermissionSet, String, Boolean, String)	Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the Server Role under an assumed role.
	Grant(ObjectPermissionSet, array<String[], Boolean, String)	Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the Server Role under an assumed role.
	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.)
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Rename	Renames the Server Role.
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the Server Role.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a set of grantees on the Server Role.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes a previously granted set of permissions from a grantee from the Server Role, and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes a previously granted set of permissions from a set of grantees from the Server Role, and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes a previously granted set of permissions from a grantee from the Server Role and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes the specified set of permissions to the grantees and the ability to revoke the set of permissions to other users on the Server Role under an assumed role.
	Script()	Generates a Transact-SQL script that can be used to re-create the Server Role.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the Server Role.
	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.)

Top

Remarks

To get ServerRole object properties, users can be a member of the public fixed server role.

To add or remove members from a fixed server role, users must have ALTER ANY LOGIN permission on the server or be a member of the sysadmin fixed server role.

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.

Examples

Managing Users, Roles, and Logins

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

Permissions of Fixed Server Roles (Database Engine)

sp_addsrvrolemember (Transact-SQL)