PSPrincipal Class

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines the basic functionality of a PSPrincipal object.

C++

public ref class PSPrincipal sealed : System::Security::Principal::IPrincipal

public sealed class PSPrincipal : System.Security.Principal.IPrincipal

type PSPrincipal = class
    interface IPrincipal

Public NotInheritable Class PSPrincipal
Implements IPrincipal

Inheritance: Object
PSPrincipal

Implements: IPrincipal

Constructors

PSPrincipal(PSIdentity, WindowsIdentity)

Constructs PSPrincipal using PSIdentity and a WindowsIdentity.

Properties

Identity	Gets the identity of the current user principal.
WindowsIdentity	Gets the WindowsIdentity (if possible) representation of the current Identity. PSPrincipal can represent any user for example a LiveID user, network user within a domain etc. This property tries to convert the Identity to WindowsIdentity using the user token supplied.

Methods

IsInRole(String)

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.

Explicit Interface Implementations

IPrincipal.Identity

Gets the identity of the current principal.

Applies to

Product	Versies
PowerShell SDK	7.2.0, 7.3.0, 7.4.0
Windows PowerShell	5.1.0.0

Delen via