Any suggestions? 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)


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

NameDescription
System_CAPS_pubmethodDatabaseRole()

Initializes a new instance of the DatabaseRole class.

System_CAPS_pubmethodDatabaseRole(Database, String)

Initializes a new instance of the DatabaseRole class.

NameDescription
System_CAPS_pubpropertyCreateDate

Gets the date and time when the database role was created.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the database role was last modified.

System_CAPS_pubpropertyExtendedProperties

Gets the extended properties of the database role.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the database role.

System_CAPS_pubpropertyIsFixedRole

Gets the Boolean property value that specifies whether the database role is a fixed role or a user-defined role.

System_CAPS_pubpropertyName

Gets or sets a String value that specifies the name of the database role.(Overrides NamedSmoObject.Name.)

System_CAPS_pubpropertyOwner

Gets or sets the owner of the database role.

System_CAPS_pubpropertyParent

Gets or sets the Database object that is the parent of the DatabaseRole object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAddMember(String)

Adds an existing database user or database role to the database role.

System_CAPS_pubmethodAlter()

Updates any DatabaseRole object property changes on the instance of Microsoft SQL Server.

System_CAPS_pubmethodCreate()

Creates a database role on the instance of Microsoft SQL Server as defined by the DatabaseRole object.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String)

Denies the specified set of permissions for the specified grantee on the database role.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet, String[])

Denies the specified set of permissions for the specified grantees on the database role.

System_CAPS_pubmethodDeny(ObjectPermissionSet, 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.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Drops the database role.

System_CAPS_pubmethodDropMember(String)

Removes the specified database user or role from the referenced database role.

System_CAPS_pubmethodEnumAgentProxyAccounts()

Returns a list of agent proxy accounts that are assigned to the database role.

System_CAPS_pubmethodEnumMembers()

Returns a list of database users that are members of the database role.

System_CAPS_pubmethodEnumObjectPermissions()

Returns a list of object permissions assigned to the referenced database role.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet)

Returns a list of object permissions assigned to the referenced database role for the specified set of object permissions.

System_CAPS_pubmethodEnumObjectPermissions(String)

Returns a list of object permissions assigned to the referenced database role for the specified member of the role.

System_CAPS_pubmethodEnumObjectPermissions(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.

System_CAPS_pubmethodEnumRoles()

Returns a list of the roles that the referenced database role is a member of.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet, String)

Grants the specified set of permissions to the specified grantee on the database role.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[])

Grants the specified set of permissions to the specified grantees on the database role.

System_CAPS_pubmethodGrant(ObjectPermissionSet, String[], Boolean)

Grants access to the specified permission to the grantees and the ability to grant access to other users on the database role.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodRename(String)

Renames the database role.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String)

Revokes a previously granted set of permissions from a grantee on the database role.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, String[])

Revokes a previously granted set of permissions from a list of grantees on the database role.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, 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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet, 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.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server database role.

System_CAPS_pubmethodScript(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.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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.

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.

Return to top
Show:
© 2016 Microsoft