Get-MgTeam
Retrieve the properties and relationships of the specified team.
Note
To view the beta release of this cmdlet, view Get-MgBetaTeam
Syntax
Get-MgTeam
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-Filter <String>]
[-Search <String>]
[-Skip <Int32>]
[-Sort <String[]>]
[-Top <Int32>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PageSize <Int32>]
[-All]
[-CountVariable <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-MgTeam
-TeamId <String>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-MgTeam
-InputObject <ITeamsIdentity>
[-ExpandProperty <String[]>]
[-Property <String[]>]
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Description
Retrieve the properties and relationships of the specified team.
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Team.ReadBasic.All | TeamSettings.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, TeamSettings.Read.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | TeamSettings.Read.Group | TeamSettings.ReadWrite.Group, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All |
Permissions
| Permission type | Least privileged permissions | Higher privileged permissions |
|---|---|---|
| Delegated (work or school account) | Team.ReadBasic.All | TeamSettings.Read.All, TeamSettings.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. | Not supported. |
| Application | Team.ReadBasic.All | TeamSettings.Read.All, TeamSettings.ReadWrite.All |
Examples
Example 1: Get a list of teams
Import-Module Microsoft.Graph.Teams
Get-MgTeamThis example will get a list of teams
Example 2: Use $filter and $top to get two teams with a display name that starts with 'A'
Import-Module Microsoft.Graph.Teams
Get-MgTeam -Filter "startswith(displayName, 'A')" -Top 2This example will use $filter and $top to get two teams with a display name that starts with 'a'
Example 3: Use $filter and $select to get id and description for team with displayName equals "A Contoso Team"
Import-Module Microsoft.Graph.Teams
Get-MgTeam -Filter "displayName eq 'A Contoso Team'" -Property "id,description"This example will use $filter and $select to get id and description for team with displayname equals "a contoso team"
Parameters
-All
List all pages.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CountVariable
Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.
| Type: | String |
| Aliases: | CV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExpandProperty
Expand related entities
| Type: | String[] |
| Aliases: | Expand |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Filter items by property values
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | ITeamsIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PageSize
Sets the page size of results.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Property
Select properties to be returned
| Type: | String[] |
| Aliases: | Select |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Search
Search items by search phrases
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skip the first n items
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Sort
Order items by property values
| Type: | String[] |
| Aliases: | OrderBy |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TeamId
The unique identifier of team
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Top
Show only the first n items
| Type: | Int32 |
| Aliases: | Limit |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.ITeamsIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTeam
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <ITeamsIdentity>: Identity Parameter
[AssociatedTeamInfoId <String>]: The unique identifier of associatedTeamInfo[ChannelId <String>]: The unique identifier of channel[ChatId <String>]: The unique identifier of chat[ChatMessageHostedContentId <String>]: The unique identifier of chatMessageHostedContent[ChatMessageId <String>]: The unique identifier of chatMessage[ChatMessageId1 <String>]: The unique identifier of chatMessage[ConversationMemberId <String>]: The unique identifier of conversationMember[DeletedChatId <String>]: The unique identifier of deletedChat[DeletedTeamId <String>]: The unique identifier of deletedTeam[GroupId <String>]: The unique identifier of group[OfferShiftRequestId <String>]: The unique identifier of offerShiftRequest[OpenShiftChangeRequestId <String>]: The unique identifier of openShiftChangeRequest[OpenShiftId <String>]: The unique identifier of openShift[PinnedChatMessageInfoId <String>]: The unique identifier of pinnedChatMessageInfo[ResourceSpecificPermissionGrantId <String>]: The unique identifier of resourceSpecificPermissionGrant[SchedulingGroupId <String>]: The unique identifier of schedulingGroup[SharedWithChannelTeamInfoId <String>]: The unique identifier of sharedWithChannelTeamInfo[ShiftId <String>]: The unique identifier of shift[SwapShiftsChangeRequestId <String>]: The unique identifier of swapShiftsChangeRequest[TeamId <String>]: The unique identifier of team[TeamsAppDefinitionId <String>]: The unique identifier of teamsAppDefinition[TeamsAppId <String>]: The unique identifier of teamsApp[TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation[TeamsAsyncOperationId <String>]: The unique identifier of teamsAsyncOperation[TeamsTabId <String>]: The unique identifier of teamsTab[TeamworkTagId <String>]: The unique identifier of teamworkTag[TeamworkTagMemberId <String>]: The unique identifier of teamworkTagMember[TimeOffId <String>]: The unique identifier of timeOff[TimeOffReasonId <String>]: The unique identifier of timeOffReason[TimeOffRequestId <String>]: The unique identifier of timeOffRequest[UserId <String>]: The unique identifier of user[UserScopeTeamsAppInstallationId <String>]: The unique identifier of userScopeTeamsAppInstallation[WorkforceIntegrationId <String>]: The unique identifier of workforceIntegration