Skip to main content

Set-VSTeamAPIVersion

SYNOPSIS​

Sets the API versions to support either TFS2017, TFS2018, AzD2019 or AzD.

SYNTAX​

Target (Default)​

Set-VSTeamAPIVersion [[-Target] <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

Service​

Set-VSTeamAPIVersion -Service <String> -Version <String> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Set-VSTeamAPIVersion sets the versions of APIs used.

EXAMPLES​

Example 1​

Set-VSTeamAPIVersion AzD

This command sets the API versions to support AzD.

Example 2​

Set-VSTeamAPIVersion -Service Release -Version '5.0'

This command sets the version of the Release calls to 5.0.

PARAMETERS​

-Target​

Specifies the version to use. The acceptable values for this parameter are:

  • TFS2017
  • TFS2017U1
  • TFS2017U2
  • TFS2017U3
  • TFS2018
  • TFS2018U1
  • TFS2018U2
  • TFS2018U3
  • AzD2019
  • AzD2019U1
  • VSTS
  • AzD
Type: String
Parameter Sets: Target
Aliases:

Required: False
Position: 0
Default value: TFS2017
Accept pipeline input: False
Accept wildcard characters: False

-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: Service
Aliases:

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

-Version​

Specifies the version to use.

Type: String
Parameter Sets: Service
Aliases:

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

-Force​

Forces the function without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WhatIf​

Shows what would happen if the function runs. The function is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm​

Prompts you for confirmation before running the function.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
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

Set-VSTeamAPIVersion

Set-VSTeamDefaultProject

Set-VSTeamDefaultAPITimeout

about_vsteam

about_vsteam_profiles

about_vsteam_provider