Revoke-SCResource

Revokes access to a resource from a user or user role.

Description

The Revoke-SCResource cmdlet revokes access to a resource from a user or user role.

For more information about Revoke-SCResource, type: "Get-Help Revoke-SCResource -online".

Parameters

Resource

Required? true
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a resource object.

JobGroup

Required? false
Accept Pipeline Input? false
Position? named
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs. 

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

UserName

Required? false
Accept Pipeline Input? false
Position? named
Specifies a the name of a user. Enter a user name with the format Domain\User.

UserRoleName

Required? false
Accept Pipeline Input? false
Position? named
Specifies the name of a user role. Types of user roles that are named include Delegated Administrator, Read-Only Administrator and Self-Service User.

VMMServer

Required? false
Accept Pipeline Input? false
Position? named
Specifies a VMM server object.

Examples

1: Revoke access to a resource from a specific user.
PS C:\> $Resource = Get-SCVMTemplate | where {$_.Name -eq "Template01"} 
PS C:\> Revoke-SCResource -Resource $Resource -Username “Contoso\Katarina” 


The first command gets the template object named Template01 and stores the object in the $Resource variable.

The second command revokes access to the resource stored in $Resource (Template01) from the user named Katarina. If the user is a member of multiple user roles, access will be revoked from the user in all it's user roles.
2: Revoke access to a resource from a user who is a member of multiple user roles.
PS C:\> $Resource = Get-SCVMTemplate | where {$_.Name -eq "Template01"}
PS C:\> Revoke-SCResource -Resource $Resource -Username “Contoso\Katarina” -UserRoleName @("ContosoSelfServiceUsers", "SelfServiceUserRole02")

The first command gets the template object named Template01 and stores the object in the $Resource variable.

The second command revokes access to the resource stored in $Resource (Template01) from the user named Katarina, but only if the user is using the ContosoSelfServiceUsers or SelfServiceUserRole02 user roles. If Katarina uses a different user role that has access to the resource then she will still be able to access the resource.
3: Revoke access to a resource from all members of a user role.
PS C:\> $Resource = Get-SCVMTemplate | where {$_.Name -eq "Template01"}
PS C:\> Revoke-SCResource -Resource $Resource -UserRoleName "ContosoSelfServiceUsers"
The first command gets the template object named Template01 and stores the object in the $Resource variable.

The second command revokes access to the resource stored in $Resource (Template01) from all members of the ContosoSelfServiceUsers user role.

See Also