Database.Users Property
Gets a collection of User objects. Each User object represents a user who is 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(User), SfcObjectFlags.Design)> _
Public ReadOnly Property Users As UserCollection
Get
'Usage
Dim instance As Database
Dim value As UserCollection
value = instance.Users
[SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,
typeof(User), SfcObjectFlags.Design)]
public UserCollection Users { get; }
[SfcObjectAttribute(SfcContainerRelationship::ObjectContainer, SfcContainerCardinality::ZeroToAny,
typeof(User), SfcObjectFlags::Design)]
public:
property UserCollection^ Users {
UserCollection^ get ();
}
[<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,
typeof(User), SfcObjectFlags.Design)>]
member Users : UserCollection
function get Users () : UserCollection
Property Value
Type: Microsoft.SqlServer.Management.Smo.UserCollection
A UserCollection object that represents all the users defined on the database.
Remarks
Specific users can be referenced by using this collection by specifying the name of the user. To add a new user to the collection, call the user constructor.
Examples
VB
'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 users in the database.
Dim us As User
For Each us In db.Users
Console.WriteLine(us.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 ($us in $db.Users)
{
Write-Host $us.Name
}
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
Managing Users, Roles, and Logins