Skip to main content

Get-VSTeamJobRequest

SYNOPSIS

Returns all the job requests of an agent.

SYNTAX

Get-VSTeamJobRequest -PoolId <Int32> -AgentID <Int32> [-completedRequestCount <Int32>] [<CommonParameters>]

DESCRIPTION

Returns all the job requests of an agent.

EXAMPLES

Example 1

Get-VSTeamJobRequest 1 111

This will display all the job request of agent with id 111 under the pool with id 1.

PARAMETERS

-PoolId

Id of the pool.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-AgentID

Id of the agent to return.

Type: Int32
Parameter Sets: (All)
Aliases: ID

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

-completedRequestCount

The number of requests to return.

Type: Int32
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

System.String

OUTPUTS

System.Object

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