TeamFoundationBuildService.QueueBuilds Method

Queues builds using the requests and specified options. If any requests fail for any reason, the whole method fails and no requests are queued.

Namespace:  Microsoft.TeamFoundation.Build.Server
Assembly:  Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)

Syntax

'Declaration
Public Function QueueBuilds ( _
    requestContext As TeamFoundationRequestContext, _
    requests As IList(Of BuildRequest), _
    options As QueueOptions _
) As BuildQueueQueryResult
public BuildQueueQueryResult QueueBuilds(
    TeamFoundationRequestContext requestContext,
    IList<BuildRequest> requests,
    QueueOptions options
)
public:
BuildQueueQueryResult^ QueueBuilds(
    TeamFoundationRequestContext^ requestContext, 
    IList<BuildRequest^>^ requests, 
    QueueOptions options
)
member QueueBuilds : 
        requestContext:TeamFoundationRequestContext * 
        requests:IList<BuildRequest> * 
        options:QueueOptions -> BuildQueueQueryResult
public function QueueBuilds(
    requestContext : TeamFoundationRequestContext, 
    requests : IList<BuildRequest>, 
    options : QueueOptions
) : BuildQueueQueryResult

Parameters

Return Value

Type: Microsoft.TeamFoundation.Build.Server.BuildQueueQueryResult
The list of requests successfully put in the queue.

.NET Framework Security

  • [M:F:Microsoft.TeamFoundation.Build.Common.BuildPermissions.ViewBuildDefinition] 

    The caller must have ViewBuildDefinition permission for the target build definition(s).

  • [M:F:Microsoft.TeamFoundation.Build.Common.BuildPermissions.QueueBuilds] 

    The caller must have QueueBuilds permission for the target build definition(s). This permission is not required for a request with a valid CheckInTicketcheck-in ticket.

  • [M:F:Microsoft.TeamFoundation.Build.Common.BuildPermissions.ViewBuildDefinition] 

    The caller must have [ViewBuildDefinition] permission for the target build definition(s).

  • [M:F:Microsoft.TeamFoundation.Build.Common.BuildPermissions.QueueBuilds] 

    The caller must have [QueueBuilds] permission for the target build definition(s). This permission is not required for a request with a valid CheckInTicketcheck-in ticket.

  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

TeamFoundationBuildService Class

Microsoft.TeamFoundation.Build.Server Namespace