Get-DbaDbUser

Want to see the source code for this command? Check out Get-DbaDbUser on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbUser.

Synopsis

Gets database users

Description

Gets database users

Syntax

Get-DbaDbUser
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [-ExcludeSystemUser]
    [[-User] <String[]>]
    [[-Login] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbUser -SqlInstance sql2016

Gets all database users

Example: 2

PS C:\> Get-DbaDbUser -SqlInstance Server1 -Database db1

Gets the users for the db1 database

Example: 3

PS C:\> Get-DbaDbUser -SqlInstance Server1 -ExcludeDatabase db1

Gets the users for all databases except db1

Example: 4

PS C:\> Get-DbaDbUser -SqlInstance Server1 -ExcludeSystemUser

Gets the users for all databases that are not system objects, like 'dbo', 'guest' or 'INFORMATION_SCHEMA'

Example: 5

PS C:\> 'Sql1','Sql2/sqlexpress' | Get-DbaDbUser

Gets the users for the databases on Sql1 and Sql2/sqlexpress

Example: 6

PS C:\> Get-DbaDbUser -SqlInstance Server1 -Database db1 -User user1, user2

Gets the users 'user1' and 'user2' from the db1 database

Example: 7

PS C:\> Get-DbaDbUser -SqlInstance Server1 -Login login1, login2

Gets the users associated with the logins 'login1' and 'login2'

Required Parameters

-SqlInstance

The target SQL Server instance or instances

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Database

To get users from specific database(s)

-ExcludeDatabase

The database(s) to exclude - this list is auto populated from the server

-ExcludeSystemUser

This switch removes all system objects from the user collection

-User

Specifies the name(s) of the user(s) to return.

-Login

Specifies the name(s) of the login(s) to filter the user(s) returned.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.