Share via


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
Public method ServerRole() Initializes a new instance of the ServerRole class.
Public method ServerRole(Server, String) Initializes a new instance of the ServerRole class.

Top

Properties

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

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)