Link

Connect-TfsTeamProject

Connects to a Team Project.


Table of Contents

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

Syntax

Prompt for credential

Connect-TfsTeamProject
    [-Project] <object>
    [-Collection <object>]
    [-Interactive]
    [-Passthru]
    [-Server <object>]

Cached credentials

Connect-TfsTeamProject
    [-Project] <object>
    -Cached
    [-Collection <object>]
    [-Passthru]
    [-Server <object>]

User name and password

Connect-TfsTeamProject
    [-Project] <object>
    [-UserName] <string>
    [-Password <SecureString>]
    [-Collection <object>]
    [-Passthru]
    [-Server <object>]

Credential object

Connect-TfsTeamProject
    [-Project] <object>
    -Credential <object>
    [-Collection <object>]
    [-Passthru]
    [-Server <object>]

Personal Access Token

Connect-TfsTeamProject
    [-Project] <object>
    -PersonalAccessToken <string>
    [-Collection <object>]
    [-Passthru]
    [-Server <object>]

[Go to top]

Parameters

-Cached

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

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

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

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

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

Type SwitchParameter
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-Passthru

Returns the results of the command. By default, this cmdlet does not generate any output.

Type SwitchParameter
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-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

Type SecureString
Position 2
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

-Project

Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to.

Type object
Position 0
Default Value (N/A)
Accept pipeline input True (byvalue)
Accept wildcard characters False

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

Type object
Position (Named)
Default Value (N/A)
Accept pipeline input False
Accept wildcard characters False

-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

Type string
Position 1
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.

Outputs

Microsoft.TeamFoundation.Core.WebApi.TeamProject