Get-TfsGitCommit

Gets information from one or more Git commits in a remote repository.

Table of Contents

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

Syntax

Get by commit SHA

Get-TfsGitCommit
    [-Commit] <object>
    -Repository <object>
    [-Collection <object>]
    [-IncludeWorkItems]
    [-Project <object>]
    [-Server <object>]

Get by tag

Get-TfsGitCommit
    -Repository <object>
    -Tag <string>
    [-Author <string>]
    [-Collection <object>]
    [-Committer <string>]
    [-CompareVersion <GitVersionDescriptor>]
    [-ExcludeDeletes]
    [-FromCommit <string>]
    [-FromDate <DateTime>]
    [-IncludeLinks]
    [-IncludePushData]
    [-IncludeUserImageUrl]
    [-IncludeWorkItems]
    [-ItemPath <string>]
    [-Project <object>]
    [-Server <object>]
    [-ShowOldestCommitsFirst]
    [-Skip <int>]
    [-ToCommit <string>]
    [-ToDate <DateTime>]
    [-Top <int>]

Get by branch

Get-TfsGitCommit
    -Branch <string>
    -Repository <object>
    [-Author <string>]
    [-Collection <object>]
    [-Committer <string>]
    [-CompareVersion <GitVersionDescriptor>]
    [-ExcludeDeletes]
    [-FromCommit <string>]
    [-FromDate <DateTime>]
    [-IncludeLinks]
    [-IncludePushData]
    [-IncludeUserImageUrl]
    [-IncludeWorkItems]
    [-ItemPath <string>]
    [-Project <object>]
    [-Server <object>]
    [-ShowOldestCommitsFirst]
    [-Skip <int>]
    [-ToCommit <string>]
    [-ToDate <DateTime>]
    [-Top <int>]

Search commits

Get-TfsGitCommit
    -Repository <object>
    [-Author <string>]
    [-Collection <object>]
    [-Committer <string>]
    [-CompareVersion <GitVersionDescriptor>]
    [-ExcludeDeletes]
    [-FromCommit <string>]
    [-FromDate <DateTime>]
    [-IncludeLinks]
    [-IncludePushData]
    [-IncludeUserImageUrl]
    [-IncludeWorkItems]
    [-ItemPath <string>]
    [-Project <object>]
    [-Server <object>]
    [-ShowOldestCommitsFirst]
    [-Skip <int>]
    [-ToCommit <string>]
    [-ToDate <DateTime>]
    [-Top <int>]

[Go to top]

Parameters

-Author

Limits the search to commits authored by this user.

-Branch

Specifies the branch name of the commit to return.

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

-Commit

Specifies the hash (SHA) of the commit to return.

-Committer

Limits the search to commits committed by this user.

-CompareVersion

-ExcludeDeletes

Prevents deleted items from being included in the results.

-FromCommit

Specifies the “commit-ish” to start the search from.

-FromDate

Specifies the date and time of the commit to start the search from.

-IncludeLinks

Includes links to related resources in the results.

-IncludePushData

Includes push data in the results.

-IncludeUserImageUrl

Includes the user’s image URL in the results.

-IncludeWorkItems

Includes links to related work items in the results.

-ItemPath

Limits the search to commits that affect this path.

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

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

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

-ShowOldestCommitsFirst

Sorts the results from oldest to newest commit.

-Skip

-Tag

Specifies the tag name of the commit to return.

-ToCommit

Specifies the “commit-ish” to end the search at.

-ToDate

Specifies the date and time of the commit to end the search at.

-Top

Specifies the maximum number of commits to return.

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

Related Links