Database.Roles Property
Gets a collection of DatabaseRole objects. Each DatabaseRole object represents a role defined on the database.
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, _
GetType(DatabaseRole), SfcObjectFlags.Design)> _
Public ReadOnly Property Roles As DatabaseRoleCollection
Get
'Usage
Dim instance As Database
Dim value As DatabaseRoleCollection
value = instance.Roles
[SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,
typeof(DatabaseRole), SfcObjectFlags.Design)]
public DatabaseRoleCollection Roles { get; }
[SfcObjectAttribute(SfcContainerRelationship::ObjectContainer, SfcContainerCardinality::ZeroToAny,
typeof(DatabaseRole), SfcObjectFlags::Design)]
public:
property DatabaseRoleCollection^ Roles {
DatabaseRoleCollection^ get ();
}
[<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,
typeof(DatabaseRole), SfcObjectFlags.Design)>]
member Roles : DatabaseRoleCollection
function get Roles () : DatabaseRoleCollection
Property Value
Type: Microsoft.SqlServer.Management.Smo.DatabaseRoleCollection
A DatabaseRoleCollection object that represents all the roles defined on the database.
Remarks
Specific database roles can be referenced by using this collection by specifying the name of the database role. To add a new database role to the collection, call the database role constructor DatabaseRole.
Examples
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
'Display all the database roles in the database.
Dim ro As DatabaseRole
For Each ro In db.Roles
Console.WriteLine(ro.Name)
Next
PowerShell
$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")
Foreach ($ro in $db.Roles)
{
Write-Host $ro.Name
}
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
Managing Users, Roles, and Logins