Get-PnPUnifiedGroup

Gets one Office 365 Group (aka Unified Group) or a list of Office 365 Groups. Requires the Azure Active Directory application permission 'Group.Read.All'.

Syntax

Get-PnPUnifiedGroup
   [-Identity <UnifiedGroupPipeBind>]
                      [-ExcludeSiteUrl [<SwitchParameter>]]
                      [-IncludeClassification [<SwitchParameter>]]
                      [-IncludeHasTeam [<SwitchParameter>]]

Examples

------------------EXAMPLE 1------------------

Get-PnPUnifiedGroup

Retrieves all the Office 365 Groups

------------------EXAMPLE 2------------------

Get-PnPUnifiedGroup -Identity $groupId

Retrieves a specific Office 365 Group based on its ID

------------------EXAMPLE 3------------------

Get-PnPUnifiedGroup -Identity $groupDisplayName

Retrieves a specific or list of Office 365 Groups that start with the given DisplayName

------------------EXAMPLE 4------------------

Get-PnPUnifiedGroup -Identity $groupSiteMailNickName

Retrieves a specific or list of Office 365 Groups for which the email starts with the provided mail nickName

------------------EXAMPLE 5------------------

Get-PnPUnifiedGroup -Identity $group

Retrieves a specific Office 365 Group based on its object instance

------------------EXAMPLE 6------------------

Get-PnPUnifiedGroup -IncludeIfHasTeam

Retrieves all the Office 365 Groups and checks for each of them if it has a Microsoft Team provisioned for it

Parameters

-ExcludeSiteUrl

Exclude fetching the site URL for Office 365 Groups. This speeds up large listings.

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Identity

The Identity of the Office 365 Group.

Type:UnifiedGroupPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-IncludeClassification

Include Classification value of Office 365 Groups.

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-IncludeHasTeam

Include a flag for every Office 365 Group if it has a Microsoft Team provisioned for it. This will slow down the retrieval of Office 365 Groups so only use it if you need it.

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False