Show / Hide Table of Contents

    Get-PnPGroupMembers

    SYNOPSIS

    Retrieves all members of a group

    SYNTAX

    Get-PnPGroupMembers -Identity <GroupPipeBind> [-Web <WebPipeBind>] [-Connection <PnPConnection>]
     [<CommonParameters>]
    

    DESCRIPTION

    This command will return all the users that are a member of the provided SharePoint Group

    EXAMPLES

    EXAMPLE 1

    Get-PnPGroupMembers -Identity 'Marketing Site Members'
    

    Returns all the users that are a member of the group 'Marketing Site Members' in the current sitecollection

    EXAMPLE 2

    Get-PnPGroup | Get-PnPGroupMembers
    

    Returns all the users that are a member of any of the groups in the current sitecollection

    EXAMPLE 3

    Get-PnPGroup | ? Title -Like 'Marketing*' | Get-PnPGroupMembers
    

    Returns all the users that are a member of any of the groups of which their name starts with the word 'Marketing' in the current sitecollection

    PARAMETERS

    -Connection

    Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

    Type: PnPConnection
    Parameter Sets: (All)
    Aliases:
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Identity

    A group object, an ID or a name of a group

    Type: GroupPipeBind
    Parameter Sets: (All)
    Aliases:
    
    Required: True
    Position: Named
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    -Web

    This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

    Type: WebPipeBind
    Parameter Sets: (All)
    Aliases:
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    RELATED LINKS

    SharePoint Developer Patterns and Practices

    Back to top Generated by DocFX spacer