Get-TfsTeam

Gets information about one or more teams.

Table of Contents

1. Syntax
2. Parameters
3. Inputs
4. Outputs
5. Related Links

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>]
    [-IncludeMembers]
    [-IncludeSettings]
    [-Project <object>]
    [-Server <object>]

User name and password

Get-TfsTeam
    [-Team <object>]
    -Password <SecureString>
    -UserName <string>
    [-Collection <object>]
    [-IncludeMembers]
    [-IncludeSettings]
    [-Project <object>]
    [-Server <object>]

Credential object

Get-TfsTeam
    [-Team <object>]
    -Credential <object>
    [-Collection <object>]
    [-IncludeMembers]
    [-IncludeSettings]
    [-Project <object>]
    [-Server <object>]

Personal Access Token

Get-TfsTeam
    [-Team <object>]
    -PersonalAccessToken <string>
    [-Collection <object>]
    [-IncludeMembers]
    [-IncludeSettings]
    [-Project <object>]
    [-Server <object>]

Prompt for credential

Get-TfsTeam
    [-Team <object>]
    [-Collection <object>]
    [-IncludeMembers]
    [-IncludeSettings]
    [-Interactive]
    [-Project <object>]
    [-Server <object>]

Get default team

Get-TfsTeam
    -Default
    [-Collection <object>]
    [-IncludeMembers]
    [-IncludeSettings]
    [-Project <object>]
    [-Server <object>]

Get current

Get-TfsTeam
    -Current

Azure Login

Get-TfsTeam
    [-AzureLogin]
    [-Collection <object>]
    [-Project <object>]
    [-Server <object>]

[Go to top]

Parameters

-AzureLogin

Uses Azure Login credentials (DefaultAzureCredential) to authenticate to Azure DevOps. This inherits the current Azure authentication context (e.g. Azure CLI, Managed Identity, Visual Studio, Environment Variables) and obtains an Azure DevOps access token automatically. Tokens are short-lived and are automatically renewed when they expire. Ideal for CI/CD pipelines, managed identities, and scenarios where the user is already authenticated to Azure.

-Cached

Specifies that cached (default) credentials should be used when possible/available.

-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).

-Credential

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.

-Current

Returns the team specified in the last call to Connect-TfsTeam (i.e. the “current” team)

-Default

Returns the default team in the given team project.

-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.

-IncludeSettings

Gets team settings (fills the Settings, TeamField, and IterationPaths properties).

-Interactive

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.

-Password

Specifies a password for authentication modes (such as Basic) that support username/password-based credentials. Must be used in conjunction with the -UserName argument

-PersonalAccessToken (Aliases: Pat)

Specifies a personal access token, used as an alternate credential, to authenticate to Azure DevOps

-Project

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.

-Server

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.

-Team (Aliases: Name)

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.

-UserName

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

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.

Outputs

TfsCmdlets.Models.Team

Related Links