Get-PnPTeamsTeam
SYNOPSIS
Required Permissions
- Microsoft Graph API : One of Group.Read.All, Group.ReadWrite.All
Gets one Microsoft Teams Team or a list of Teams.
SYNTAX
Get-PnPTeamsTeam [-Identity <TeamsTeamPipeBind>] [-Filter <String>] [-User <EntraIDUserPipeBind>]
DESCRIPTION
Allows to retrieve list of Microsoft Teams teams. By using Identity it is possible to retrieve a specific team, and by using Filter you can supply any filter queries supported by the Graph API.
EXAMPLES
EXAMPLE 1
Get-PnPTeamsTeam
Retrieves all the Microsoft Teams instances
EXAMPLE 2
Get-PnPTeamsTeam -Identity "PnP PowerShell"
Retrieves a specific Microsoft Teams instance using display name.
EXAMPLE 3
Get-PnPTeamsTeam -Identity "baba9192-55be-488a-9fb7-2e2e76edbef2"
Retrieves a specific Microsoft Teams instance using group id.
EXAMPLE 4
Get-PnPTeamsTeam -Filter "startswith(mailNickName, 'contoso')"
Retrieves all Microsoft Teams instances with MailNickName starting with "contoso".
EXAMPLE 5
Get-PnPTeamsTeam -Filter "startswith(description, 'contoso')"
Retrieves all Microsoft Teams instances 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).
EXAMPLE 6
Get-PnPTeamsTeam -User "user@company.com"
Retrieves all Microsoft Teams instances which the specified user has access to.
PARAMETERS
-Identity
Specify the group id, mailNickname or display name of the team to use.
Type: TeamsTeamPipeBind
Parameter Sets: Identity
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
-User
Specify the name of the user to fetch the list of teams user as access to.
Type: EntraIDUserPipeBind
Parameter Sets: User
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False