Export (0) Print
Expand All

DatabaseRole Class

The DatabaseRole object represents a SQL Server database security role.

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

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

The DatabaseRole type exposes the following members.

  NameDescription
Public methodDatabaseRole()Initializes a new instance of the DatabaseRole class.
Public methodDatabaseRole(Database, String)Initializes a new instance of the DatabaseRole class.
Top

  NameDescription
Public propertyCreateDateGets the date and time when the database role was created.
Public propertyDateLastModifiedGets the date and time when the database role was last modified.
Public propertyExtendedPropertiesGets the extended properties of the database role.
Public propertyIDGets the ID value that uniquely identifies the database role.
Public propertyIsFixedRoleGets the Boolean property value that specifies whether the database role is a fixed role or a user-defined role.
Public propertyNameGets or sets a String value that specifies the name of the database role. (Overrides NamedSmoObject::Name.)
Public propertyOwnerGets or sets the owner of the database role.
Public propertyParentGets or sets the Database object that is the parent of the DatabaseRole object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAddMemberAdds an existing database user or database role to the database role.
Public methodAlterUpdates any DatabaseRole object property changes on the instance of Microsoft SQL Server.
Public methodCreateCreates a database role on the instance of Microsoft SQL Server as defined by the DatabaseRole object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the database role.
Public methodDeny(ObjectPermissionSet, array<String>)Denies the specified set of permissions for the specified grantees on the database role.
Public methodDeny(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 methodDeny(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 methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropDrops the database role.
Public methodDropMemberRemoves the specified database user or role from the referenced database role.
Public methodEnumAgentProxyAccountsReturns a list of agent proxy accounts that are assigned to the database role.
Public methodEnumMembersReturns a list of database users that are members of the database role.
Public methodEnumObjectPermissions()Returns a list of object permissions assigned to the referenced database role.
Public methodEnumObjectPermissions(String)Returns a list of object permissions assigned to the referenced database role for the specified member of the role.
Public methodEnumObjectPermissions(ObjectPermissionSet)Returns a list of object permissions assigned to the referenced database role for the specified set of object permissions.
Public methodEnumObjectPermissions(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 methodEnumRolesReturns a list of the roles that the referenced database role is a member of.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the database role.
Public methodGrant(ObjectPermissionSet, array<String>)Grants the specified set of permissions to the specified grantees on the database role.
Public methodGrant(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 methodGrant(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 methodGrant(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 methodGrant(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 methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodRenameRenames the database role.
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the database role.
Public methodRevoke(ObjectPermissionSet, array<String>)Revokes a previously granted set of permissions from a list of grantees on the database role.
Public methodRevoke(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 methodRevoke(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 methodRevoke(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 methodRevoke(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 methodScript()Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server database role.
Public methodScript(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 methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject::DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetParentGets 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 methodIAlienObject::GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetUrnGets 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 methodIAlienObject::ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider::GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode::IsDesignModeGets a Boolean value that specifies whether the database role supports design mode.
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft