Get-TfsTeam
Gets information about one or more teams.
Table of Contents
Syntax
Get by team
Get-TfsTeam
[-Team <object>]
[-Collection <object>]
[-IncludeMembers]
[-IncludeSettings]
[-Project <object>]
[-Server <object>]
Cached credentials
Get-TfsTeam
[-Team <object>]
-Cached
[-Collection <object>]
[-Default]
[-IncludeMembers]
[-IncludeSettings]
[-Project <object>]
[-Server <object>]
User name and password
Get-TfsTeam
[-Team <object>]
-Password <SecureString>
-UserName <string>
[-Collection <object>]
[-Default]
[-IncludeMembers]
[-IncludeSettings]
[-Project <object>]
[-Server <object>]
Credential object
Get-TfsTeam
[-Team <object>]
-Credential <object>
[-Collection <object>]
[-Default]
[-IncludeMembers]
[-IncludeSettings]
[-Project <object>]
[-Server <object>]
Personal Access Token
Get-TfsTeam
[-Team <object>]
-PersonalAccessToken <string>
[-Collection <object>]
[-Default]
[-IncludeMembers]
[-IncludeSettings]
[-Project <object>]
[-Server <object>]
Prompt for credential
Get-TfsTeam
[-Team <object>]
[-Collection <object>]
[-Default]
[-IncludeMembers]
[-IncludeSettings]
[-Interactive]
[-Project <object>]
[-Server <object>]
Get current
Get-TfsTeam
-Current
[-IncludeMembers]
[-IncludeSettings]
Get default team
Get-TfsTeam
-Default
[-IncludeMembers]
[-IncludeSettings]
Parameters
Specifies that cached (default) credentials should be used when possible/available.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-Collection (Aliases: Organization)
Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies a user account that has permission to perform this action. To provide a user name and password, a Personal Access Token, and/or to open a input dialog to enter your credentials, call Get-TfsCredential with the appropriate arguments and pass its return to this argument.
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Returns the team specified in the last call to Connect-TfsTeam (i.e. the “current” team)
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Returns the default team in the given team project.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-IncludeMembers (Aliases: QueryMembership)
Get team members (fills the Members property with a list of Microsoft.VisualStudio.Services.WebApi.TeamMember objects). When omitted, only basic team information (such as name, description and ID) are returned.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Gets team settings (fills the Settings, TeamField, and IterationPaths properties).
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Prompts for user credentials. Can be used for any Team Foundation Server or Azure DevOps account - the proper login dialog is automatically selected. Should only be used in an interactive PowerShell session (i.e., a PowerShell terminal window), never in an unattended script (such as those executed during an automated build). Currently it is only supported in Windows PowerShell.
| Type | SwitchParameter |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument
| Type | SecureString |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-PersonalAccessToken (Aliases: Pat)
Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps
| Type | string |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeamProject (if any). For more details, see the Get-TfsTeamProject cmdlet.
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | True (byvalue) |
| Accept wildcard characters | False |
Specifies the URL to the Team Foundation Server to connect to, a TfsConfigurationServer object (Windows PowerShell only), or a VssConnection object. When omitted, it defaults to the connection set by Connect-TfsConfiguration (if any). For more details, see the Get-TfsConfigurationServer cmdlet.
| Type | object |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies the team to return. Accepted values are its name, its ID, or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object. Wildcards are supported. When omitted, all teams in the given team project are returned.
| Type | object |
| Position | 0 |
| Default Value | * |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Specifies a user name for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -Password argument
| Type | string |
| Position | (Named) |
| Default Value | (N/A) |
| Accept pipeline input | False |
| Accept wildcard characters | False |
Inputs
System.Object
Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. When omitted, it defaults to the connection set by Connect-TfsTeamProject (if any). For more details, see the Get-TfsTeamProject cmdlet.