Server.Revoke Method (ServerPermissionSet, String, Boolean, Boolean, String)

Revokes previously granted permissions from a grantee on the instance of Microsoft SQL Server and any other users to whom the grantee has granted the specified set of permissions. The grantee is 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 ServerPermissionSet, _
    granteeName As String, _
    revokeGrant As Boolean, _
    cascade As Boolean, _
    asRole As String _
)

public void Revoke (
    ServerPermissionSet permission,
    string granteeName,
    bool revokeGrant,
    bool cascade,
    string asRole
)

public:
void Revoke (
    ServerPermissionSet^ permission, 
    String^ granteeName, 
    bool revokeGrant, 
    bool cascade, 
    String^ asRole
)

public void Revoke (
    ServerPermissionSet permission, 
    String granteeName, 
    boolean revokeGrant, 
    boolean cascade, 
    String asRole
)

public function Revoke (
    permission : ServerPermissionSet, 
    granteeName : String, 
    revokeGrant : boolean, 
    cascade : boolean, 
    asRole : String
)

Parameters

• permission
  A ServerPermissionSet object that specifies the permission.

• granteeName
  A String value that specifies a grantee to be revoked access to the set of permissions.

• revokeGrant
  A Boolean property that specifies whether the grantee is given the ability to revoke the specified set of permissions from other users on the instance of Microsoft SQL Server.

  If True, the grantee is given the ability to revoke the specified set of permissions to other users on the instance of Microsoft SQL Server.

  If False, the grantee is not given the ability to revoke the specified set of permissions to other users on the instance of Microsoft SQL Server.

• cascade
  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 instance of Microsoft SQL Server.

  If False, only the grantee is revoked the specified set of permissions.

• asRole
  A String value that specifies the role that the user assumes when revoking the specified set of permission from other users on the instance of Microsoft SQL Server. Use this parameter for grantees who are members of more than one role.

Remarks

Updated text:

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

'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("")

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Server Class
Server Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

How to: Grant Server Permissions in Visual Basic .NET
Granting, Revoking, and Denying Permissions
Managing Servers

Change History