PSPrincipal.IsInRole(String) Method

  • Reference

Definition

Namespace:
System.Management.Automation.Remoting
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Determines if the current principal belongs to a specified rule. If we were able to get a WindowsIdentity then this will perform the check using the WindowsIdentity otherwise this will return false.

public:
 virtual bool IsInRole(System::String ^ role);
public:
 bool IsInRole(Platform::String ^ role);
bool IsInRole(std::wstring const & role);
public bool IsInRole (string role);
abstract member IsInRole : string -> bool
override this.IsInRole : string -> bool
Public Function IsInRole (role As String) As Boolean

Parameters

role
String

Returns

Boolean

If we were able to get a WindowsIdentity then this will perform the check using the WindowsIdentity otherwise this will return false.

Implements

IsInRole(String)

Applies to