Functions/Test-Privilege.ps1
|
# Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. function Test-Privilege { <# .SYNOPSIS Tests if an identity has a given privilege. .DESCRIPTION Returns `true` if an identity has a privilege. `False` otherwise. .LINK Carbon_Privilege .LINK Get-Privilege .LINK Grant-Privilege .LINK Revoke-Privilege .EXAMPLE Test-Privilege -Identity Forrester -Privilege SeServiceLogonRight Tests if `Forrester` has the `SeServiceLogonRight` privilege. #> [CmdletBinding()] param( [Parameter(Mandatory=$true)] [string] # The identity whose privileges to check. $Identity, [Parameter(Mandatory=$true)] [string] # The privilege to check. $Privilege ) Set-StrictMode -Version 'Latest' Use-CallerPreference -Cmdlet $PSCmdlet -Session $ExecutionContext.SessionState $matchingPrivilege = Get-Privilege -Identity $Identity | Where-Object { $_ -eq $Privilege } return ($matchingPrivilege -ne $null) } |