Share via


Get-PAMGroup

Gets groups from the MIM Service that are intended for PAM activation.

Syntax

Default (Default)

Get-PAMGroup
    [[-SourceAccountName] <String>]
    [[-PrivAccountName] <String>]
    [[-PrivDisplayName] <String>]
    [[-Filter] <String>]
    [[-Session] <PAMSession>]
    [<CommonParameters>]

Description

The Get-PAMGroup cmdlet returns one or more groups from the MIM Service.

Examples

EXAMPLE 1

$pg = Get-PAMGroup

Returns all groups in the MIM Service for PAM.

Parameters

-Filter

Specifies a clause to use in a filter for 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

-PrivAccountName

Specifies the account name of the group in the PAM domain.

Parameter properties

Type:String
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

-PrivDisplayName

Specifies the matching value for the DisplayName attribute of a group resource in MIM Service.

Parameter properties

Type:String
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

-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:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourceAccountName

Account name of the group in the source domain.

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

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.PAMGroup

The cmdlet returns one object for each matching group.