Skip to main content

Get-VSTeamAPIVersion

SYNOPSIS

Returns the versions of APIs used.

SYNTAX

Get-VSTeamAPIVersion [-Service <String>] [<CommonParameters>]

DESCRIPTION

Returns the versions of APIs used.

EXAMPLES

Example 1

Get-VSTeamAPIVersion

This command gets the API versions currently in use.

Example 2

Get-VSTeamAPIVersion -Service Release

This command gets the version of the Release API currently in use.

PARAMETERS

-Service

Specifies the service to change. The acceptable values for this parameter are:

  • Build
  • Release
  • Core
  • Git
  • DistributedTask
  • Tfvc
  • Packaging
  • MemberEntitlementManagement
  • ExtensionsManagement
  • ServiceEndpoints
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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