Skip to main content

Get-VSTeamGitStat

SYNOPSIS​

Retrieves statistics about branches within a repository.

SYNTAX​

ByOptionalName (Default)​

Get-VSTeamGitStat -RepositoryId <Guid> [-BranchName <String>] [-ProjectName <String>] [<CommonParameters>]

ByVersion​

Get-VSTeamGitStat -RepositoryId <Guid> [-BranchName <String>] [-VersionOptions <String>] -Version <String>
 -VersionType <String> [-ProjectName <String>] [<CommonParameters>]

DESCRIPTION​

Retrieves statistics about branches within a repository.

EXAMPLES​

Example 1​

Get-VSTeamGitStat -ProjectName Demo -RepositoryId 011E421A-2A54-4491-B370-9256AD8A1BDD

This command returns all the Git stats for the entire repository

Example 2​

Get-VSTeamGitStat -ProjectName Demo -RepositoryId 011E421A-2A54-4491-B370-9256AD8A1BDD -BranchName develop

This command returns all the Git stats for a specific branch

Example 3​

Get-VSTeamGitStat -ProjectName Demo -RepositoryId 011E421A-2A54-4491-B370-9256AD8A1BDD -BranchName develop -VersionType branch -Version 67cae2b029dff7eb3dc062b49403aaedca5bad8d

This command returns all the Git stats for a specific commit

PARAMETERS​

-RepositoryId​

Specifies the ID of the repository.

Type: Guid
Parameter Sets: (All)
Aliases: Id

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-BranchName​

Name of the branch.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VersionOptions​

Version options - Specify additional modifiers to version (e.g Previous). Valid options for this parameter are:

  • firstParent
  • none
  • previousChange
Type: String
Parameter Sets: ByVersion
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Version​

Version string identifier (name of tag/branch, SHA1 of commit)

Type: String
Parameter Sets: ByVersion
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VersionType​

Version type (branch, tag, or commit). Determines how Id is interpreted. Valid options for this parameter are:

  • branch
  • commit
  • tag
Type: String
Parameter Sets: ByVersion
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProjectName​

Specifies the team project for which this function operates.

You can tab complete from a list of available projects.

You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version