Get-PnPMicrosoft365Group
SYNOPSIS
Required Permissions
- Microsoft Graph API : One of Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadWrite.All
Gets one Microsoft 365 Group or a list of Microsoft 365 Groups
SYNTAX
Get-PnPMicrosoft365Group [-Identity <Microsoft365GroupPipeBind>] [-IncludeSiteUrl] [-IncludeOwners] [-Filter <string>]
DESCRIPTION
Allows to retrieve Microsoft 365 Groups. By using Identity option you may specify the exact group that will be retrieved.
EXAMPLES
EXAMPLE 1
Get-PnPMicrosoft365Group
Retrieves all the Microsoft 365 Groups
EXAMPLE 2
Get-PnPMicrosoft365Group -Identity $groupId
Retrieves a specific Microsoft 365 Group based on its ID
EXAMPLE 3
Get-PnPMicrosoft365Group -Identity $groupDisplayName
Retrieves a specific or list of Microsoft 365 Groups that start with the given DisplayName
EXAMPLE 4
Get-PnPMicrosoft365Group -Identity $groupSiteMailNickName
Retrieves a specific or list of Microsoft 365 Groups for which the email starts with the provided mail nickName
EXAMPLE 5
Get-PnPMicrosoft365Group -Identity $group
Retrieves a specific Microsoft 365 Group based on its object instance
EXAMPLE 6
Get-PnPMicrosoft365Group -IncludeSiteUrl
Retrieves all Microsoft 365 Groups in this tenant and includes the URL property for the underlying SharePoint site.
EXAMPLE 7
$groups = Get-PnPMicrosoft365Group -IncludeOwners
$g[0].Owners
Retrieves all Microsoft 365 Groups in this tenant and retrieves the owners for each group. The owners are available in the "Owners" property of the returned objects.
EXAMPLE 8
$groups = Get-PnPMicrosoft365Group -Filter "startswith(description, 'contoso')"
Retrieves all Microsoft 365 Groups in this tenant with description starting with Contoso. This example demonstrates using Advanced Query capabilities (see: https://learn.microsoft.com/en-us/graph/aad-advanced-queries?tabs=http#group-properties).
PARAMETERS
-IncludeSiteUrl
Include fetching the site URL for Microsoft 365 Groups. This slows down large listings.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeOwners
Include fetching the group owners. This slows down large listings.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
The Identity of the Microsoft 365 Group
Type: Microsoft365GroupPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Filter
Specify the query to pass to Graph API in $filter.
Type: String
Parameter Sets: Filter
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False