• Article

Database.Revoke Method (DatabasePermissionSet, array<String[], Boolean, Boolean, String)

Revokes previously granted permissions from grantees on the database and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.

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

Syntax

'Declaration
Public Sub Revoke ( _
    permission As DatabasePermissionSet, _
    granteeNames As String(), _
    revokeGrant As Boolean, _
    cascade As Boolean, _
    asRole As String _
)
'Usage
Dim instance As Database
Dim permission As DatabasePermissionSet
Dim granteeNames As String()
Dim revokeGrant As Boolean
Dim cascade As Boolean
Dim asRole As String

instance.Revoke(permission, granteeNames, _
    revokeGrant, cascade, asRole)

public void Revoke(
    DatabasePermissionSet permission,
    string[] granteeNames,
    bool revokeGrant,
    bool cascade,
    string asRole
)

public:
void Revoke(
    DatabasePermissionSet^ permission, 
    array<String^>^ granteeNames, 
    bool revokeGrant, 
    bool cascade, 
    String^ asRole
)

member Revoke : 
        permission:DatabasePermissionSet * 
        granteeNames:string[] * 
        revokeGrant:bool * 
        cascade:bool * 
        asRole:string -> unit 

public function Revoke(
    permission : DatabasePermissionSet, 
    granteeNames : String[], 
    revokeGrant : boolean, 
    cascade : boolean, 
    asRole : String
)

Parameters

  • granteeNames
    Type: array<System.String[]
    A String array that specifies a list of grantees to be revoked access to the set of permissions.
  • revokeGrant
    Type: System.Boolean
    A Boolean property that specifies whether the grantee is given the ability to revoke the specified set of permissions from other users on the database.
    If True, the grantee is given the ability to revoke the specified set of permissions to other users on the database.
    If False, the grantee is not given the ability to revoke the specified set of permissions to other users on the database.
  • cascade
    Type: System.Boolean
    A Boolean property that specifies whether users to whom the grantee has granted the specified set of permissions are also revoked the set of permissions.
    If True, the grantee and users to whom the grantee granted the specified set of permission are all revoked the specified set of permissions on the database.
    If False, only the grantee is revoked the specified set of permissions.
  • asRole
    Type: System.String
    A String value that specifies the role that the user assumes when that user revokes the specified set of permission from 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 Revoke 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)