Get-VSTeamWorkItemTag
SYNOPSIS
Gets a work item tag
SYNTAX
Get-VSTeamWorkItemTag [-TagIdOrName <String>] -ProjectName <String> [<CommonParameters>]
DESCRIPTION
Returns a list of work item tags in a project.
A single tag can be returned by providing the tag name or id.
EXAMPLES
Example 1
Get-VSTeamWorkItemTag
This will return a list of all the work item tags within the current project
Example 2
Get-VSTeamWorkItemTag -TagId my-tag
This will return a specific work item tag
Example 3
Get-VSTeamWorkItemTag -TagName my-tag
This will return a specific work item tag
PARAMETERS
-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: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TagIdOrName
Name or ID of the tag to return
Type: String
Parameter Sets: (All)
Aliases: TagId, TagName
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