Get-PAMRequest

Retrieves PAM Requests from the MIM Service.

Syntax

Basic (Default)

Get-PAMRequest
    [-User] <PAMUser[]>
    [[-Filter] <String>]
    [-Active]
    [-Expired]
    [-Rejected]
    [-Pending]
    [-Closed]
    [-All]
    [-CreatedFrom <DateTime>]
    [<CommonParameters>]

Extended

Get-PAMRequest
    [-User] <PAMUser[]>
    [[-Filter] <String>]
    [-Extended]
    [-CreatedFrom <DateTime>]
    [<CommonParameters>]

Description

This cmdlet returns activation requests that have been requested by a particular user with the user object as a mandatory parameter which can be retrieved by Get-PAMUser.

Examples

EXAMPLE 1

Get-PAMRequest -User (Get-PAMUser -PrivDisplayName "contoso.jen")

This command retrieves requests from a user that are stored in the MIM Service.

EXAMPLE 2

Get-PAMRequest -User (Get-PAMUser -PrivDisplayName "contoso.jen") -Extended

This command retrieves requests with extended properties

Parameters

-Active

Filters the returned request objects to be only those activation requests which are currently active.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Basic
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-All

Return all requests.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Basic
Position:7
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Closed

Return requests that are closed.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Basic
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CreatedFrom

{{Fill CreatedFrom Description}}

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Expired

Return requests which have expired.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Basic
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Extended

Return requests with all the extended properties.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Extended
Position:9
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Filter

Specifies a clause to use in the filter when searching in the MIM Service.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:8
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Pending

Only return requests which are pending.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Basic
Position:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Rejected

Return requests which were pending approval and were rejected.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Basic
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-User

The user (or users) whose requests are to be returned, obtained from an earlier call to Get-PAMUser.

Parameter properties

Type:

PAMUser[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Microsoft.IdentityManagement.PamCmdlets.Model.PAMRequest

The output is all the requests from a specific user which match the parameter filters.