Share via

  • Article

Database.Grant Method (DatabasePermissionSet, array<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 under an assumed role.

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

Syntax

'Declaration
Public Sub Grant ( _
    permission As DatabasePermissionSet, _
    granteeNames As String(), _
    grantGrant As Boolean, _
    asRole As String _
)
'Usage
Dim instance As Database
Dim permission As DatabasePermissionSet
Dim granteeNames As String()
Dim grantGrant As Boolean
Dim asRole As String

instance.Grant(permission, granteeNames, _
    grantGrant, asRole)

public void Grant(
    DatabasePermissionSet permission,
    string[] granteeNames,
    bool grantGrant,
    string asRole
)

public:
void Grant(
    DatabasePermissionSet^ permission, 
    array<String^>^ granteeNames, 
    bool grantGrant, 
    String^ asRole
)

member Grant : 
        permission:DatabasePermissionSet * 
        granteeNames:string[] * 
        grantGrant:bool * 
        asRole:string -> unit 

public function Grant(
    permission : DatabasePermissionSet, 
    granteeNames : String[], 
    grantGrant : boolean, 
    asRole : String
)

Parameters

  • granteeNames
    Type: array<System.String[]
    A String array that specifies a list of grantees to be granted the set of permissions.
  • grantGrant
    Type: System.Boolean
    A Boolean property that specifies whether the grantee is given the ability to grant the set of permissions to other users on the database.
    If True, the grantee is given the ability to grant the specified set of permissions to other users on the database.
    If False, the grantee is not given the ability to grant the specified set of permissions to other users on the database.
  • asRole
    Type: System.String
    A String value that specifies the role that the user assumes when that user grants the specified set of permissions to other users on the database. Use this parameter for grantees who are members of more than one role.

Examples

The example shows how to use the Grant method with server permissions. The method is the same for database permissions.

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)