Skip to main content

Get-VSTeamMember

SYNOPSIS​

Returns a team member.

SYNTAX​

Get-VSTeamMember [-Top <Int32>] [-Skip <Int32>] [-TeamId] <String> -ProjectName <String> [<CommonParameters>]

DESCRIPTION​

Returns a team member.

EXAMPLES​

Example 1​

Get-VSTeamMember -TeamId 'DevOpsTeam'

Returns all members of the team with the id "DevOpsTeam".

Example 2​

Get-VSTeamMember -TeamId 'DevOpsTeam' -Top 10

Returns the top 10 members of the team with the id "DevOpsTeam".

Example 3​

Get-VSTeamMember -TeamId 'DevOpsTeam' -Skip 5 -Top 10

Skips the first 5 members and then returns the next 10 members of the team with the id "DevOpsTeam".

Example 4​

Get-VSTeamMember -TeamId 'DevOpsTeam' | Where-Object { $_.DisplayName -like "*Smith*" }

Returns members of the team with the id "DevOpsTeam" whose display name contains "Smith".

Example 5​

Get-VSTeamMember -TeamId 'DevOpsTeam' -ProjectName 'ProjectX'

Returns members of the team with the id "DevOpsTeam" that are part of 'ProjectX'.

PARAMETERS​

-Skip​

The number of items to skip.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TeamId​

The id of the team to search.

Type: String
Parameter Sets: (All)
Aliases: Id, Name

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Top​

Specifies the maximum number to return.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProjectName​

Specifies the team project for which this function operates.

You can tab complete from a list of available projects.

You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

vsteam_lib.TeamMember​

NOTES​

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version