Skip to main content

Get-VSTeamOption

SYNOPSIS​

Returns all the versions of supported APIs of your TFS or AzD.

SYNTAX​

Get-VSTeamOption [-subDomain <String>] [-area <String>] [-resource <String>] [<CommonParameters>]

DESCRIPTION​

Returns all the versions of supported APIs of your TFS or AzD.

There are two table formats defined for the vsteam_lib.Option type, Default and Versions.

Default view contains Name, Area, Max Version and URI Template.

Version view contains Name, Area, Min Version, Max Version, Released Version and Resource Version.

EXAMPLES​

Example 1​

Get-VSTeamOption

This will display all the versions of supported APIs for your account using the 'Default' table format.

Example 2​

Get-VSTeamOption | Format-Table -View Versions

This will display all the versions of supported APIs for your account using the 'Versions' custom table format.

Example 3​

Get-VSTeamOption -SubDomain vsrm

This will display all the versions of supported APIs for the release management service.

Example 4​

Get-VSTeamOption -Area core

This will display all the versions of supported APIs for the area core.

Example 5​

Get-VSTeamOption -Area core -Resource teams

This will display all the versions of supported APIs for resources teams under the area core.

PARAMETERS​

-area​

Returns options for that area's APIs.

Type: String
Parameter Sets: (All)
Aliases: Service

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

-resource​

Returns options for that resource's APIs.

Type: String
Parameter Sets: (All)
Aliases:

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

-subDomain​

Returns options for that sub domain APIs. Some examples include:

  • vsaex = Member Entitlement Management
  • feeds = Artifacts
  • vsrm = Release Management
  • vssps = Graph
  • extmgmt = Extensions
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