Database.EnumDatabasePermissions Method (String, DatabasePermissionSet)

Enumerates a list of permissions in the database for the specified user and a specified permission set.

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

Syntax

'Declaration
Public Function EnumDatabasePermissions ( _
    granteeName As String, _
    permissions As DatabasePermissionSet _
) As DatabasePermissionInfo()
'Usage
Dim instance As Database 
Dim granteeName As String 
Dim permissions As DatabasePermissionSet 
Dim returnValue As DatabasePermissionInfo()

returnValue = instance.EnumDatabasePermissions(granteeName, _
    permissions)

public DatabasePermissionInfo[] EnumDatabasePermissions(
    string granteeName,
    DatabasePermissionSet permissions
)

public:
array<DatabasePermissionInfo^>^ EnumDatabasePermissions(
    String^ granteeName, 
    DatabasePermissionSet^ permissions
)

member EnumDatabasePermissions : 
        granteeName:string * 
        permissions:DatabasePermissionSet -> DatabasePermissionInfo[] 

public function EnumDatabasePermissions(
    granteeName : String, 
    permissions : DatabasePermissionSet
) : DatabasePermissionInfo[]

Parameters

• granteeName
  Type: System.String
  A String value that specifies the user.

• permissions
  Type: Microsoft.SqlServer.Management.Smo.DatabasePermissionSet
  A DatabasePermissionSet object that limits the enumerated list to those listed.

Return Value

Type: array<Microsoft.SqlServer.Management.Smo.DatabasePermissionInfo[]
An array of DatabasePermissionInfo object values that contains an enumerated list of permissions.

Examples

The example shows the EnumServerPermissions method. This is used like the EnumDatabasePermissions method.

VB

'Connect to the local, default instance of SQL Server.
Dim svr As Server
svr = New Server()
'Define a ServerPermissionSet that contains permission to Create Endpoint and Alter Any Endpoint.
Dim sps As ServerPermissionSet
sps = New ServerPermissionSet(ServerPermission.CreateEndpoint)
sps.Add(ServerPermission.AlterAnyEndpoint)
'This sample assumes that the grantee already has permission to Create Endpoints. 
'Enumerate and display the server permissions in the set for the grantee specified in the vGrantee string variable.
Dim spis As ServerPermissionInfo()
spis = svr.EnumServerPermissions(vGrantee, sps)
Dim spi As ServerPermissionInfo
Console.WriteLine("=================Before revoke===========================")
For Each spi In spis
    Console.WriteLine(spi.Grantee & " has " & spi.PermissionType.ToString & " permission.")
Next
Console.WriteLine(" ")
'Remove a permission from the set.
sps.Remove(ServerPermission.CreateEndpoint)
'Revoke the create endpoint permission from the grantee.
svr.Revoke(sps, vGrantee)
'Enumerate and display the server permissions in the set for the grantee specified in the vGrantee string variable.
spis = svr.EnumServerPermissions(vGrantee, sps)
Console.WriteLine("=================After revoke============================")
For Each spi In spis
    Console.WriteLine(spi.Grantee & " has " & spi.PermissionType.ToString & " permission.")
Next
Console.WriteLine(" ")
'Grant the Create Endpoint permission to the grantee.
svr.Grant(sps, vGrantee)
'Enumerate and display the server permissions in the set for the grantee specified in the vGrantee string variable.
spis = svr.EnumServerPermissions(vGrantee, sps)
Console.WriteLine("=================After grant=============================")
For Each spi In spis
    Console.WriteLine(spi.Grantee & " has " & spi.PermissionType.ToString & " permission.")
Next
Console.WriteLine("")

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$arg = [Microsoft.SqlServer.Management.Smo.ServerPermission]::CreateEndpoint

$sps = new-object Microsoft.SqlServer.Management.Smo.ServerPermissionSet([Microsoft.SqlServer.Management.Smo.ServerPermission]::CreateEndpoint)
$sps.Add([Microsoft.SqlServer.Management.Smo.ServerPermission]::AlterAnyEndpoint)
$spis = $srv.EnumServerPermissions("vGrantee", $sps)
Write-Host "=================Before revoke==========================="
Foreach ($spi In $spis)
{
   Write-Host $spi.Grantee "has" $spi.PermissionType " permission."
}
Write-Host " "
$sps.Remove([Microsoft.SqlServer.Management.Smo.ServerPermission]::CreateEndpoint)

See Also

Reference

Database Class

EnumDatabasePermissions Overload

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Working with Database Objects

Creating, Altering, and Removing Foreign Keys

Creating, Altering, and Removing Databases

CREATE DATABASE (Transact-SQL)