Get-PAMRole
Gets PAM roles from the MIM Service.
Syntax
Default (Default)
Get-PAMRole
[[-DisplayName] <String>]
[[-Session] <PAMSession>]
[-Active]
[[-Filter] <String>]
[<CommonParameters>]
Description
The Get-PAMRole cmdlet returns zero or more PAM roles from the MIM Service.
Examples
EXAMPLE 1
$r = Get-PAMRole -DisplayName "IT"
This command retrieves a single PAM role with a specified display name from the MIM Service.
Parameters
-Active
Indicates that this cmdlet gets roles with activation requests that are currently active.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 3 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-DisplayName
Matching value for DisplayName attribute of a PAM role resource in MIM Service.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 1 |
Mandatory: | False |
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: | 4 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Session
Session with the PAM domain and MIM Service.
Parameter properties
Type: | PAMSession |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 2 |
Mandatory: | False |
Value from pipeline: | False |
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.PAMRole
Zero or more PAM roles from the MIM Service.