Link

TfsCmdlets v2.6.0+2898.5, released 2022-10-01

This site uses Just the Docs, a documentation theme for Jekyll.

Search

Get-TfsGitItem

Gets information from one or more items (folders and/or files) in a remote Git repository.

Table of Contents

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

Syntax

Get by commit SHA 

Get-TfsGitItem
    [-Item <object>]
    [-Collection <object>]
    [-Commit <object>]
    [-IncludeContent]
    [-IncludeMetadata]
    [-Project <object>]
    [-Repository <object>]
    [-Server <object>]

Get by tag 

Get-TfsGitItem
    [-Item <object>]
    -Tag <string>
    [-Collection <object>]
    [-IncludeContent]
    [-IncludeMetadata]
    [-Project <object>]
    [-Repository <object>]
    [-Server <object>]

Get by branch 

Get-TfsGitItem
    [-Item <object>]
    -Branch <string>
    [-Collection <object>]
    [-IncludeContent]
    [-IncludeMetadata]
    [-Project <object>]
    [-Repository <object>]
    [-Server <object>]

[Go to top]

Parameters

-Branch

Type string
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

-Commit

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

-IncludeContent

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

-IncludeMetadata

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

-Item (Aliases: Path)

Specifies the path to items (folders and/or files) in the supplied Git repository. Wildcards are supported. When omitted, all items in the root of the Git repository are retrieved.

Type object
Position 0
Default Value /*
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. 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 False
Accept wildcard characters False

-Repository

Specifies the target Git repository. Valid values are the name of the repository, its ID (a GUID), or a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object obtained by e.g. a call to Get-TfsGitRepository. When omitted, defaults to the team project name (i.e. the default repository).

Type object
Position (Named)
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

-Tag

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

Inputs

System.Object

Specifies the target Git repository. Valid values are the name of the repository, its ID (a GUID), or a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object obtained by e.g. a call to Get-TfsGitRepository. When omitted, defaults to the team project name (i.e. the default repository).

Outputs

Microsoft.TeamFoundation.SourceControl.WebApi.GitItem