Show / Hide Table of Contents

    Get-PnPGroup

    SYNOPSIS

    Returns a specific SharePoint group or all SharePoint groups in the current site

    SYNTAX

    All (Default)

    Get-PnPGroup [-Connection <PnPConnection>] [-Includes <String[]>] [<CommonParameters>]
    

    ByName

    Get-PnPGroup [[-Identity] <GroupPipeBind>] [-Connection <PnPConnection>]
     [-Includes <String[]>] [<CommonParameters>]
    

    Members

    Get-PnPGroup [-AssociatedMemberGroup] [-Connection <PnPConnection>] [-Includes <String[]>]
     [<CommonParameters>]
    

    Visitors

    Get-PnPGroup [-AssociatedVisitorGroup] [-Connection <PnPConnection>]
     [-Includes <String[]>] [<CommonParameters>]
    

    Owners

    Get-PnPGroup [-AssociatedOwnerGroup] [-Connection <PnPConnection>] [-Includes <String[]>]
     [<CommonParameters>]
    

    DESCRIPTION

    EXAMPLES

    EXAMPLE 1

    Get-PnPGroup
    

    Returns all SharePoint groups in the current site

    EXAMPLE 2

    Get-PnPGroup -Identity 'My Site Users'
    

    This will return the group called 'My Site Users' if available in the current site. The name is case sensitive, so a group called 'My site users' would not be found.

    EXAMPLE 3

    Get-PnPGroup -AssociatedMemberGroup
    

    This will return the current members group for the site

    PARAMETERS

    -AssociatedMemberGroup

    Retrieve the associated member group

    Type: SwitchParameter
    Parameter Sets: Members
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -AssociatedOwnerGroup

    Retrieve the associated owner group

    Type: SwitchParameter
    Parameter Sets: Owners
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -AssociatedVisitorGroup

    Retrieve the associated visitor group

    Type: SwitchParameter
    Parameter Sets: Visitors
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -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)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Identity

    Get a specific group by its name or id. The name case sensitive.

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

    RELATED LINKS

    Microsoft 365 Patterns and Practices

    Back to top Generated by DocFX spacer