DatabaseRole Class

  • Article

The DatabaseRole object represents a SQL Server database 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.DatabaseRole

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

Syntax

'Declaration
<StateChangeEventAttribute("CREATE_ROLE", "ROLE")> _
<StateChangeEventAttribute("ALTER_ROLE", "ROLE")> _
<PhysicalFacetAttribute> _
<SfcElementTypeAttribute("Role")> _
<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "ROLE")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class DatabaseRole _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable,  _
    IAlterable, IRenamable, IExtendedProperties, IScriptable
'Usage
Dim instance As DatabaseRole

[StateChangeEventAttribute("CREATE_ROLE", "ROLE")]
[StateChangeEventAttribute("ALTER_ROLE", "ROLE")]
[PhysicalFacetAttribute]
[SfcElementTypeAttribute("Role")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "ROLE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class DatabaseRole : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IAlterable, 
    IRenamable, IExtendedProperties, IScriptable

[StateChangeEventAttribute(L"CREATE_ROLE", L"ROLE")]
[StateChangeEventAttribute(L"ALTER_ROLE", L"ROLE")]
[PhysicalFacetAttribute]
[SfcElementTypeAttribute(L"Role")]
[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_DATABASE", L"ROLE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class DatabaseRole sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IAlterable, 
    IRenamable, IExtendedProperties, IScriptable

[<SealedAttribute>]
[<StateChangeEventAttribute("CREATE_ROLE", "ROLE")>]
[<StateChangeEventAttribute("ALTER_ROLE", "ROLE")>]
[<PhysicalFacetAttribute>]
[<SfcElementTypeAttribute("Role")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "ROLE")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type DatabaseRole =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
        interface ICreatable 
        interface IDroppable 
        interface IAlterable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
    end

public final class DatabaseRole extends ScriptNameObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IAlterable, IRenamable, IExtendedProperties, IScriptable

The DatabaseRole type exposes the following members.

Constructors

  Name Description
Public method DatabaseRole() Initializes a new instance of the DatabaseRole class.
Public method DatabaseRole(Database, String) Initializes a new instance of the DatabaseRole class.

Top

Properties

  Name Description
Public property CreateDate Gets the date and time when the database role was created.
Public property DateLastModified Gets the date and time when the database role was last modified.
Public property ExtendedProperties Gets the extended properties of the database role.
Public property ID Gets the ID value that uniquely identifies the database role.
Public property IsFixedRole Gets the Boolean property value that specifies whether the database role is a fixed role or a user-defined role.
Public property Name Gets or sets a String value that specifies the name of the database role. (Overrides NamedSmoObject.Name.)
Public property Owner Gets or sets the owner of the database role.
Public property Parent Gets or sets the Database object that is the parent of the DatabaseRole 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 an existing database user or database role to the database role.
Public method Alter Updates any DatabaseRole object property changes on the instance of Microsoft SQL Server.
Public method Create Creates a database role on the instance of Microsoft SQL Server as defined by the DatabaseRole object.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the database role.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the database 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 database role.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the database role.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops the database role.
Public method DropMember Removes the specified database user or role from the referenced database role.
Public method EnumAgentProxyAccounts Returns a list of agent proxy accounts that are assigned to the database role.
Public method EnumMembers Returns a list of database users that are members of the database role.
Public method EnumObjectPermissions() Returns a list of object permissions assigned to the referenced database role.
Public method EnumObjectPermissions(String) Returns a list of object permissions assigned to the referenced database role for the specified member of the role.
Public method EnumObjectPermissions(ObjectPermissionSet) Returns a list of object permissions assigned to the referenced database role for the specified set of object permissions.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Returns a list of object permissions assigned to the referenced database role for the specified member of the role and for the specified set of permissions.
Public method EnumRoles Returns a list of the roles that the referenced database role is a member of.
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 database role.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the database role.
Public method Grant(ObjectPermissionSet, String, Boolean) Grants access to the specified permission to the grantee and the ability to grant access to other users on the database 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 database role.
Public method Grant(ObjectPermissionSet, 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 database 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 database 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 database role.
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the database role.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the database role.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes previously granted permissions from a grantee on the database 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) Revokes previously granted permissions from grantees on the database 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 under an assumed role.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes previously granted permissions from a grantee on the database 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 previously granted permissions from grantees on the database 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 under an assumed role.
Public method Script() Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server database role.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server database role as specified by the scripting options.
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 database role supports design mode.

Top

Remarks

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

To set DatabaseRole object properties, users must have ALTER permission on the database role.

To create a database role, users must have CREATE ROLE permission on the parent database.

To drop a database role, users must have ALTER ANY ROLE permission on the parent database.

To add or remove members from the database role, users must be members of the db_owner or db_security admin fixed database role.

To grant, deny, or revoke permission on the database for other users, users must have CONTROL permission on the database 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

Managing Users, Roles, and Logins

Database-Level Roles

CREATE ROLE (Transact-SQL)